Get Jobs

GET

jobs

curl "https://api.ionq.co/v0.3/jobs" \
  -H "Authorization: apiKey your-api-key"

Authorizations

Authorization

string

headerrequired

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

Query Parameters

string[]

If provided, will only return jobs whose UUID matches the list provided.

status

enum<string>

If provided, will only return jobs whose status matches the one provided.

Available options:

submitted,

ready,

running,

canceled,

completed,

failed

limit

integer

default: 25

How many objects to return.

Required range: 1 < x < 25

string

ID of next batch of resources to load.

Response

200 - application/json

Response body when requesting all or many jobs.

jobs

object[]

A list of jobs.

jobs.id

string

required

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

jobs.name

string

A job name.

jobs.status

enum<string>

required

Status of a job.

Available options:

submitted,

ready,

running,

canceled,

completed,

failed

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

simulator

jobs.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.)

jobs.metadata

object

User defined metadata.

jobs.shots

number

default: 100

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

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

jobs.gate_counts

object

The number of gates used with this job.

jobs.qubits

integer

The number of qubits used with this job.

jobs.cost_usd

number

The cost (in US dollars) of this job.

jobs.request

integer

required

The point in time this job was requested.

jobs.start

integer

The point in time this job was started.

jobs.response

integer

The point in time this job was completed.

jobs.execution_time

integer

The actual execution time of this job.

jobs.predicted_execution_time

integer

The predicted execution time of this job.

jobs.children

string[]

A list of child jobs that were created from this job.

jobs.results_url

string

Relative API path to retrieve the results for this job. See <a href="#tag/jobs/operation/getJobResults">Get a Specific Job's Output</a> for more details.

jobs.failure

object

Error metadata, if the job failed.

jobs.warning

object

Warning metadata, if a warning is necessary.

jobs.circuits

integer

The number of circuits of this job.

string

ID of next batch of resources to load.

Was this page helpful?

Using native gates with the IonQ API Create a Job

curl "https://api.ionq.co/v0.3/jobs" \
  -H "Authorization: apiKey your-api-key"

IonQ APIs

Jobs

Characterizations

Backends

Reports

Authorizations

Query Parameters

Response