Get Jobs

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

Query Parameters

string<uuid>[]

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

UUID of a job

status

enum<string>

If provided, will only return jobs whose status matches the one provided. Status of a job.

Available options:

submitted,

ready,

running,

canceled,

completed,

failed

Example:

"completed"

limit

integer

default:25

How many objects to return.

Required range: 1 <= x <= 25

string<uuid>

ID of next batch of resources to load.

Response

200 - application/json

Successfully retrieved a list of jobs.

Response body when requesting all or many jobs.

jobs

object[]

A list of jobs.

Show child attributes

jobs.id

string<uuid>

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"

jobs.status

enum<string>

required

Status of a job.

Available options:

submitted,

ready,

running,

canceled,

completed,

failed

Example:

"completed"

jobs.request

integer<unix-timestamp>

required

The point in time this job was requested.

Example:

1490932820

jobs.name

string

A job name.

Example:

"My Awesome Job"

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,

qpu.forte-enterprise-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.)

Show child attributes

jobs.noise.model

enum<string>

Selects a noise model to apply to a simulation job. The default, ideal, provides perfect simulation without noise, while other noise models like harmony are based on noise data collected from our actual quantum computers. Note that these are simplified noise models, not intended to exactly reproduce real quantum computations.

Available options:

harmony,

aria-1,

ideal

jobs.noise.seed

integer

This is the seed value for the pseudo-random sampling and noise generation when a system noise model is specified. The seed needs to be a positive integer between 1 and 2^31. Providing a seed is optional and allows for repeatable (i.e. non-random) outcomes. If a seed is not specified, one is chosen at random and will be provided in the output for the simulation. This field does not apply to simulations using the "ideal" noise model. This field also does not apply to qpu.* targets.

Example:

100

jobs.metadata

object

User defined metadata.

Example:

{
  "custom_key": "a string, maximum 400 chars"
}

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.

Show child attributes

jobs.error_mitigation.debias

boolean

Set to true to turn on debiasing, which can improve circuit performance by removing qubit-specific noise. Debiasing is on by default for Aria-class systems.

jobs.gate_counts

object

The number of gates used with this job.

Show child attributes

jobs.gate_counts.1q

number

How many 1-qubit gates were used.

Example:

8

jobs.gate_counts.2q

number

How many 2-qubit gates were used.

Example:

2

jobs.qubits

integer

The number of qubits used with this job.

Example:

4

jobs.cost_usd

number

The cost (in US dollars) of this job.

Example:

12.41

jobs.start

integer<unix-timestamp>

The point in time this job was started.

Example:

1490932821

jobs.response

integer<unix-timestamp>

The point in time this job was completed.

Example:

1490932834

jobs.execution_time

integer

The actual execution time of this job.

Example:

13

jobs.predicted_execution_time

integer

The predicted execution time of this job.

Example:

13

jobs.children

string<uuid>[]

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

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

jobs.results_url

string

Relative API path to retrieve the results for this job. See Get a Specific Job's Output for more details.

Example:

"/v0.3/jobs/617a1f8b-59d4-435d-aa33-695433d7155e/results"

jobs.failure

object

Error metadata, if the job failed.

Show child attributes

jobs.failure.error

string

A helpful error message.

Example:

"An error occurred!"

jobs.failure.code

string

A helpful error code.

Example:

"internal_error"

jobs.warning

object

Warning metadata, if a warning is necessary.

Show child attributes

jobs.warning.messages

string[]

A list of warnings to emit.

jobs.circuits

integer

The number of circuits of this job.

Example:

1

string<uuid>

ID of next batch of resources to load.

IonQ v0.3 API

Jobs

Characterizations

Backends

Reports

Authorizations

Query Parameters

Response