IBM Qiskit Runtime — Instances

naftiko: 1.0.0-alpha2
info:
  label: "IBM Qiskit Runtime \u2014 Instances"
  description: "IBM Qiskit Runtime \u2014 Instances. 5 operations across the IBM Qiskit Runtime REST API. Self-contained Naftiko capability covering one IBM Quantum business surface."
  tags:
  - IBM Quantum
  - Quantum Computing
  - Qiskit
  - Instances
  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-instances
    baseUri: https://quantum.cloud.ibm.com/api
    description: "IBM Qiskit Runtime \u2014 Instances business capability. Self-contained, no shared references."
    resources:
    - name: v1-instance
      path: /v1/instance
      operations:
      - name: get-instance
        method: GET
        description: Get Current Instance Details
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v1-instances-configuration
      path: /v1/instances/configuration
      operations:
      - name: get-instance-configuration
        method: GET
        description: Get Instance Configuration
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: replace-instance-configuration
        method: PUT
        description: Update Instance Configuration
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: v1-accounts-id
      path: /v1/accounts/{id}
      operations:
      - name: get-account
        method: GET
        description: Get Account Configuration
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: plan_id
          in: query
          type: string
          description: Obtain the account configuration only for the specified plan
          required: false
    - name: v1-instances-usage
      path: /v1/instances/usage
      operations:
      - name: get-usage
        method: GET
        description: Get Instance Usage
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    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-instances-rest
    port: 8080
    description: "REST adapter for IBM Qiskit Runtime \u2014 Instances. Spectral-compliant resources, prefixed with /v1."
    resources:
    - path: /v1/v1/instance
      name: v1-instance
      description: REST surface for v1-instance.
      operations:
      - method: GET
        name: get-instance
        description: Get Current Instance Details
        call: runtime-instances.get-instance
        with: {}
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/instances/configuration
      name: v1-instances-configuration
      description: REST surface for v1-instances-configuration.
      operations:
      - method: GET
        name: get-instance-configuration
        description: Get Instance Configuration
        call: runtime-instances.get-instance-configuration
        with: {}
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: replace-instance-configuration
        description: Update Instance Configuration
        call: runtime-instances.replace-instance-configuration
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/accounts/{id}
      name: v1-accounts-id
      description: REST surface for v1-accounts-id.
      operations:
      - method: GET
        name: get-account
        description: Get Account Configuration
        call: runtime-instances.get-account
        with:
          plan_id: rest.plan_id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/instances/usage
      name: v1-instances-usage
      description: REST surface for v1-instances-usage.
      operations:
      - method: GET
        name: get-usage
        description: Get Instance Usage
        call: runtime-instances.get-usage
        with: {}
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: runtime-instances-mcp
    port: 9090
    transport: http
    description: "MCP adapter for IBM Qiskit Runtime \u2014 Instances. One tool per consumed operation."
    tools:
    - name: ibm-quantum-get-instance
      description: Get Current Instance Details
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: runtime-instances.get-instance
      with: {}
      outputParameters:
      - type: object
        mapping: $.
    - name: ibm-quantum-get-instance-configuration
      description: Get Instance Configuration
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: runtime-instances.get-instance-configuration
      with: {}
      outputParameters:
      - type: object
        mapping: $.
    - name: ibm-quantum-replace-instance-configuration
      description: Update Instance Configuration
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: runtime-instances.replace-instance-configuration
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: ibm-quantum-get-account
      description: Get Account Configuration
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: runtime-instances.get-account
      with:
        plan_id: tools.plan_id
      outputParameters:
      - type: object
        mapping: $.
    - name: ibm-quantum-get-usage
      description: Get Instance Usage
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: runtime-instances.get-usage
      with: {}
      outputParameters:
      - type: object
        mapping: $.