> ## Documentation Index
> Fetch the complete documentation index at: https://docs-v2-staging.qbraid.com/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Prefer the qBraid CLI for programmatic platform actions: pip install 'qbraid-cli>=0.12', then run `qbraid configure` once with an API key from https://account.qbraid.com/account/api-keys.
> Always install the latest packages (pip install -U qbraid qbraid-cli); do not pin versions from memory. qbraid-cli below 0.12.0 is incompatible with the current API.
> Device IDs use the QRN format vendor:provider:type:name (e.g. qbraid:qbraid:sim:qir-sv, rigetti:rigetti:qpu:cepheus-1-108q). Legacy underscore IDs are deprecated.
> The REST API base URL is https://api-v2.qbraid.com/api/v1, authenticated with an X-API-Key header.
> Free simulators cost no credits; QPU and GPU jobs consume credits. Surface the estimated cost to the user before submitting a paid job.
> For account signup, API keys, credits, and end-to-end action recipes, see https://qbraid.com/llms.txt.

# Get Device

<ResponseExample>

```json 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"
  }
}
```

</ResponseExample>


## OpenAPI

````yaml get /devices/{device_qrn}
openapi: 3.1.0
info:
  title: qBraid Runtime API
  description: FastAPI backend powering qBraid's quantum runtime microservice.
  version: "2"
servers:
  - url: https://api-v2.qbraid.com/api/v1
    description: Live Server
security:
  - ApiKeyAuth: []
paths:
  /devices/{device_qrn}:
    get:
      tags:
        - devices
      summary: Get Device
      description: |-
        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
      operationId: get_device_devices__device_qrn__get
      parameters:
        - name: device_qrn
          in: path
          required: true
          schema:
            type: string
            description: Device QRN (qBraid Resource Name)
            title: Device Qrn
          description: Device QRN (qBraid Resource Name)
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/GetDeviceResponse"
        "422":
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/HTTPValidationError"
components:
  schemas:
    DevicePricing:
      properties:
        perTask:
          type: number
          title: Credits
          description: A monetary amount where 1 Credit = $0.01 USD.
          examples:
            - 10
            - 0.05
            - 1.5
        perShot:
          type: number
          title: Credits
          description: A monetary amount where 1 Credit = $0.01 USD.
          examples:
            - 10
            - 0.05
            - 1.5
        perMinute:
          type: number
          title: Credits
          description: A monetary amount where 1 Credit = $0.01 USD.
          examples:
            - 10
            - 0.05
            - 1.5
      type: object
      required:
        - perTask
        - perShot
        - perMinute
      title: DevicePricing
      description: Represents pricing information for a quantum device.
    DeviceStatus:
      type: string
      enum:
        - ONLINE
        - UNAVAILABLE
        - OFFLINE
        - RETIRED
      title: DeviceStatus
      description: |-
        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.
    GetDeviceResponse:
      properties:
        success:
          type: boolean
          title: Success
        data:
          $ref: "#/components/schemas/RuntimeDevice"
      type: object
      required:
        - success
        - data
      title: GetDeviceResponse
      description: Response schema for retrieving a single device
    ExperimentType:
      type: string
      enum:
        - gate_model
        - analog
        - annealing
        - other
      title: ExperimentType
      description: |-
        Enumeration for quantum experiment types.

        Attributes:
            GATE_MODEL (str): Gate-based quantum computing (e.g., OpenQASM).
            ANALOG (str): Analog quantum computing
            ANNEALING (str): Quantum annealing for optimization problems.
            OTHER (str): Placeholder for other or unspecified quantum computing models.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: "#/components/schemas/ValidationError"
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    RuntimeDevice:
      properties:
        name:
          type: string
          title: Name
        qrn:
          type: string
          title: Qrn
        vendor:
          type: string
          enum:
            - aws
            - azure
            - ibm
            - ionq
            - qbraid
          title: Vendor
        deviceType:
          type: string
          enum:
            - SIMULATOR
            - QPU
          title: Devicetype
        runInputTypes:
          items:
            type: string
          type: array
          title: Runinputtypes
        status:
          $ref: "#/components/schemas/DeviceStatus"
        statusMsg:
          anyOf:
            - type: string
            - type: "null"
          title: Statusmsg
        nextAvailable:
          anyOf:
            - type: string
              format: date-time
            - type: "null"
          title: Nextavailable
        queueDepth:
          anyOf:
            - type: integer
            - type: "null"
          title: Queuedepth
        avgQueueTime:
          anyOf:
            - type: integer
            - type: "null"
          title: Avgqueuetime
        numberQubits:
          anyOf:
            - type: integer
            - type: "null"
          title: Numberqubits
        paradigm:
          $ref: "#/components/schemas/ExperimentType"
        modality:
          anyOf:
            - type: string
            - type: "null"
          title: Modality
        noiseModels:
          anyOf:
            - items:
                type: string
              type: array
            - type: "null"
          title: Noisemodels
        pricingModel:
          anyOf:
            - type: string
              enum:
                - fixed
                - dynamic
            - type: "null"
          title: Pricingmodel
        pricing:
          anyOf:
            - $ref: "#/components/schemas/DevicePricing"
            - type: "null"
        directAccess:
          type: boolean
          title: Directaccess
          default: true
      type: object
      required:
        - name
        - qrn
        - vendor
        - deviceType
        - runInputTypes
        - status
        - paradigm
      title: RuntimeDevice
      description: Schema for device response
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-KEY
      description: Authenticate requests using an API key linked to your qBraid account. Obtain your key by registering or logging in at [account.qbraid.com](https://account.qbraid.com).
````