- Educational Resources
- Sample Notebooks
- Get Help
- Introduction
- Core Concepts
- Writing Quantum Programs
- Migrating from old API versions
- Multicircuit Jobs
- GETGet Jobs
- POSTCreate a Job
- DELDelete many Jobs
- GETGet a specific Job
- DELDelete a Job
- GETGet a Job's output
- PUTCancel a Job
- PUTCancel many Jobs
- GETGet All Backend Characterizations
- GETGet the Most Recent Backend Characterization
- GETGet a Characterization
- GETGet Backends
IonQ APIs
Jobs
Characterizations
Backends
Get Jobs
NOTE: If request filters are provided, this endpoint will limit responses to 1 or more specific jobs based on those filters.
This endpoint retrieves all jobs this API key is authorized to view.
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
If provided, will only return jobs whose UUID matches the list provided.
If provided, will only return jobs whose status matches the one provided.
How many objects to return.
ID of next batch of resources to load.
curl --request GET \
--url https://api.ionq.co/v0.3/jobs \
--header 'Authorization: <api-key>'{
"jobs": [
{
"id": "aa54e783-0a9b-4f73-ad2f-63983b6aa4a8",
"name": "My Awesome Job",
"status": "completed",
"target": "qpu.harmony",
"noise": {
"model": "harmony",
"seed": 100
},
"metadata": {
"custom_key": "a string, maximum 400 chars"
},
"shots": 123,
"error_mitigation": {
"debias": true
},
"gate_counts": {
"1q": 8,
"2q": 2
},
"qubits": 4,
"cost_usd": 12.41,
"request": 1490932820,
"start": 1490932821,
"response": 1490932834,
"execution_time": 13,
"predicted_execution_time": 13,
"children": [
"aa54e783-0a9b-4f73-ad2f-63983b6aa4a8"
],
"results_url": "/v0.3/jobs/617a1f8b-59d4-435d-aa33-695433d7155e/results",
"failure": {
"error": "An error occurred!",
"code": "internal_error"
},
"warning": {
"messages": [
"<string>"
]
},
"circuits": 1
}
],
"next": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}Authorizations
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
If provided, will only return jobs whose UUID matches the list provided.
If provided, will only return jobs whose status matches the one provided.
submitted, ready, running, canceled, completed, failed How many objects to return.
ID of next batch of resources to load.
Response
A list of jobs.
The UUID of a job. We'll provide the UUID initially in our response to a job creation request.
A job name.
If provided, will only return jobs whose status matches the one provided.
submitted, ready, running, canceled, completed, failed Target hardware for job to run on.
qpu.harmony, qpu.aria-1, qpu.aria-2, qpu.forte-1, simulator 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.)
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.
harmony, aria-1, ideal 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.
User defined metadata.
How many times to execute your circuit when submitting to a QPU or a "non-ideal" noisy simulator.
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.
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.
The number of gates used with this job.
How many 1-qubit gates were used.
How many 2-qubit gates were used.
The number of qubits used with this job.
The cost (in US dollars) of this job.
The point in time this job was requested.
The point in time this job was started.
The point in time this job was completed.
The actual execution time of this job.
The predicted execution time of this job.
A list of child jobs that were created from this job.
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.
Error metadata, if the job failed.
A helpful error message.
A helpful error code.
Warning metadata, if a warning is necessary.
A list of warnings to emit.
The number of circuits of this job.
ID of next batch of resources to load.
Was this page helpful?
curl --request GET \
--url https://api.ionq.co/v0.3/jobs \
--header 'Authorization: <api-key>'{
"jobs": [
{
"id": "aa54e783-0a9b-4f73-ad2f-63983b6aa4a8",
"name": "My Awesome Job",
"status": "completed",
"target": "qpu.harmony",
"noise": {
"model": "harmony",
"seed": 100
},
"metadata": {
"custom_key": "a string, maximum 400 chars"
},
"shots": 123,
"error_mitigation": {
"debias": true
},
"gate_counts": {
"1q": 8,
"2q": 2
},
"qubits": 4,
"cost_usd": 12.41,
"request": 1490932820,
"start": 1490932821,
"response": 1490932834,
"execution_time": 13,
"predicted_execution_time": 13,
"children": [
"aa54e783-0a9b-4f73-ad2f-63983b6aa4a8"
],
"results_url": "/v0.3/jobs/617a1f8b-59d4-435d-aa33-695433d7155e/results",
"failure": {
"error": "An error occurred!",
"code": "internal_error"
},
"warning": {
"messages": [
"<string>"
]
},
"circuits": 1
}
],
"next": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}