ibm-quantum Workloads API
The Workloads API from ibm-quantum — 1 operation(s) for workloads.
ibm-quantum Workloads 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 Workloads. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 3 JSON Schemas.
This API exposes 1 operation across 1 path, and defines 6 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.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
ibm-quantum Workloads 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 1
Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.
Schemas 6
The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are WorkloadResponse (14 properties), PaginationWorkloadsResponse (5 properties), GenericError (4 properties), GenericErrorDto (2 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from ibm-quantum 10
Other APIs ibm-quantum publishes across the network.