Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

AWS Braket Devices API

Discover the QPU and simulator devices available on Amazon Braket. Returns device ARN, provider (AQT, IonQ, IQM, QuEra, Rigetti, Amazon), status (ONLINE/OFFLINE/RETIRED), queue depth, paradigm (gate-based or AHS), native gate set, and topology via deviceCapabilities.

AWS Braket Devices API is one of 5 APIs that AWS Braket publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Quantum Computing, Devices, QPU, and Simulator. The published artifact set on APIs.io includes API documentation, an OpenAPI specification, and 1 JSON Schema.

This API exposes 2 operations across 2 paths, and defines 3 schemas. It is described by OpenAPI 3.1.0, at version 2019-09-01.

Requests are made against 3 base URLs: https://braket.us-east-1.amazonaws.com, https://braket.us-west-2.amazonaws.com, https://braket.eu-north-1.amazonaws.com.

2 operations 2 paths 3 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2019-09-01
Servers
https://braket.us-east-1.amazonaws.com
https://braket.us-west-2.amazonaws.com
https://braket.eu-north-1.amazonaws.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

AWS Braket Devices API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (SigV4). By default, every request must be authenticated.

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Devices 2

Quantum devices (QPUs and simulators).

GET
/device/{deviceArn}
AWS Braket Get A Device
getDevice 1 param → 200400403404429500
POST
/devices
AWS Braket Search Devices
searchDevices body → 200

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are Device (7 properties), DeviceSummary (5 properties), SearchDevicesFilter (2 properties). Each schema is shown below with its type and property counts.

Device
object
7 properties
SearchDevicesFilter
object
2 properties 2 required
DeviceSummary
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

aws-braket-devices-api-openapi.yml Raw ↑

Other APIs AWS Braket publishes across the network.

AWS Braket Tags API
AWS Braket HybridJobs API
AWS Braket QuantumTasks API
AWS Braket SpendingLimits API