How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
IBM Quantum

ibm-quantum Sessions API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

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.2.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.2.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
Contact
IBM Quantum
License
IBM
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), CreateSessionRequestChannelPartner (2 properties), SessionTimestamp (2 properties). Each schema is shown below with its type and property counts.

JobSession
object
Job session
17 properties 3 required
SessionTimestamp
object
Contains information about the time a specific status transition happened
2 properties 2 required
BaseCreateSessionRequest
object
Base request schema to create a session.
4 properties 1 required
CreateSessionRequest
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…
CreateSessionRequestChannelPartner
object
Request to create a session. Only for use by channel partner.
2 properties 1 required
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…
SessionStateReason
string
The reason for the state change.
CreateSessionRequestCloud
ExecutionMode
string
Execution mode to run the session in
UpdateSessionRequest
object
1 property 1 required
ErrorContainer
object
Error response
2 properties

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
AE Profile APIs.io
Qiskit Transpiler as a Service API
AE Profile APIs.io
ibm-quantum Accounts API
AE Profile APIs.io
ibm-quantum Analytics API
AE Profile APIs.io
ibm-quantum Backends API
AE Profile APIs.io
ibm-quantum Instances API
AE Profile APIs.io
ibm-quantum Jobs API
AE Profile APIs.io
ibm-quantum Tags API
AE Profile APIs.io
ibm-quantum Versions API
AE Profile APIs.io
ibm-quantum Workloads API
AE Profile APIs.io
#Sessions
← Back to I APIs
API Details
ID
ibm-quantum:ibm-quantum-sessions-api
Server
https://quantum.cloud.ibm.com/api
Docs
https://quantum.cloud.ibm.com/docs/api/qiskit-runtime-rest
Provider
IBM Quantum
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=ibm-quantum-sessions-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/ibm-quantum-sessions-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of ibm-quantum Sessions API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.