Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

IonQ Jobs API

The Jobs API from IonQ — 11 operation(s) for jobs.

IonQ Jobs API is one of 7 APIs that IonQ publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 3 JSON Schema definitions.

Tagged areas include Jobs. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 3 JSON Schemas.

This API exposes 14 operations across 11 paths, and defines 54 schemas. It is described by OpenAPI 3.0.3, at version v0.4.

Requests are made against a single base URL, https://api.ionq.co/v0.4.

14 operations 11 paths 54 schemas 2 DELETE9 GET1 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
v0.4
Base URL
https://api.ionq.co/v0.4
Authentication
API Key
Contact
Resource Areas
1

Authentication & Security 1

IonQ Jobs API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (apiKeyAuth).

  • apiKeyAuth — API keys are associated with a user and can be created on the [IonQ Quantum Cloud](https://cloud.ionq.com) application. To authenticate, prefix your API Key wi…

Paths & Operations 14

Across 11 paths, the API surfaces 14 operations — 2 DELETE, 9 GET, 1 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Jobs 14
POST
/jobs
Submit a single-circuit or multi-circuit job for simulation or execution. In ionq.multi-circuit.v1 payloads, each entry in input.circuits inherits the parent input.gateset unless the circuit sets its…
CreateJob body → 201429500502503
GET
/jobs
GetJobs 8 params → 200429500502503
DELETE
/jobs
DeleteJobs body → 200429500502503
GET
/jobs/{UUID}
GetJob 1 param → 200429500502503
DELETE
/jobs/{UUID}
DeleteJob 1 param → 200429500502503
GET
/jobs/{UUID}/cost
GetJobCost 1 param → 200429500502503
GET
/jobs/{UUID}/circuits/{lang}
GetCompiledFile 2 params → 200403404429500502503
PUT
/jobs/{UUID}/status/cancel
Cancel a job
CancelJob 1 param → 200429500502503
PUT
/jobs/status/cancel
CancelJobs body → 200429500502503
GET
/jobs/estimate
EstimateJobCost 7 params → 200429500502503
GET
/jobs/{UUID}/results/probabilities
Fetch the probability distribution for a completed job.
GetJobProbabilities 2 params → 200404
GET
/jobs/{UUID}/variants/{variantId}/results/probabilities
GetVariantProbabilities 2 params → 200404
GET
/jobs/{UUID}/variants/{variantId}/results/histogram
GetVariantHistogram 2 params → 200404
GET
/jobs/{UUID}/variants/{variantId}/results/shots
GetVariantShots 2 params → 200404

Schemas 54

The contract defines 54 schemas that model the data the API accepts and returns. The most detailed are GetCircuitJobResponse (26 properties), BaseJob (25 properties), QctrlQaoaJobCreationPayload (10 properties), MultiCircuitJobCreationPayload (10 properties). Each schema is shown below with its type and property counts.

CircuitJobCreationPayload
object
10 properties 3 required
GetVariantResultsResponse
object
JobDeletedResponse
object
2 properties 2 required
QisGate
string
GetJobCostResponse
object
3 properties 2 required
JsonObject
object
CircuitJobCompilationSettings
object
4 properties
GetJobEstimateQueryParams
object
7 properties 1 required
QuantumFunctionInput
QuadraticConstraint
object
A class to model quadratic inequality constraints of the form .. math:: x^T P x + r^T x \leq c.
3 properties 3 required
JobStatus
string
Registers
object
JobBackends
string
Available options: simulator, qpu.aria-1, qpu.aria-2, qpu.forte-1, qpu.forte-enterprise-1
BaseJob
object
25 properties 22 required
NumberMap
object
CircuitJobStats
object
6 properties
Noise
object
2 properties 1 required
CircuitJobSettings
object
2 properties
CostModel
string
HamiltonianEnergyData
object
6 properties 2 required
QISCircuit
object
5 properties 1 required
Ansatz
object
1 property 1 required
JobsDeletedResponse
object
2 properties 2 required
LinearConstraint
object
A class to model linear inequality constraints of the form .. math:: A x \leq b.
2 properties 2 required
MultiCircuitJobCreationPayload
object
Submit multiple circuits in a single job. Each circuit inherits the parent input.gateset unless overridden by circuits[].gateset.
10 properties 3 required
JobCanceledResponse
object
2 properties 2 required
Failure
object
2 properties 2 required
GetResultsResponse
object
GetJobsResponse
object
2 properties 2 required
Gate_NativeGate
object
8 properties 1 required
GetJobEstimateResponse
object
7 properties 7 required
NoiseModel
string
GetCircuitJobResponse
object
26 properties 23 required
CircuitJobResult
object
3 properties
JsonCircuitInput
HamiltonianEnergyInput
object
2 properties 1 required
GetJobResponse
NativeGate
string
Gate_QisGate
object
6 properties 1 required
NativeCircuit
object
5 properties 1 required
GenericQuantumFunctionInput
object
3 properties 2 required
JobsCanceledResponse
object
2 properties 2 required
JobsBulkOperationRequest
object
1 property 1 required
QctrlQaoaJobCreationPayload
object
Submit a combinatorial optimization job to solve a maxcut problem using Q-CTRL's QAOA Solver. See our QAOA Job guide for more infromation.
10 properties 4 required
JobCreationPayload
JsonMultiCircuitInput
object
3 properties 2 required
QctrlQaoaJobInput
object
2 properties 2 required
IsoTimestamp
string
JobCreationResponse
object
3 properties 3 required
NativeCircuitInput
object
3 properties 2 required
JobMetadata
object
HamiltonianPauliTerm
object
2 properties 2 required
QisCircuitInput
object
3 properties 2 required
QuantumFunctionJobCreationPayload
object
9 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ionq-jobs-api-openapi.yml Raw ↑

Other APIs IonQ publishes across the network.

IonQ Quantum Cloud API (v0.3 Legacy)
IonQ backends API
IonQ characterizations API
IonQ Sessions API
IonQ usage API
IonQ whoami API