GET
/
jobs
# Get all jobs:
curl "https://api.ionq.co/v0.2/jobs" \
  -H "Authorization: apiKey your-api-key"

# Filter jobs by id:
curl "https://api.ionq.co/v0.2/jobs?id=617a1f8b-59d4-435d-aa33-695433d7155e&id=2ccf2773-4c28-468e-a290-2f8554808a25" \
  -H "Authorization: apiKey your-api-key"
{
  "jobs": [
    {
      "id": "aa54e783-0a9b-4f73-ad2f-63983b6aa4a8",
      "type": "circuit",
      "name": "My Awesome Job",
      "status": "completed",
      "target": "qpu.harmony",
      "noise": {
        "model": "harmony",
        "seed": 100
      },
      "data": {
        "histogram": {
          "0": 0.5,
          "1": 0.5,
          "2": 1e-7
        }
      },
      "metadata": {
        "custom_key": "a string, maximum 400 chars"
      },
      "shots": 123,
      "gate_counts": {
        "1q": 8,
        "2q": 2
      },
      "qubits": 4,
      "request": 1490932820,
      "start": 1490932821,
      "response": 1490932834,
      "execution_time": 13,
      "predicted_execution_time": 13,
      "failure": {
        "error": "An error occurred!",
        "code": "internal_error"
      },
      "warning": {
        "messages": [
          "<string>"
        ]
      }
    }
  ],
  "next": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

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

Query Parameters

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

next
string

ID of next batch of resources to load.

Response

200 - application/json
jobs
object[]

A list of jobs.

next
string

ID of next batch of resources to load.