GET
/
jobs
/
{UUID}
curl --request GET \
  --url https://api.ionq.co/v0.3/jobs/{UUID} \
  --header 'Authorization: <api-key>'
{
  "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
}

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

Path Parameters

UUID
string
required

The UUID of the job — this UUID is provided in the response on job creation.

Query Parameters

exclude
string[]

Exclude certain fields from the response (e.g., exclude=status,device_id).

include
string[]

Only return the provided fields (e.g., include=status,device_id).

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.

name
string

A job name.

status
enum<string>
required

Status of a job.

Available options:
submitted,
ready,
running,
canceled,
completed,
failed
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
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.)

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.

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.

gate_counts
object

The number of gates used with this job.

qubits
integer

The number of qubits used with this job.

cost_usd
number

The cost (in US dollars) of this job.

request
integer
required

The point in time this job was requested.

start
integer

The point in time this job was started.

response
integer

The point in time this job was completed.

execution_time
integer

The actual execution time of this job.

predicted_execution_time
integer

The predicted execution time of this job.

children
string[]

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

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.

failure
object

Error metadata, if the job failed.

warning
object

Warning metadata, if a warning is necessary.

circuits
integer

The number of circuits of this job.

Was this page helpful?

Delete many JobsDelete a Job