IBM Qiskit Runtime — Sessions

naftiko: 1.0.0-alpha2
info:
  label: "IBM Qiskit Runtime \u2014 Sessions"
  description: "IBM Qiskit Runtime \u2014 Sessions. 4 operations across the IBM Qiskit Runtime REST API. Self-contained Naftiko capability covering one IBM Quantum business surface."
  tags:
  - IBM Quantum
  - Quantum Computing
  - Qiskit
  - Sessions
  created: '2026-05-25'
  modified: '2026-05-25'
binds:
- namespace: env
  keys:
    IBM_CLOUD_API_KEY: IBM_CLOUD_API_KEY
    IBM_QUANTUM_CRN: IBM_QUANTUM_CRN
    IBM_QUANTUM_API_VERSION: IBM_QUANTUM_API_VERSION
capability:
  consumes:
  - type: http
    namespace: runtime-sessions
    baseUri: https://quantum.cloud.ibm.com/api
    description: "IBM Qiskit Runtime \u2014 Sessions business capability. Self-contained, no shared references."
    resources:
    - name: v1-sessions
      path: /v1/sessions
      operations:
      - name: create-session
        method: POST
        description: Create a Session
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: v1-sessions-id
      path: /v1/sessions/{id}
      operations:
      - name: get-session
        method: GET
        description: Get a Session
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: update-session
        method: PATCH
        description: Update a Session
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: v1-sessions-id-close
      path: /v1/sessions/{id}/close
      operations:
      - name: delete-session-close
        method: DELETE
        description: Close Job Session
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Session Id
          required: true
    authentication:
      type: bearer
      value: '{{env.IBM_CLOUD_API_KEY}}'
      placement: header
    defaultHeaders:
      Service-CRN: '{{env.IBM_QUANTUM_CRN}}'
      IBM-API-Version: '{{env.IBM_QUANTUM_API_VERSION}}'
  exposes:
  - type: rest
    namespace: runtime-sessions-rest
    port: 8080
    description: "REST adapter for IBM Qiskit Runtime \u2014 Sessions. Spectral-compliant resources, prefixed with /v1."
    resources:
    - path: /v1/v1/sessions
      name: v1-sessions
      description: REST surface for v1-sessions.
      operations:
      - method: POST
        name: create-session
        description: Create a Session
        call: runtime-sessions.create-session
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/sessions/{id}
      name: v1-sessions-id
      description: REST surface for v1-sessions-id.
      operations:
      - method: GET
        name: get-session
        description: Get a Session
        call: runtime-sessions.get-session
        with: {}
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: update-session
        description: Update a Session
        call: runtime-sessions.update-session
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/sessions/{id}/close
      name: v1-sessions-id-close
      description: REST surface for v1-sessions-id-close.
      operations:
      - method: DELETE
        name: delete-session-close
        description: Close Job Session
        call: runtime-sessions.delete-session-close
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: runtime-sessions-mcp
    port: 9090
    transport: http
    description: "MCP adapter for IBM Qiskit Runtime \u2014 Sessions. One tool per consumed operation."
    tools:
    - name: ibm-quantum-create-session
      description: Create a Session
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: runtime-sessions.create-session
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: ibm-quantum-get-session
      description: Get a Session
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: runtime-sessions.get-session
      with: {}
      outputParameters:
      - type: object
        mapping: $.
    - name: ibm-quantum-update-session
      description: Update a Session
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: runtime-sessions.update-session
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: ibm-quantum-delete-session-close
      description: Close Job Session
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: runtime-sessions.delete-session-close
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.