Amazon Braket Devices API

Discover and retrieve details about quantum devices

GitHub OpenAPI

Operations 2

GET /device/{deviceArn} Get Device #
POST /devices Search Devices #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-braket:amazon-braket-devices-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

amazon-braket-devices-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Braket Devices API
  version: '2019-09-01'
  description: Generated from AWS's published Smithy model for Braket. 2 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://braket.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /device/{deviceArn}:
    get:
      operationId: GetDevice
      summary: Get Device
      description: Retrieves the devices available in Amazon Braket. For backwards compatibility with older versions of BraketSchemas,
        OpenQASM information is omitted from GetDevice API calls. To get this information the user-agent needs to present
        a recent version of the BraketSchemas (1.8.0 or later). The Braket SDK automatically reports this for you. If you
        do not see OpenQASM results in the GetDevice response when using a Braket SDK, you may need to set AWS_EXECUTION_ENV
        environment variable to configure user-agent. See the code examples provided below for how to do this for the AWS
        CLI, Boto3, and the Go, Java, and JavaScript/TypeScript SDKs.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetDeviceResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetDeviceRequest'
      tags:
      - Devices
  /devices:
    post:
      operationId: SearchDevices
      summary: Search Devices
      description: Searches for devices using the specified filters.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchDevicesResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchDevicesRequest'
      tags:
      - Devices
components:
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
        request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: braket
  schemas:
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
    DeviceQueueInfo:
      type: object
      properties:
        queue:
          type: string
          description: The name of the queue.
        queueSize:
          type: string
          description: The number of hybrid jobs or quantum tasks in the queue for a given device.
        queuePriority:
          type: string
          description: Optional. Specifies the priority of the queue. Quantum tasks in a priority queue are processed before
            the quantum tasks in a normal queue.
      required:
      - queue
      - queueSize
    DeviceSummary:
      type: object
      properties:
        deviceArn:
          type: string
          description: The ARN of the device.
        deviceName:
          type: string
          description: The name of the device.
        providerName:
          type: string
          description: The provider of the device.
        deviceType:
          type: string
          description: The type of the device.
        deviceStatus:
          type: string
          description: The status of the device.
      required:
      - deviceArn
      - deviceName
      - providerName
      - deviceType
      - deviceStatus
    GetDeviceRequest:
      type: object
      properties:
        deviceArn:
          type: string
          description: The ARN of the device to retrieve.
      required:
      - deviceArn
    GetDeviceResponse:
      type: object
      properties:
        deviceArn:
          type: string
          description: The ARN of the device.
        deviceName:
          type: string
          description: The name of the device.
        providerName:
          type: string
          description: The name of the partner company for the device.
        deviceType:
          type: string
          description: The type of the device.
        deviceStatus:
          type: string
          description: The status of the device.
        deviceCapabilities:
          type: string
          description: Details about the capabilities of the device.
        deviceQueueInfo:
          type: array
          items:
            $ref: '#/components/schemas/DeviceQueueInfo'
          description: The number of quantum tasks and hybrid jobs currently queued on the device.
      required:
      - deviceArn
      - deviceName
      - providerName
      - deviceType
      - deviceStatus
      - deviceCapabilities
    InternalServiceException:
      type: object
      properties:
        message:
          type: string
    ProgramSetValidationFailure:
      type: object
      properties:
        programIndex:
          type: integer
          description: The index of the program within the program set that failed validation.
        inputsIndex:
          type: integer
          description: The index of the input within the program set that failed validation.
        errors:
          type: array
          items:
            type: string
          description: A list of error messages describing the validation failures that occurred.
      required:
      - programIndex
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
    SearchDevicesFilter:
      type: object
      properties:
        name:
          type: string
          description: The name of the device parameter to filter based on. Only deviceArn filter name is currently supported.
        values:
          type: array
          items:
            type: string
          description: The values used to filter devices based on the filter name.
      required:
      - name
      - values
    SearchDevicesRequest:
      type: object
      properties:
        nextToken:
          type: string
          description: A token used for pagination of results returned in the response. Use the token returned from the previous
            request to continue search where the previous request ended.
        maxResults:
          type: integer
          description: The maximum number of results to return in the response.
        filters:
          type: array
          items:
            $ref: '#/components/schemas/SearchDevicesFilter'
          description: Array of SearchDevicesFilter objects to use when searching for devices.
      required:
      - filters
    SearchDevicesResponse:
      type: object
      properties:
        devices:
          type: array
          items:
            $ref: '#/components/schemas/DeviceSummary'
          description: An array of DeviceSummary objects for devices that match the specified filter values.
        nextToken:
          type: string
          description: A token used for pagination of results, or null if there are no additional results. Use the token value
            in a subsequent request to continue search where the previous request ended.
      required:
      - devices
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
    ValidationException:
      type: object
      properties:
        message:
          type: string
        reason:
          type: string
          description: The reason for validation failure.
        programSetValidationFailures:
          type: array
          items:
            $ref: '#/components/schemas/ProgramSetValidationFailure'
          description: The validation failures in the program set submitted in the request.
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/braket/service/2019-09-01/braket-2019-09-01.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)