D-Wave
D-Wave Solver API (SAPI) - Problems

Submit, monitor, retrieve, and cancel quantum and hybrid problem jobs. Supports the canonical problem types ising, qubo, bqm, cqm, dqm, and nl with three encoding formats (qp, bq, ref). Problems flow through PENDING > IN_PROGRESS > COMPLETED | FAILED | CANCELLED terminal states. Endpoints support blocking submit (single problem), batch async submit (multi-problem), short status polling, full-info retrieval, answer download (inline or binary-ref via SAPI-token), problem messages, and single/bulk cancel. Up to 1,000 problem IDs per status batch.
Documentation GitHub OpenAPI
OpenAPI Specification

openapi: 3.0.3
info:
  title: D-Wave Leap Hybrid Solvers Account Problems API
  version: '3.0'
  description: 'Leap Hybrid Solvers — quantum-classical hybrid samplers (BQM, CQM, DQM, NL) submitted

    via the standard SAPI Problems endpoint with `type=bqm|cqm|dqm|nl` and the matching

    hybrid solver name. This spec narrows the generic SAPI submit surface to the hybrid

    solver request/response shapes.

    '
  contact:
    name: D-Wave Quantum Inc.
    url: https://docs.dwavequantum.com/en/industrial_optimization/index_get_started.html
servers:
- url: https://cloud.dwavesys.com/sapi/v2
security:
- SapiToken: []
tags:
- name: Problems
paths:
  /problems/:
    get:
      operationId: listProblems
      summary: List Problems
      description: Retrieve a filtered list of submitted problems.
      tags:
      - Problems
      parameters:
      - in: query
        name: id
        schema:
          type: string
      - in: query
        name: label
        schema:
          type: string
      - in: query
        name: max_results
        schema:
          type: integer
          maximum: 1000
      - in: query
        name: status
        schema:
          $ref: '#/components/schemas/ProblemStatusEnum'
      - in: query
        name: solver
        schema:
          type: string
      - in: query
        name: timeout
        description: Long-poll timeout in seconds while problems remain non-terminal.
        schema:
          type: integer
      responses:
        '200':
          description: Problem statuses
          content:
            application/vnd.dwave.sapi.problems+json;version=3.0.0:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ProblemStatus'
    post:
      operationId: submitProblem
      summary: Submit Problem
      description: 'Blocking single-problem submit. Returns final status and answer if the problem

        completes within the (undisclosed) server time limit; otherwise returns the latest

        status. Compression supported on QPU problem payloads.

        '
      tags:
      - Problems
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProblemJob'
      responses:
        '200':
          description: Problem status (with answer if available) or submit error
          content:
            application/vnd.dwave.sapi.problems+json;version=3.0.0:
              schema:
                oneOf:
                - $ref: '#/components/schemas/ProblemStatusWithAnswer'
                - $ref: '#/components/schemas/ProblemSubmitError'
    delete:
      operationId: cancelProblems
      summary: Cancel Problems
      description: Cancel a list of problems by ID.
      tags:
      - Problems
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                type: string
      responses:
        '200':
          description: Per-problem cancel results
          content:
            application/vnd.dwave.sapi.problems+json;version=3.0.0:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ProblemStatus'
  /problems/{problem_id}:
    get:
      operationId: getProblem
      summary: Get Problem
      description: Retrieve problem short status and the answer if it is available.
      tags:
      - Problems
      parameters:
      - in: path
        name: problem_id
        required: true
        schema:
          type: string
      - in: query
        name: timeout
        schema:
          type: integer
      responses:
        '200':
          description: Status with optional answer
          content:
            application/vnd.dwave.sapi.problem+json;version=3.0.0:
              schema:
                $ref: '#/components/schemas/ProblemStatusWithAnswer'
    delete:
      operationId: cancelProblem
      summary: Cancel Problem
      description: Initiate cancel for a single problem.
      tags:
      - Problems
      parameters:
      - in: path
        name: problem_id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Cancel result
          content:
            application/vnd.dwave.sapi.problem+json;version=3.0.0:
              schema:
                $ref: '#/components/schemas/ProblemStatus'
  /problems/{problem_id}/info:
    get:
      operationId: getProblemInfo
      summary: Get Problem Info
      description: Retrieve complete problem info (submitted job + metadata).
      tags:
      - Problems
      parameters:
      - in: path
        name: problem_id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Problem info
          content:
            application/vnd.dwave.sapi.problem-data+json;version=3.0.0:
              schema:
                $ref: '#/components/schemas/ProblemInfo'
  /problems/{problem_id}/answer:
    get:
      operationId: getProblemAnswer
      summary: Get Problem Answer
      description: Retrieve the answer for a completed problem.
      tags:
      - Problems
      parameters:
      - in: path
        name: problem_id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Problem answer
          content:
            application/vnd.dwave.sapi.problem-answer+json;version=3.0.0:
              schema:
                $ref: '#/components/schemas/ProblemAnswer'
  /problems/{problem_id}/messages:
    get:
      operationId: getProblemMessages
      summary: Get Problem Messages
      description: Retrieve diagnostic / informational messages emitted while solving a problem.
      tags:
      - Problems
      parameters:
      - in: path
        name: problem_id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Message list
          content:
            application/vnd.dwave.sapi.problem-message+json;version=3.0.0:
              schema:
                type: array
                items:
                  type: object
                  additionalProperties: true
components:
  schemas:
    ProblemStatusWithAnswer:
      allOf:
      - $ref: '#/components/schemas/ProblemStatus'
      - type: object
        properties:
          answer:
            $ref: '#/components/schemas/ProblemAnswer'
    EncodingFormatEnum:
      type: string
      enum:
      - qp
      - bq
      - ref
    ProblemStatus:
      type: object
      properties:
        id:
          type: string
        type:
          $ref: '#/components/schemas/ProblemTypeEnum'
        solver:
          type: string
        submitted_on:
          type: string
          format: date-time
        status:
          $ref: '#/components/schemas/ProblemStatusEnum'
        label:
          type: string
        solved_on:
          type: string
          format: date-time
    ProblemJob:
      type: object
      required:
      - solver
      - type
      - data
      properties:
        solver:
          type: string
          example: hybrid_nonlinear_program_v1
        type:
          $ref: '#/components/schemas/ProblemTypeEnum'
        data:
          oneOf:
          - $ref: '#/components/schemas/ProblemData'
          - $ref: '#/components/schemas/ProblemDataRef'
        params:
          type: object
          additionalProperties: true
          description: Solver parameters (e.g. num_reads, time_limit, annealing_time, chain_strength).
        label:
          type: string
          maxLength: 1024
    ProblemData:
      type: object
      required:
      - format
      properties:
        format:
          $ref: '#/components/schemas/EncodingFormatEnum'
        lin:
          type: array
          items:
            type: number
        quad:
          type: array
          items:
            type: number
        offset:
          type: number
        data:
          type: string
          description: Base64-encoded binary payload (bq / nl formats).
    ProblemTypeEnum:
      type: string
      enum:
      - ising
      - qubo
      - bqm
      - cqm
      - dqm
      - nl
    ProblemInfo:
      type: object
      properties:
        id:
          type: string
        data:
          $ref: '#/components/schemas/ProblemData'
        params:
          type: object
          additionalProperties: true
        solver:
          type: string
        label:
          type: string
        submitted_on:
          type: string
          format: date-time
    ProblemStatusEnum:
      type: string
      enum:
      - PENDING
      - IN_PROGRESS
      - COMPLETED
      - FAILED
      - CANCELLED
    ProblemAnswer:
      type: object
      properties:
        format:
          $ref: '#/components/schemas/EncodingFormatEnum'
        active_variables:
          type: array
          items:
            type: integer
        energies:
          type: array
          items:
            type: number
        num_occurrences:
          type: array
          items:
            type: integer
        solutions:
          type: array
          items:
            type: array
            items:
              type: integer
        timing:
          type: object
          additionalProperties: true
        num_variables:
          type: integer
    ProblemDataRef:
      type: object
      required:
      - format
      - url
      - auth_method
      properties:
        format:
          type: string
          enum:
          - ref
        url:
          type: string
          format: uri
        auth_method:
          type: string
          enum:
          - sapi-token
    ProblemSubmitError:
      type: object
      properties:
        error_code:
          type: integer
        error_msg:
          type: string
  securitySchemes:
    SapiToken:
      type: apiKey
      in: header
      name: X-Auth-Token
D-Wave Solver API (SAPI) - Problems

Documentation

Specifications

Schemas & Data

Other Resources

OpenAPI Specification
