Amazon Braket Quantum Tasks API

Submit and manage quantum tasks on QPUs and simulators

GitHub OpenAPI

Operations 4

POST /quantum-task Create Quantum Task #
GET /quantum-task/{quantumTaskArn} Get Quantum Task #
POST /quantum-tasks Search Quantum Tasks #
PUT /quantum-task/{quantumTaskArn}/cancel Cancel Quantum Task #

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-quantum-tasks-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-quantum-tasks-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Braket Quantum Tasks API
  version: '2019-09-01'
  description: Generated from AWS's published Smithy model for Braket. 4 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:
  /quantum-task:
    post:
      operationId: CreateQuantumTask
      summary: Create Quantum Task
      description: Creates a quantum task.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateQuantumTaskResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '424':
          description: DeviceOfflineException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeviceOfflineException'
        '410':
          description: DeviceRetiredException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeviceRetiredException'
        '500':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '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/CreateQuantumTaskRequest'
      tags:
      - Quantum Tasks
  /quantum-task/{quantumTaskArn}:
    get:
      operationId: GetQuantumTask
      summary: Get Quantum Task
      description: Retrieves the specified quantum task.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetQuantumTaskResponse'
        '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/GetQuantumTaskRequest'
      tags:
      - Quantum Tasks
  /quantum-tasks:
    post:
      operationId: SearchQuantumTasks
      summary: Search Quantum Tasks
      description: Searches for tasks that match the specified filter values.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchQuantumTasksResponse'
        '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/SearchQuantumTasksRequest'
      tags:
      - Quantum Tasks
  /quantum-task/{quantumTaskArn}/cancel:
    put:
      operationId: CancelQuantumTask
      summary: Cancel Quantum Task
      description: Cancels the specified task.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelQuantumTaskResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '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/CancelQuantumTaskRequest'
      tags:
      - Quantum Tasks
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
    ActionMetadata:
      type: object
      properties:
        actionType:
          type: string
          description: The type of action associated with the quantum task.
        programCount:
          type: integer
          description: The number of programs in a program set. This is only available for a program set.
        executableCount:
          type: integer
          description: The number of executables in a program set. This is only available for a program set.
      required:
      - actionType
    Association:
      type: object
      properties:
        arn:
          type: string
          description: The Amazon Braket resource arn.
        type:
          type: string
          description: The association type for the specified Amazon Braket resource arn.
      required:
      - arn
      - type
    CancelQuantumTaskRequest:
      type: object
      properties:
        quantumTaskArn:
          type: string
          description: The ARN of the quantum task to cancel.
        clientToken:
          type: string
          description: The client token associated with the cancellation request.
      required:
      - quantumTaskArn
      - clientToken
    CancelQuantumTaskResponse:
      type: object
      properties:
        quantumTaskArn:
          type: string
          description: The ARN of the quantum task.
        cancellationStatus:
          type: string
          description: The status of the quantum task.
      required:
      - quantumTaskArn
      - cancellationStatus
    ConflictException:
      type: object
      properties:
        message:
          type: string
    CreateQuantumTaskRequest:
      type: object
      properties:
        clientToken:
          type: string
          description: The client token associated with the request.
        deviceArn:
          type: string
          description: The ARN of the device to run the quantum task on.
        deviceParameters:
          type: string
          description: The parameters for the device to run the quantum task on.
        shots:
          type: integer
          description: The number of shots to use for the quantum task.
        outputS3Bucket:
          type: string
          description: The S3 bucket to store quantum task result files in.
        outputS3KeyPrefix:
          type: string
          description: The key prefix for the location in the S3 bucket to store quantum task results in.
        action:
          type: string
          description: The action associated with the quantum task.
        tags:
          type: object
          additionalProperties:
            type: string
          description: Tags to be added to the quantum task you're creating.
        jobToken:
          type: string
          description: The token for an Amazon Braket hybrid job that associates it with the quantum task.
        associations:
          type: array
          items:
            $ref: '#/components/schemas/Association'
          description: The list of Amazon Braket resources associated with the quantum task.
        experimentalCapabilities:
          $ref: '#/components/schemas/ExperimentalCapabilities'
      required:
      - clientToken
      - deviceArn
      - shots
      - outputS3Bucket
      - outputS3KeyPrefix
      - action
    CreateQuantumTaskResponse:
      type: object
      properties:
        quantumTaskArn:
          type: string
          description: The ARN of the quantum task created by the request.
      required:
      - quantumTaskArn
    DeviceOfflineException:
      type: object
      properties:
        message:
          type: string
    DeviceRetiredException:
      type: object
      properties:
        message:
          type: string
    ExperimentalCapabilities:
      type: object
      properties:
        enabled:
          type: string
          description: Enabled experimental capabilities.
      description: Exactly one member is set.
    GetQuantumTaskRequest:
      type: object
      properties:
        quantumTaskArn:
          type: string
          description: The ARN of the quantum task to retrieve.
        additionalAttributeNames:
          type: array
          items:
            type: string
          description: A list of attributes to return additional information for. Only the QueueInfo additional attribute
            name is currently supported.
      required:
      - quantumTaskArn
    GetQuantumTaskResponse:
      type: object
      properties:
        quantumTaskArn:
          type: string
          description: The ARN of the quantum task.
        status:
          type: string
          description: The status of the quantum task.
        failureReason:
          type: string
          description: The reason that a quantum task failed.
        deviceArn:
          type: string
          description: The ARN of the device the quantum task was run on.
        deviceParameters:
          type: string
          description: The parameters for the device on which the quantum task ran.
        shots:
          type: integer
          description: The number of shots used in the quantum task.
        outputS3Bucket:
          type: string
          description: The S3 bucket where quantum task results are stored.
        outputS3Directory:
          type: string
          description: The folder in the S3 bucket where quantum task results are stored.
        createdAt:
          type: string
          description: The time at which the quantum task was created.
        endedAt:
          type: string
          description: The time at which the quantum task ended.
        tags:
          type: object
          additionalProperties:
            type: string
          description: The tags that belong to this quantum task.
        jobArn:
          type: string
          description: The ARN of the Amazon Braket job associated with the quantum task.
        queueInfo:
          $ref: '#/components/schemas/QuantumTaskQueueInfo'
        associations:
          type: array
          items:
            $ref: '#/components/schemas/Association'
          description: The list of Amazon Braket resources associated with the quantum task.
        numSuccessfulShots:
          type: integer
          description: The number of successful shots for the quantum task. This is available after a successfully completed
            quantum task.
        actionMetadata:
          $ref: '#/components/schemas/ActionMetadata'
        experimentalCapabilities:
          $ref: '#/components/schemas/ExperimentalCapabilities'
      required:
      - quantumTaskArn
      - status
      - deviceArn
      - deviceParameters
      - shots
      - outputS3Bucket
      - outputS3Directory
      - createdAt
    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
    QuantumTaskQueueInfo:
      type: object
      properties:
        queue:
          type: string
          description: The name of the queue.
        position:
          type: string
          description: Current position of the quantum task in the quantum tasks queue.
        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.
        message:
          type: string
          description: Optional. Provides more information about the queue position. For example, if the quantum task is complete
            and no longer in the queue, the message field contains that information.
      required:
      - queue
      - position
    QuantumTaskSummary:
      type: object
      properties:
        quantumTaskArn:
          type: string
          description: The ARN of the quantum task.
        status:
          type: string
          description: The status of the quantum task.
        deviceArn:
          type: string
          description: The ARN of the device the quantum task ran on.
        shots:
          type: integer
          description: The shots used for the quantum task.
        outputS3Bucket:
          type: string
          description: The S3 bucket where the quantum task result file is stored.
        outputS3Directory:
          type: string
          description: The folder in the S3 bucket where the quantum task result file is stored.
        createdAt:
          type: string
          description: The time at which the quantum task was created.
        endedAt:
          type: string
          description: The time at which the quantum task finished.
        tags:
          type: object
          additionalProperties:
            type: string
          description: Displays the key, value pairs of tags associated with this quantum task.
      required:
      - quantumTaskArn
      - status
      - deviceArn
      - shots
      - outputS3Bucket
      - outputS3Directory
      - createdAt
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
    SearchQuantumTasksFilter:
      type: object
      properties:
        name:
          type: string
          description: The name of the quantum task parameter to filter based on. Filter name can be either quantumTaskArn,
            deviceArn, jobArn, status or createdAt.
        values:
          type: array
          items:
            type: string
          description: The values used to filter quantum tasks based on the filter name and operator.
        operator:
          type: string
          description: An operator to use for the filter.
      required:
      - name
      - values
      - operator
    SearchQuantumTasksRequest:
      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: Maximum number of results to return in the response.
        filters:
          type: array
          items:
            $ref: '#/components/schemas/SearchQuantumTasksFilter'
          description: Array of SearchQuantumTasksFilter objects to use when searching for quantum tasks.
      required:
      - filters
    SearchQuantumTasksResponse:
      type: object
      properties:
        quantumTasks:
          type: array
          items:
            $ref: '#/components/schemas/QuantumTaskSummary'
          description: An array of QuantumTaskSummary objects for quantum tasks that match the specified filters.
        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:
      - quantumTasks
    ServiceQuotaExceededException:
      type: object
      properties:
        message:
          type: string
    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)