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 QuantumTasks API

Submit and manage quantum task executions on Amazon Braket devices.

AWS Braket QuantumTasks 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 3 JSON Schema definitions.

Tagged areas include QuantumTasks. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 3 JSON Schemas.

This API exposes 4 operations across 4 paths, and defines 5 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.

4 operations 4 paths 5 schemas 1 GET2 POST1 PUT

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 QuantumTasks 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 4

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

QuantumTasks 4

Submit and manage quantum task executions on Amazon Braket devices.

POST
/quantum-task
AWS Braket Create A Quantum Task
createQuantumTask body → 201400403410424402429500
GET
/quantum-task/{quantumTaskArn}
AWS Braket Get A Quantum Task
getQuantumTask 1 param → 200400403404429500
PUT
/quantum-task/{quantumTaskArn}/cancel
AWS Braket Cancel A Quantum Task
cancelQuantumTask 1 param body → 200400403404409429500
POST
/quantum-tasks
AWS Braket Search Quantum Tasks
searchQuantumTasks body → 200

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are QuantumTask (13 properties), CreateQuantumTaskRequest (11 properties), QuantumTaskSummary (9 properties), SearchQuantumTasksFilter (3 properties). Each schema is shown below with its type and property counts.

CreateQuantumTaskRequest
object
11 properties 6 required
SearchQuantumTasksFilter
object
3 properties 3 required
QuantumTask
object
13 properties
QuantumTaskSummary
object
9 properties
CreateQuantumTaskResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs AWS Braket publishes across the network.

AWS Braket Devices API
AWS Braket Tags API
AWS Braket HybridJobs API
AWS Braket SpendingLimits API