Get Devices

GET

/api/v2/devices

curl --request GET \
  --url 'https://example.com/api/v2/devices?order_by=created_at&order_by_direction=ASC&limit=100&offset=0' \
  --header 'Authorization: Bearer <token>'

Retrieve the list of devices accessible to the authenticated user.

Returns both QPU and emulator devices. Use query parameters to filter by device type, availability, or public visibility. Results include each device's current status, supported features, and specifications.

Authorizations

• HTTPBearer

Parameters

Query Parameters

order_by

Order By

string

default: created_at

order_by_direction

SortDirection

string

default: DESC

Allowed values: ASC DESC

limit

Limit

integer

default: 100 > 0 < 101

offset

Offset

integer

0

device_type

Any of:

Array<string>

Array<string>

Allowed values: EMU_FREE EMU_SV EMU_TN EMU_C FRESNEL FRESNEL_CAN1 FRESNEL_SA1 FRESNEL8 EMU_FRESNEL FRESNEL_RD EMU_MPS

null

null

Filter devices by type. Omit to skip filter.

availability

Any of:

Array<string>

Array<string>

Allowed values: ACTIVE INACTIVE RETIRED

null

null

Filter devices by availability status. Omit to skip filter.

public

Any of:

boolean

boolean

null

null

Filter devices by public visibility. Omit to skip filter.

Responses

200

Successful Response

Media typeapplication/json

HeaderPaginatedResponse[ProducedDeviceResponse]

object

status

JSendStatus

string

default: success

Allowed values: success fail error

message

Message

string

default: OK.

code

Code

string

default: 200

data

required

Data

Array<object>

ProducedDeviceResponse

Device visible to the authenticated user.

object

id

required

Id

Unique identifier for the device.

string format: uuid

name

required

Name

Deprecated. Same value as device_type.

string

device_type

required

Device Type

Type identifier of the device (e.g. FRESNEL).

string

status

required

DeviceStatus

Current operational status of the device.

string

Allowed values: UP DOWN

average_queue_time

required

Average Queue Time

Average wait time (seconds) before a job of this device type is processed, measured over the last hour.

integer

max_atom_num

Any of:

integer

integer

null

null

is_emulator

required

Is Emulator

Whether the device is an emulator.

boolean

channels

Any of:

Array<string>

Array<string>

null

null

status_message

Any of:

string

string

null

null

allowed_result_types

required

Allowed Result Types

Result types the device can produce.

Array<string>

Allowed values: counter run sample expectation

default_result_types

required

Default Result Types

Result types the device uses by default when none are specified.

Array<string>

Allowed values: counter run sample expectation

active

required

Active

Deprecated. Use availability instead.

boolean

description

Any of:

string

string

null

null

bill_usage

required

Bill Usage

Whether usage of this device is billed.

boolean

availability

required

DeviceAvailability

Availability status of the device.

string

Allowed values: ACTIVE INACTIVE RETIRED

has_execution_logs

required

Has Execution Logs

Whether the device provides execution logs.

boolean

pagination

required

JSendPagination

Pagination information

object

total

required

Total

integer

start

required

Start

integer

end

required

End

integer

Example

{
  "status": "success",
  "message": "OK.",
  "code": "200",
  "data": [
    {
      "active": true,
      "allowed_result_types": [
        "counter",
        "run"
      ],
      "availability": "ACTIVE",
      "average_queue_time": 42,
      "bill_usage": true,
      "channels": [
        "rydberg_global",
        "rydberg_local"
      ],
      "default_result_types": [
        "counter"
      ],
      "description": "Fresnel QPU",
      "device_type": "FRESNEL",
      "has_execution_logs": false,
      "id": "00000000-0000-0000-0000-000000000010",
      "is_emulator": false,
      "max_atom_num": 100,
      "name": "FRESNEL",
      "status": "UP"
    }
  ]
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}