QBqbraid
Devices

List devices

Changed on

List quantum devices (simulators and QPUs) visible to the caller, with filtering, search, sorting, and pagination.

get/devices

Request

  • Base URL
    https://api-v2.qbraid.com/api/v1
  • URL
    https://api-v2.qbraid.com/api/v1/devices
  • Auth
    API key in header X-API-KEY

Query parameters

qrnstring

Device QRN (qBraid Resource Name)

Filter devices by QRN

vendor'aws' | 'azure' | 'ibm' | 'ionq' | 'qbraid'

Filter devices by vendor

providerIdstring

Provider ID to filter by

Filter devices by provider ID

deviceType'QPU' | 'SIMULATOR'

Filter by hardware type

Filter devices by hardware type

status'ONLINE' | 'UNAVAILABLE' | 'OFFLINE' | 'RETIRED'

Enumeration for representing various operational statuses of devices.

Attributes: ONLINE (str): Device is online and accepting jobs. UNAVAILABLE (str): Device is online but not accepting jobs. OFFLINE (str): Device is offline. RETIRED (str): Device has been retired and is no longer operational.

Filter devices by operational status

retiredboolean

Include or exclude retired devices

Include (true) or exclude (false) retired devices

privateboolean

Filter by device visibility

Filter by visibility — true for private, false for public

verifiedboolean

Filter by device verification status

directAccessboolean

Filter by direct access availability

Filter devices by direct access availability

searchstring

Search keyword

Search devices by name, description, or about (1–255 characters)

sortBy'name' | 'vendor' | 'deviceType' | 'status' | 'numberQubits' | 'createdAt' | 'updatedAt'

Field to sort by

Field to sort devices by

sortOrder'asc' | 'desc'

Sort order direction

Sort order direction (default: asc)

pageinteger

Page number (1-indexed)

Page number (1-indexed, default: 1)

limitinteger

Number of items per page

Number of items per page (1–100, default: 20)

Response

Success.

successboolean required

Example response

{
  "data": [
    {
      "pricing": {
        "perTask": 10,
        "perShot": 10,
        "perMinute": 10
      }
    }
  ]
}

Changes

  • 20848d926124Revision changes
    • info

      api operation id get_all_devices_devices_get removed and replaced with listDevices

    • info

      api tag Devices added

    • info

      api tag devices removed

    • info

      added the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status