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

ibm-quantum Sessions API

The Sessions API from ibm-quantum — 3 operation(s) for sessions.

ibm-quantum Sessions 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 Sessions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 3 JSON Schemas.

This API exposes 4 operations across 3 paths, and defines 12 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.

4 operations 3 paths 12 schemas 1 DELETE1 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
0.45.3
Servers
https://quantum.cloud.ibm.com/api
https://eu-de.quantum.cloud.ibm.com/api
Authentication
HTTP Bearer, API Key, API Key
License
Resource Areas
1

Authentication & Security 3

ibm-quantum Sessions 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 token
  • ServiceCRN — IBM Cloud Service CRN identifying the Qiskit Runtime instance
  • ApiVersion — API version, e.g. 2026-03-15

Paths & Operations 4

Across 3 paths, the API surfaces 4 operations — 1 DELETE, 1 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Sessions 4
POST
/v1/sessions
Create a Session
create_session 1 param body → 200400401500
GET
/v1/sessions/{id}
Get a Session
get_session 2 params → 200401404500
PATCH
/v1/sessions/{id}
Update a Session
update_session 2 params body → 204401404500
DELETE
/v1/sessions/{id}/close
Close Job Session
delete_session_close 2 params → 204

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are JobSession (17 properties), BaseCreateSessionRequest (4 properties), SessionTimestamp (2 properties), ErrorContainer (2 properties). Each schema is shown below with its type and property counts.

CreateSessionRequestChannelPartner
object
Request to create a session. Only for use by channel partner.
2 properties 1 required
ExecutionMode
string
Execution mode to run the session in
JobSession
object
Job session
17 properties 3 required
ErrorContainer
object
Error response
2 properties
SessionTimestamp
object
Contains information about the time a specific status transition happened
2 properties 2 required
AcceptingJobs
boolean
If true, the session is actively accepting new jobs to be queued. If false, jobs will be rejected on create and the session will be immediately closed when the…
SessionState
string
The state of the session. - open: The session is waiting to run jobs. - active: The session has priority to run jobs on the backend and is running jobs or is w…
UpdateSessionRequest
object
1 property 1 required
CreateSessionRequest
SessionStateReason
string
The reason for the state change.
BaseCreateSessionRequest
object
Base request schema to create a session.
4 properties 1 required
CreateSessionRequestCloud

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ibm-quantum-sessions-api-openapi.yml Raw ↑

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 Jobs API
ibm-quantum Tags API
ibm-quantum Versions API
ibm-quantum Workloads API