Get Device

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

GET /devices/{device_qrn}

Get Device

cURL

curl --request GET \
  --url https://api-v2.qbraid.com/api/v1/devices/{device_qrn} \
  --header 'X-API-KEY: <api-key>'

import requests

url = "https://api-v2.qbraid.com/api/v1/devices/{device_qrn}"

headers = {"X-API-KEY": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};

fetch('https://api-v2.qbraid.com/api/v1/devices/{device_qrn}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-v2.qbraid.com/api/v1/devices/{device_qrn}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-v2.qbraid.com/api/v1/devices/{device_qrn}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-KEY", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api-v2.qbraid.com/api/v1/devices/{device_qrn}")
  .header("X-API-KEY", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-v2.qbraid.com/api/v1/devices/{device_qrn}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "success": true,
  "data": {
    "runInputTypes": ["pyqir", "qasm3"],
    "numberQubits": 64,
    "noiseModels": [],
    "statusMsg": null,
    "nextAvailable": null,
    "avgQueueTime": null,
    "qrn": "qbraid:qbraid:sim:qir-sv",
    "modality": null,
    "name": "QIR Simulator",
    "paradigm": "gate_model",
    "pricing": {
      "perTask": 0,
      "perShot": 0,
      "perMinute": 0
    },
    "status": "ONLINE",
    "vendor": "qbraid",
    "description": "Sparse state vector simulator using QIR compiler. Free of cost.",
    "deviceType": "SIMULATOR",
    "queueDepth": 0,
    "directAccess": true,
    "pricingModel": "fixed"
  }
}

200

{
  "success": true,
  "data": {
    "runInputTypes": ["pyqir", "qasm3"],
    "numberQubits": 64,
    "noiseModels": [],
    "statusMsg": null,
    "nextAvailable": null,
    "avgQueueTime": null,
    "qrn": "qbraid:qbraid:sim:qir-sv",
    "modality": null,
    "name": "QIR Simulator",
    "paradigm": "gate_model",
    "pricing": {
      "perTask": 0,
      "perShot": 0,
      "perMinute": 0
    },
    "status": "ONLINE",
    "vendor": "qbraid",
    "description": "Sparse state vector simulator using QIR compiler. Free of cost.",
    "deviceType": "SIMULATOR",
    "queueDepth": 0,
    "directAccess": true,
    "pricingModel": "fixed"
  }
}

Authorizations

X-API-KEY · string · header · required

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_qrn · string · required

Device QRN (qBraid Resource Name)

Response

200

application/json

Successful Response

Response schema for retrieving a single device

success · boolean · required

data · RuntimeDevice · object · required

Schema for device response

Show child attributes