START NOW
Devices

Get Device

GET/devices/{device_qrn}

Retrieve a device by its device QRN.

Args:

  • device_qrn (string): Device QRN (qBraid Resource Name)

Returns:

  • RuntimeDevice object containing the device details

Raises:

  • 422: Validation error if the device_qrn parameter is invalid

Authorizations

X-API-KEYstringheaderrequired

Authenticate requests using an API key linked to your qBraid account. Obtain your key by registering or logging in at account.qbraid.com.

Path Parameters

device_qrnstringrequired

Device QRN (qBraid Resource Name)

Response

200Successful Response
successbooleanrequired
dataobjectrequired

Schema for device response

422Validation Error
GET/devices/{device_qrn}
curl --request GET \
  --url https://api-v2.qbraid.com/api/v1/devices/%3Cdevice_qrn%3E \
  --header 'X-API-KEY: <api-key>'
import requests

url = "https://api-v2.qbraid.com/api/v1/devices/%3Cdevice_qrn%3E"
headers = {
    "X-API-KEY": "<api-key>"
}

response = requests.get(url, headers=headers)
print(response.json())
const url = "https://api-v2.qbraid.com/api/v1/devices/%3Cdevice_qrn%3E";
const options = {
  method: "GET",
  headers: {"X-API-KEY":"<api-key>"},
};

const response = await fetch(url, options);
console.log(await response.json());
{
  "success": true,
  "data": {
    "name": "<string>",
    "qrn": "<string>",
    "vendor": "aws",
    "deviceType": "SIMULATOR",
    "runInputTypes": [
      "<string>"
    ],
    "status": "ONLINE",
    "statusMsg": "<string>",
    "nextAvailable": "2024-01-01T00:00:00Z",
    "queueDepth": 123,
    "avgQueueTime": 123,
    "numberQubits": 123,
    "paradigm": "gate_model",
    "modality": "<string>",
    "noiseModels": [
      "<string>"
    ],
    "pricingModel": "fixed",
    "pricing": {
      "perTask": 10,
      "perShot": 10,
      "perMinute": 10
    },
    "directAccess": true
  }
}
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}