POST
/
jobs
curl -X POST "https://api.ionq.co/v0.2/jobs" \
  -H "Authorization: apiKey your-api-key" \
  -H "Content-Type: application/json" \
  -d '{ "body": { "qubits": 1, "circuit": [ {"gate": "h", "target": 0} ] } }'
{
  "id": "aa54e783-0a9b-4f73-ad2f-63983b6aa4a8",
  "status": "ready"
}

Authorizations

Authorization
string
headerrequired

We provide API keys to govern access—we'll provision your account with one key, and more can be provided upon request.

Every key is fully privileged within the system, and should be kept private.

To authenticate, prefix your API Key with apiKey and place it in the Authorization request header. For example: Authorization: apiKey your-api-key

Body

application/json
  • Option 1

  • Option 2

name
string

A job name.

metadata
object

User defined metadata.

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,
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.

lang
enum<string>
required

The language this job is written in: json, qasm, openqasm, quipper`, etc. Defaults to json.

Available options:
json,
openqasm,
qasm,
quipper
body
object
required

Quantum circuits for simulation or execution may be submitted as plain JSON using a simple schema.

Response

200 - application/json
id
string
required

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

status
enum<string>
required

Status of a job (always ready).

Available options:
ready