POST
/
jobs
curl -X POST "https://api.ionq.co/v0.3/jobs" \
  -H "Authorization: apiKey your-api-key" \
  -H "Content-Type: application/json" \
  -d '{ "input": { "format": "ionq.circuit.v0", "qubits": 1, "circuit": [ {"gate": "h", "target": 0} ] } }'

{
  "id": "aa54e783-0a9b-4f73-ad2f-63983b6aa4a8",
  "status": "ready"
}

Authorizations

​
Authorization
string
header
required

API keys are associated with a user and can be created on the IonQ Quantum Cloud application. To authenticate, prefix your API Key with apiKey and place it in the Authorization request header. Ex: Authorization: apiKey your-api-key

Body

application/json

A job to be created

​
name
string

A job name.

Example:

"My Awesome Job"

​
metadata
object

User defined metadata.

Example:
{
  "custom_key": "a string, maximum 400 chars"
}
​
shots
number
default:100

How many times to execute your circuit when submitting to a QPU or a "non-ideal" noisy simulator.

​
target
enum<string>
default:simulator

Target hardware for job to run on.

Available options:
qpu.harmony,
qpu.aria-1,
qpu.aria-2,
qpu.forte-1,
qpu.forte-enterprise-1,
simulator
​
noise
object

When the target is "simulator", this field specifies optional noise parameters for simulation. (If these noise parameters are not provided, simulations will run on an ideal quantum computer model, without noise.) This field does not apply to qpu.* targets. When a noise model is applied, the simulator qubit limit is inherited from the modeled QPU's qubit limit. (This limit does not apply to the ideal quantum computer simulator. Please refer to the current qubit limit of the ideal quantum computer simulator.)

​
input
object

Input for creating a job via a Quantum Program

​
error_mitigation
object

Which error mitigation methods to apply to this circuit. This may affect how the job is compiled, and what configuration can be used to fetch results.

Response

200 - application/json
Successfully created a Job

Response body from a successful job creation.

​
id
string
required

The UUID of a job. We'll provide the UUID initially in our response to a job creation request.

Example:

"aa54e783-0a9b-4f73-ad2f-63983b6aa4a8"

​
status
enum<string>
required

Status of a job (always ready).

Available options:
ready

Was this page helpful?