ibm-quantum Jobs API
The Jobs API from ibm-quantum — 7 operation(s) for jobs.
ibm-quantum Jobs API is one of 11 APIs that ibm-quantum 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 9 operations across 7 paths, and defines 73 schemas. It is described by OpenAPI 3.0.0, at version 0.45.3.
Requests are made against 2 base URLs: https://quantum.cloud.ibm.com/api, https://eu-de.quantum.cloud.ibm.com/api.
9 operations
7 paths
73 schemas
1 DELETE5 GET2 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
ibm-quantum Jobs API declares
3 security schemes
for authenticating requests.
It accepts HTTP bearer tokens (BearerAuth).
An API key is passed in the header as Service-CRN (ServiceCRN).
An API key is passed in the header as IBM-API-Version (ApiVersion).
By default, every request must be authenticated.
BearerAuth— IBM Cloud IAM bearer tokenServiceCRN— IBM Cloud Service CRN identifying the Qiskit Runtime instanceApiVersion— API version, e.g. 2026-03-15
Paths & Operations 9
Across 7 paths, the API surfaces 9 operations — 1 DELETE, 5 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Jobs 9
GET
/v1/jobs/{id}
List Job Details
DELETE
/v1/jobs/{id}
Delete a Job
GET
/v1/jobs
List Jobs
POST
/v1/jobs
Run a Job
GET
/v1/jobs/{id}/results
List Job Results
GET
/v1/jobs/{id}/logs
List Job Logs
POST
/v1/jobs/{id}/cancel
Cancel a Job
GET
/v1/jobs/{id}/metrics
Get Job Metrics
PUT
/v1/jobs/{id}/tags
Replace Job Tags
Schemas 73
The contract defines 73 schemas that model the data the API accepts and returns. The most detailed are JobResponseV3 (17 properties), JobRunParamsBase (8 properties), NoiseLearnerV3V02OptionsModel (6 properties), ExecutorV02SamplexItemModel (6 properties). Each schema is shown below with its type and property counts.
Private
boolean
When set to true, input parameters are not returned, and the results can only be read once. After the job is completed, input parameters are deleted from the s…
ExecutorV01CircuitItemModel
object
Execution specifications for a single quantum circuit.
4 properties
2 required
RemoteStorage
ExecutorV02ParamsModel
object
A model describing the Executor program inputs.
3 properties
2 required
SamplexModelSSV1ToSSV2
object
A samplex model constrained to use samplex serialization versions (SSV) 1 or 2.
2 properties
2 required
JobCost
integer
Cost of the job as the estimated time it should take to complete (in seconds). Should not exceed the cost of the program. If the provided value exceeds the max…
BillingStatus
string
Status of billing data completeness
ExecutorV02OptionsModel
object
Runtime options.
5 properties
JobCreateResponse
object
Response when creating a job
5 properties
2 required
JobRunParamsBase
object
Parameters used to run a job
8 properties
2 required
ChunkSpan
object
Timing information about a single chunk of execution. .. note:: This span may include some amount of non-circuit time.
3 properties
3 required
ExecutorV02SamplexItemModel
object
Execution specifications for a single quantum circuit.
6 properties
4 required
Program
object
Program associated with the job
1 property
1 required
QpyModelV13ToV17
object
QPY encoded circuits with restricted version range.
2 properties
2 required
JobState
object
Current state of the job
4 properties
1 required
ExecutorV01MetadataModel
object
Execution metadata.
1 property
1 required
NoiseLearnerV3V02LinbdbladResultMetadataModel
object
The metadata of a single Lindblad result of a noise learner v3 job.
2 properties
1 required
ExecutorV01OptionsModel
object
Runtime options.
2 properties
ExecutorV01QuantumProgramResultItemModel
object
Results for a single quantum program item.
2 properties
2 required
JobsResponse
object
Jobs collection response
4 properties
3 required
ItemMetadataModel
object
Per-item metadata for quantum program results.
2 properties
ExecutorV02CircuitItemModel
object
Execution specifications for a single quantum circuit.
4 properties
2 required
NoiseLearnerV3V02OptionsModel
object
Runtime options with all fields set.
6 properties
NoiseLearnerV3V01ParamsModel
object
Schema version 1 of the inner parameters.
3 properties
2 required
JobRunParamsSampler
object
The input for an SamplerV2 API call
5 properties
1 required
ExecutorV01SamplexItemModel
object
Execution specifications for a single quantum circuit.
6 properties
4 required
ExecutorV02MetadataModel
object
Execution metadata.
1 property
1 required
NoiseLearnerV3V01NoiseLearnerV3ResultModel
object
Results for a single noise learner V3 item.
5 properties
5 required
Params
object
Parameters used to execute the job
F64TensorModel
object
Model of tensor data specialized to f64.
3 properties
2 required
JobResponseV3
object
A job
17 properties
6 required
TensorModel
object
Model of tensor data.
3 properties
3 required
ExecutorV02QuantumProgramModel
object
Model to store a quantum program.
4 properties
2 required
ExecutorV02QuantumProgramResultItemModel
object
Results for a single quantum program item.
2 properties
2 required
ChunkPart
object
A description of the contents of a single part of an execution chunk.
2 properties
2 required
SamplexModelSSV1
object
A samplex model constrained to use samplex serialization version (SSV) 1.
2 properties
2 required
JobRunParams
JobMetricsResponse
object
Various metrics about the execution of a job
5 properties
UsageV3
object
usage metrics
2 properties
ExecutorV01ParamsModel
object
Schema version 1 of the inner parameters.
3 properties
2 required
NoiseLearnerV3V01LinbdbladResultPostSelectionMetadataModel
object
The post selection metadata of a single Linbdblad result of a noise learner v3 job.
1 property
1 required
QpyModelV13ToV16
object
QPY encoded circuits with restricted version range.
2 properties
2 required
NoiseLearnerV3V01OptionsModel
object
Runtime options with all fields set.
4 properties
PostSelectionOptionsModel
object
Runtime options for post selection.
3 properties
NoiseLearnerV3V02ParamsModel
object
Schema version 1 of the inner parameters.
3 properties
2 required
ExecutorV02QuantumProgramResultModel
object
Result from executing a quantum program.
4 properties
2 required
ExecutorV01QuantumProgramModel
object
Model to store a quantum program.
2 properties
2 required
NoiseLearnerV3V02TREXResultMetadataModel
object
The metadata of a single TREX result of a noise learner v3 job.
2 properties
1 required
JobRunParamsChannelPartner
NoiseLearnerV3V02NoiseLearnerV3ResultsModel
object
Result from executing a noise learner v3 job.
2 properties
1 required
NoiseLearnerV3V02NoiseLearnerV3ResultModel
object
Results for a single noise learner V3 item.
5 properties
5 required
SchedulerTimingModel
object
Describes the timing of a scheduled circuit. All timing information is expressed in terms of multiples of the quantity dt, time step duration of the control el…
2 properties
2 required
NoiseLearnerV3V01TREXResultPostSelectionMetadataModel
object
The post selection metadata of a single TREX result of a noise learner v3 job.
1 property
1 required
IBMCloudCOSRemoteStorageOption
object
Remote storage metadata for where data is stored or to be stored in an IBM Cloud Object Storage bucket. Required fields may be omitted in field specific object…
5 properties
4 required
DataTree
ExecutorV01QuantumProgramResultModel
object
Result from executing a quantum program.
3 properties
2 required
NoiseLearnerV3V02LinbdbladResultPostSelectionMetadataModel
object
The post selection metadata of a single Linbdblad result of a noise learner v3 job.
2 properties
2 required
NoiseLearnerV3V02TREXResultPostSelectionMetadataModel
object
The post selection metadata of a single TREX result of a noise learner v3 job.
2 properties
2 required
JobResults
Result output for all programs.
StretchValueModel
object
Describes circuit stretch value resolutions. All timing information is expressed in terms of multiples of the quantity dt, time step duration of the control el…
4 properties
4 required
PauliLindbladMapModel
object
Encoding of a sparse Pauli Lindblad map.
2 properties
2 required
Tags
array
List of job or program tags
ErrorContainer
object
Error response
2 properties
JsonValue
NoiseLearnerV3V01NoiseLearnerV3ResultsModel
object
Result from executing a noise learner v3 job.
2 properties
1 required
Timestamps
object
A map of status transitions to timestamps
3 properties
JobRunParamsNoiseLearner
object
The input for a NoiseLearner API call
3 properties
1 required
NoiseLearnerV3V01LinbdbladResultMetadataModel
object
The metadata of a single Lindblad result of a noise learner v3 job.
2 properties
1 required
JobStatus
string
Current status of the job
JobRunParamsEstimator
object
The input for an EstimatorV2 API call
6 properties
1 required
RemoteStorageOption
QiskitVersion
string
Qiskit version used during execution of the job
NoiseLearnerV3V01TREXResultMetadataModel
object
The metadata of a single TREX result of a noise learner v3 job.
2 properties
1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from ibm-quantum 10
Other APIs ibm-quantum publishes across the network.
Qiskit Functions Catalog API
Qiskit Transpiler as a Service API
ibm-quantum Accounts API
ibm-quantum Analytics API
ibm-quantum Backends API
ibm-quantum Instances API
ibm-quantum Sessions API
ibm-quantum Tags API
ibm-quantum Versions API
ibm-quantum Workloads API
#Jobs