Sign in

v1

latestOpenAPI 3.1.02026-07-26102230.9 KB
devices

Get All Devices

Retrieve a list of quantum devices available to the authenticated user.

Query Parameters:

  • qrn (string, optional): Filter by device QRN
  • vendor (string, optional): Filter by vendor
  • providerId (string, optional): Filter by provider ID
  • deviceType (string, optional): Filter by device type (QPU or SIMULATOR)
  • status (string, optional): Filter by operational status
  • retired (boolean, optional): Include or exclude retired devices
  • private (boolean, optional): Filter by visibility (true = private, false = public)
  • verified (boolean, optional): Filter by verification status
  • directAccess (boolean, optional): Filter by direct access availability
  • search (string, optional): Search by name, description, or about (1–255 characters)
  • sortBy (string, optional): Field to sort by
  • sortOrder (string, optional): Sort direction (asc or desc)
  • page (integer, optional): Page number (default: 1)
  • limit (integer, optional): Items per page, max 100 (default: 20)

Returns:

  • Array of RuntimeDevice objects containing device specifications and pricing information

Raises:

  • 401: Authentication required
  • 422: Validation error if query parameters are invalid
get/devices

Query parameters

qrnstring

Device QRN (qBraid Resource Name)

Filter devices by QRN

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

Filter devices by vendor

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' | 'OFFLINE' | 'RETIRED' | 'UNAVAILABLE'

Filter by operational status

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

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

Successful Response

successboolean required

Example response

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