ibm-quantum Jobs API

The Jobs API from ibm-quantum — 7 operation(s) for jobs.

OpenAPI Specification

ibm-quantum-jobs-api-openapi.yml Raw ↑
openapi: 3.0.0
info:
  title: Qiskit Runtime Analytics Accounts Jobs API
  version: 0.45.3
  description: Read usage analytics and active workloads for a Qiskit Runtime instance, including by-time-window aggregations used to track Open / Pay-as-you-go / Flex / Premium minute consumption.
  contact:
    name: IBM Quantum
    url: https://quantum.cloud.ibm.com
  license:
    name: IBM
    url: https://www.ibm.com/legal
servers:
- url: https://quantum.cloud.ibm.com/api
  description: Global region
- url: https://eu-de.quantum.cloud.ibm.com/api
  description: EU-DE region
security:
- BearerAuth: []
  ServiceCRN: []
  ApiVersion: []
tags:
- name: Jobs
paths:
  /v1/jobs/{id}:
    parameters:
    - schema:
        type: string
        minLength: 1
        maxLength: 1000
        pattern: ^.*$
      name: id
      in: path
      required: true
      description: Identifier of an existing job
    - $ref: '#/components/parameters/IBM-API-Version'
    get:
      summary: List Job Details
      tags:
      - Jobs
      description: List the details about the specified quantum program job.
      parameters:
      - in: query
        name: exclude_params
        required: false
        schema:
          type: boolean
          default: false
        description: Exclude job params from the response
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobResponseV3'
              examples:
                jobResponseSample:
                  $ref: '#/components/examples/jobResponseExample'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorContainer'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorContainer'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorContainer'
      operationId: get_job
      security:
      - IBMCloudAPIKey: []
      - ServiceCRN: []
      - IBMCloudAuth: []
      x-ibm-events:
        events:
        - name: quantum-computing.job.read
      x-ibm-permissions:
        actions:
        - name: quantum-computing.job.read
    delete:
      tags:
      - Jobs
      summary: Delete a Job
      operationId: delete_job
      responses:
        '204':
          description: OK
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorContainer'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorContainer'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorContainer'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorContainer'
        '500':
          description: Internal error deleting job
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorContainer'
      description: Delete the specified job and its associated data. Job must be in a terminal state.
      security:
      - IBMCloudAPIKey: []
      - ServiceCRN: []
      - IBMCloudAuth: []
      x-ibm-events:
        events:
        - name: quantum-computing.job.delete
      x-ibm-permissions:
        actions:
        - name: quantum-computing.job.delete
  /v1/jobs:
    parameters:
    - $ref: '#/components/parameters/IBM-API-Version'
    get:
      parameters:
      - in: query
        name: limit
        required: false
        schema:
          type: integer
          format: int32
          default: 200
          minimum: 1
          maximum: 200
        description: Number of results to return at a time. If the provided value is outside of the viable range, no error occurs and the default value is used instead.
      - in: query
        name: offset
        required: false
        schema:
          type: integer
          format: int32
          default: 0
          minimum: 0
          maximum: 2147483647
        description: Number of results to offset when retrieving the list of jobs. If the provided value is outside of the viable range, no error occurs and the default value is used instead.
      - in: query
        name: pending
        required: false
        schema:
          type: boolean
        description: Returns 'Queued' and 'Running' jobs if true.  Returns 'Completed', 'Cancelled', and 'Failed' jobs if false.
      - in: query
        name: program
        required: false
        schema:
          type: string
          minLength: 1
          maxLength: 63
          pattern: ^.*$
        description: Program ID to filter jobs
      - in: query
        name: backend
        required: false
        schema:
          type: string
          minLength: 1
          maxLength: 100
          pattern: ^.*$
        description: Backend to filter jobs
      - in: query
        name: created_after
        required: false
        schema:
          type: string
          format: date-time
          minLength: 1
          maxLength: 100
        description: Job created after filter
      - in: query
        name: created_before
        required: false
        schema:
          type: string
          format: date-time
          minLength: 1
          maxLength: 100
        description: Job created before filter
      - in: query
        name: sort
        required: false
        schema:
          type: string
          minLength: 1
          maxLength: 4
          pattern: ^(ASC|DESC)$
        description: Sort jobs by created time ASC or DESC (default)
      - in: query
        name: tags
        required: false
        schema:
          $ref: '#/components/schemas/Tags'
        description: Tags to filter jobs
      - in: query
        name: session_id
        required: false
        schema:
          type: string
          minLength: 1
          maxLength: 1000
          pattern: ^.*$
        description: Session ID to filter jobs
      - in: query
        name: exclude_params
        required: false
        schema:
          type: boolean
          default: true
        description: Exclude job params from the response
      tags:
      - Jobs
      summary: List Jobs
      operationId: list_jobs
      description: List the quantum program jobs you have run.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobsResponse'
              examples:
                jobsResponseExample:
                  $ref: '#/components/examples/jobsResponseExample'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorContainer'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorContainer'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorContainer'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorContainer'
      security:
      - IBMCloudAPIKey: []
      - ServiceCRN: []
      - IBMCloudAuth: []
      x-ibm-events:
        events:
        - name: quantum-computing.job.read
      x-ibm-permissions:
        actions:
        - name: quantum-computing.job.read
    post:
      tags:
      - Jobs
      summary: Run a Job
      operationId: create_job
      parameters:
      - name: Parent-Job-Id
        in: header
        description: Parent job ID
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobCreateResponse'
              example:
                id: c5dge2d3rn7breq27i9g
                backend: ibm_backend
                private: true
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorContainer'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorContainer'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorContainer'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorContainer'
        '409':
          description: Usage exceeds instance limit
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorContainer'
      description: Invoke a Qiskit Runtime primitive. Note the returned job ID.  You will use it to check the job's status and review results. This request is rate limited to 5 jobs per minute per user.
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
              - $ref: '#/components/schemas/JobRunParams'
              - $ref: '#/components/schemas/JobRunParamsChannelPartner'
      security:
      - IBMCloudAPIKey: []
      - ServiceCRN: []
      - IBMCloudAuth: []
      x-ibm-events:
        events:
        - name: quantum-computing.job.create
      x-ibm-permissions:
        actions:
        - name: quantum-computing.job.create
  /v1/jobs/{id}/results:
    parameters:
    - schema:
        type: string
        minLength: 1
        maxLength: 1000
        pattern: ^.*$
      name: id
      in: path
      required: true
      description: A job ID
    - $ref: '#/components/parameters/IBM-API-Version'
    get:
      summary: List Job Results
      tags:
      - Jobs
      description: Return the final result from this job.
      responses:
        '200':
          description: Returns the job's final result.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobResults'
        '204':
          description: Job's final result not found.
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorContainer'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorContainer'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorContainer'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorContainer'
      operationId: get_job_results_jid
      security:
      - IBMCloudAPIKey: []
      - ServiceCRN: []
      - IBMCloudAuth: []
      x-ibm-events:
        events:
        - name: quantum-computing.job.read
      x-ibm-permissions:
        actions:
        - name: quantum-computing.job.read
  /v1/jobs/{id}/logs:
    parameters:
    - schema:
        type: string
        minLength: 1
        maxLength: 1000
        pattern: ^.*$
      name: id
      in: path
      required: true
      description: A job ID
    - $ref: '#/components/parameters/IBM-API-Version'
    get:
      operationId: get_jog_logs_jid
      summary: List Job Logs
      tags:
      - Jobs
      description: List all job logs for the specified job.
      responses:
        '200':
          description: Returns job logs.
          content:
            text/plain:
              schema:
                type: string
                description: Job logs.
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorContainer'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorContainer'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorContainer'
      security:
      - IBMCloudAPIKey: []
      - ServiceCRN: []
      - IBMCloudAuth: []
      x-ibm-events:
        events:
        - name: quantum-computing.job.read
      x-ibm-permissions:
        actions:
        - name: quantum-computing.job.read
  /v1/jobs/{id}/cancel:
    parameters:
    - name: Parent-Job-Id
      in: header
      description: Parent job ID
      required: false
      schema:
        type: string
    - schema:
        type: string
        minLength: 1
        maxLength: 1000
        pattern: ^.*$
      name: id
      in: path
      required: true
      description: A job ID
    - $ref: '#/components/parameters/IBM-API-Version'
    post:
      summary: Cancel a Job
      tags:
      - Jobs
      description: Cancels the specified job.
      responses:
        '204':
          description: OK
        '400':
          description: Bad cancel request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorContainer'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorContainer'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorContainer'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorContainer'
        '409':
          description: Job is in non cancellable status.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorContainer'
        '500':
          description: Internal error cancelling job
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorContainer'
      operationId: cancel_job_jid
      security:
      - IBMCloudAPIKey: []
      - ServiceCRN: []
      - IBMCloudAuth: []
      x-ibm-events:
        events:
        - name: quantum-computing.job.cancel
      x-ibm-permissions:
        actions:
        - name: quantum-computing.job.cancel
  /v1/jobs/{id}/metrics:
    parameters:
    - schema:
        type: string
        minLength: 1
        maxLength: 1000
        pattern: ^.*$
      name: id
      in: path
      required: true
      description: A job ID
    - $ref: '#/components/parameters/IBM-API-Version'
    get:
      summary: Get Job Metrics
      tags:
      - Jobs
      description: Gets metrics of specified job
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobMetricsResponse'
              examples:
                jobResponseSample:
                  $ref: '#/components/examples/jobMetricsResponseExample'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorContainer'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorContainer'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorContainer'
      operationId: get_job_metrics_jid
      security:
      - IBMCloudAPIKey: []
      - ServiceCRN: []
      - IBMCloudAuth: []
      x-ibm-events:
        events:
        - name: quantum-computing.job.read
      x-ibm-permissions:
        actions:
        - name: quantum-computing.job.read
  /v1/jobs/{id}/tags:
    parameters:
    - schema:
        type: string
        minLength: 1
        maxLength: 1000
        pattern: ^.*$
      name: id
      in: path
      required: true
      description: A job ID
    - $ref: '#/components/parameters/IBM-API-Version'
    put:
      tags:
      - Jobs
      summary: Replace Job Tags
      operationId: replace_job_tags
      description: Replace job tags
      requestBody:
        content:
          application/json:
            schema:
              type: object
              description: Replace job tags request. Specify an empty array to clear tags.
              properties:
                tags:
                  $ref: '#/components/schemas/Tags'
              required:
              - tags
      responses:
        '204':
          description: OK
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorContainer'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorContainer'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorContainer'
      security:
      - IBMCloudAPIKey: []
      - ServiceCRN: []
      - IBMCloudAuth: []
      x-ibm-events:
        events:
        - name: quantum-computing.job.update
      x-ibm-permissions:
        actions:
        - name: quantum-computing.job.update
components:
  schemas:
    Private:
      type: boolean
      description: When set to true, input parameters are not returned, and the results can only be read once. After the job is completed, input parameters are deleted from the service. After the results are read, they are deleted from the service. When set to false, the input parameters and results follow the standard retention behavior of the API. Only returned in the response if the value is true, otherwise it is omitted.
    ExecutorV01CircuitItemModel:
      description: Execution specifications for a single quantum circuit.
      properties:
        item_type:
          enum:
          - circuit
          default: circuit
          description: The type of quantum program item.
          title: Item Type
          type: string
        circuit:
          $ref: '#/components/schemas/QpyModelV13ToV16'
        circuit_arguments:
          $ref: '#/components/schemas/F64TensorModel'
        chunk_size:
          anyOf:
          - minimum: 1
            type: integer
          - enum:
            - auto
            type: string
          default: auto
          description: 'The maximum number circuit arguments to bind to the circuit per shot loop.


            When ``"auto"``, the number is chosen server-side with heuristics designed to optimize

            execution speed. A quantum program must have items where either all chunk sizes are

            integer-valued, or all chunk sizes are ``"auto"``. Integer values are only allowed inside of

            session exection mode.'
          title: Chunk Size
      required:
      - circuit
      - circuit_arguments
      title: CircuitItemModel
      type: object
    RemoteStorage:
      allOf:
      - allOf:
        - $ref: '#/components/schemas/RemoteStorageOption'
        - description: Default remote storage option for where input data is stored and where output data should be stored
      - title: RemoteStorage
        description: "(Only enabled for Qiskit Runtime instances with the Channel Partner plan) Metadata and connection information on where job params are stored remotely\nand/or where to store results, logs, transpiled circuits, etc. Omitted properties\nin field specific objects will be inherited from the default remote storage option.\nAs an example, the following two objects are equivalent:\n\n```\n{\n    \"type\": \"ibmcloud_cos\",\n    \"region\": \"us-east\",\n    \"region_type\": \"regional\",\n    \"bucket_crn\": \"crn\",\n    \"job_params\": {\n      \"object_name\": \"my-object\"\n    }\n}\n```\n\n```\n{\n    \"type\": \"ibmcloud_cos\",\n    \"region\": \"us-east\",\n    \"region_type\": \"regional\",\n    \"bucket_crn\": \"crn\",\n    \"job_params\": {\n      \"type\": \"ibmcloud_cos\",\n      \"region\": \"us-east\",\n      \"region_type\": \"regional\",\n      \"bucket_crn\": \"crn\",\n      \"object_name\": \"my-object\"\n    }\n}\n```\n"
        properties:
          job_params:
            allOf:
            - $ref: '#/components/schemas/RemoteStorageOption'
            - description: Location for where user supplied job params (omitted properties will will be inherited from default remote storage option)
          results:
            allOf:
            - $ref: '#/components/schemas/RemoteStorageOption'
            - description: Location for where job results will be stored (omitted properties will will be inherited from default remote storage option)
          logs:
            allOf:
            - $ref: '#/components/schemas/RemoteStorageOption'
            - description: Location for where job logs will be stored (omitted properties will will be inherited from default remote storage option)
        required:
        - job_params
        - results
    ExecutorV02ParamsModel:
      description: A model describing the Executor program inputs.
      properties:
        schema_version:
          enum:
          - v0.2
          default: v0.2
          title: Schema Version
          type: string
        quantum_program:
          $ref: '#/components/schemas/ExecutorV02QuantumProgramModel'
        options:
          $ref: '#/components/schemas/ExecutorV02OptionsModel'
      required:
      - quantum_program
      - options
      title: Executor v0.2 input
      type: object
    SamplexModelSSV1ToSSV2:
      description: A samplex model constrained to use samplex serialization versions (SSV) 1 or 2.
      properties:
        ssv:
          maximum: 2
          minimum: 1
          title: Ssv
          type: integer
        samplex_json:
          description: A JSON string representing the samplex.
          title: Samplex Json
          type: string
      required:
      - ssv
      - samplex_json
      title: SamplexModelSSV1ToSSV2
      type: object
    JobCost:
      type: integer
      format: int32
      minimum: 0
      maximum: 10800
      description: Cost of the job as the estimated time it should take to complete (in seconds). Should not exceed the cost of the program. If the provided value exceeds the maximum, it will be capped at that value.
    BillingStatus:
      title: BillingStatus
      type: string
      description: Status of billing data completeness
      enum:
      - pending
      - complete
    ExecutorV02OptionsModel:
      description: Runtime options.
      properties:
        init_qubits:
          default: true
          description: Whether to reset the qubits to the ground state for each shot.
          title: Init Qubits
          type: boolean
        rep_delay:
          type: number
          nullable: true
          default: null
          description: 'The repetition delay.


            This is the delay between the end of one circuit and the start of the next within a shot loop.

            This is only supported on backends that have ``backend.dynamic_reprate_enabled=True``. It must

            be from the range supplied by ``backend.rep_delay_range``. When this value is ``None``, the

            default value ``backend.default_rep_delay`` is used.'
          title: Rep Delay
        scheduler_timing:
          default: false
          description: 'Whether to return circuit schedule timing of each provided quantum circuit.


            Setting this value to true will cause corresponding metadata of every program item to be

            populated in the returned data.'
          title: Scheduler Timing
          type: boolean
        stretch_values:
          default: false
          description: 'Whether to return numeric resolutions of stretches for each provided quantum circuit.


            Setting this value to true will cause corresponding metadata of every program item to be

            populated in the returned data.'
          title: Stretch Values
          type: boolean
        experimental:
          additionalProperties:
            $ref: '#/components/schemas/JsonValue'
          default: {}
          description: 'Experimental options.


            These options are not guaranteed to be stable and may change or be removed without notice.'
          title: Experimental
          type: object
      title: OptionsModel
      type: object
    JobCreateResponse:
      type: object
      properties:
        id:
          type: string
          description: Job ID
        backend:
          type: string
          description: Backend selected to run job
        session_id:
          type: string
          description: Id of the session associated with the job
        private:
          $ref: '#/components/schemas/Private'
        calibration_id:
          type: string
          description: The ID of the calibration used for the job
          pattern: ^.*$
          minLength: 1
          maxLength: 100
      description: Response when creating a job
      required:
      - id
      - backend
    JobRunParamsBase:
      title: ProgramParams
      type: object
      description: Parameters used to run a job
      properties:
        program_id:
          type: string
          description: ID of the program to be executed
          pattern: ^.*$
          minLength: 1
          maxLength: 10000
        backend:
          type: string
          description: Name that identifies the backend on which to run the program.
          pattern: ^.*$
          minLength: 1
          maxLength: 10000
        runtime:
          type: string
          description: Name and tag of the image to use when running a program (IBM Quantum channel users only). Should follow the pattern "name:tag".
          pattern: ^.*$
          minLength: 1
          maxLength: 10000
        tags:
          $ref: '#/components/schemas/Tags'
        log_level:
          type: string
          description: Logging level of the program
          enum:
          - critical
          - error
          - warning
          - info
          - debug
        cost:
          $ref: '#/components/schemas/JobCost'
        session_id:
          type: string
          description: Identifier of the session that the job is a part of
          pattern: ^.*$
          minLength: 1
          maxLength: 36
        calibration_id:
          type: string
          description: The ID of the calibration used for the job
          pattern: ^.*$
          minLength: 1
          maxLength: 100
      required:
      - program_id
      - backend
    ChunkSpan:
      description: "Timing information about a single chunk of execution.\n\n.. note::\n\n    This span may include some amount of non-circuit time."
      properties:
        start:
          description: The start time of the execution chunk in UTC.
          format: date-time
          title: Start
          type: string
        stop:
          description: The stop time of the execution chunk in UTC.
          format: date-time
          title: Stop
          type: string
        parts:
          description: A description of which parts of a quantum program are contained in this chunk.
          items:
            $ref: '#/components/schemas/ChunkPart'
          title: Parts
          type: array
      required:
      - start
      - stop
      - parts
      title: ChunkSpan
      type: object
    ExecutorV02SamplexItemModel:
      description: Execution specifications for a single quantum circuit.
      properties:
        item_type:
          enum:
          - samplex
          default: samplex
          description: The type of quantum program item.
          title: Item Type
          type: string
        circuit:
          $ref: '#/components/schemas/QpyModelV13ToV17'
        samplex:
          $ref: '#/components/schemas/SamplexModelSSV1ToSSV2'
        samplex_arguments:
          additionalProperties:
            anyOf:
            - type: boolean
            - type: integer
            - $ref: '#/components/schemas/PauliLindbladMapModel'
            - $ref: '#/components/schemas/TensorModel'
          description: Arguments to the samplex.
          title: Samplex Arguments
          type: object
        shape:
          description: 'The shape of this item.


            This shape must extend (via broadcasting) the implicit shape of the :attr:~samplex_arguments`.

            The non-trivial axes it introduces enumerate randomizations.'
          items:
            type: integer
          title: Shape
          type: array
        chunk_size:
          anyOf:
          - minimum: 1
            type: integer
          - enum:
            - auto
            type: string
          default: auto
          description: 'The maximum number circuit arguments to bind to the circuit per shot loop.


            When ``"auto"``, the number is chosen server-side with heuristics designed to optimize

            execution speed. A quantum program must have items where either all chunk sizes are

            integer-valued, or all chunk sizes are ``"auto"``. Integer values are only allowed inside of

            session exection mode.'
          title: Chunk Size
      required:
      - circuit
      - samplex
      - samplex_arguments
      - shape
      title: SamplexItemModel
      type: object
    Program:
      type: object
      description: Program associated with the job
      properties:
        id:
          type: string
          description: Identifier from the executed program
          pattern: ^.*$
          minLength: 1
          maxLength: 1000000
      required:
      - id
    QpyModelV13ToV17:
      description: QPY encoded circuits with restricted version range.
      properties:
        circuit_b64:
          description: Base-64 encoded data of the QPY serialization of a single quantum circuit.
          title: Circuit B64
          type: string
        qpy_version:
          maximum: 17
          minimum: 13
          title: Qpy Version
          type: integer
      required:
      - circuit_b64
      - qpy_version
      title: QpyModelV13ToV17
      type: object
    JobState:
      title: JobState
      type: object
      description: Current state of the job
      properties:
        status:
          type: string
          description: Current status of the job
          enum:
          - Queued
          - Running
          - Completed
          - Cancelled
          - Failed
        reason:
          type: string
          description: Reason for the current status
        reason_code:
          type: integer
          format: int32
          minimum: 1000
          maximum: 9999
          description: Reason code for the current status
        reason_solution:
          type: string
          description: Next steps user can take in case of failure
      required:
      - status
    ExecutorV01MetadataModel:
      description: Execution metadata.
      properties:
        chunk_timing:
          description: Timing information about all executed chunks of a quantum program.
          items:
            $ref: '#/components/schemas/ChunkSpan'
          title: Chunk Timing
          type: array
      required:
      - chunk_timing
      title: MetadataModel
      type: object
    NoiseLearnerV3V02LinbdbladResultMetadataModel:
      description: The metadata of a sin

# --- truncated at 32 KB (95 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/ibm-quantum/refs/heads/main/openapi/ibm-quantum-jobs-api-openapi.yml