POST

/quantum-task

http://braket.{region}.amazonaws.com/quantum-task

Creates a quantum task.

Access Token Required: API Key

Body Params

tagsobject

Tags to be added to the quantum task you're creating.

shotsintegerrequired

The number of shots to use for the task.

actionstringrequired

The action associated with the task.

jobTokenstring

The token for an Amazon Braket job that associates it with the quantum task.

deviceArnstringrequired

The ARN of the device to run the task on.

clientTokenstringrequired

The client token associated with the request.

outputS3Bucketstringrequired

The S3 bucket to store task result files in.

deviceParametersstring

The parameters for the device to run the task on.

outputS3KeyPrefixstringrequired

The key prefix for the location in the S3 bucket to store task results in.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://braket.{region}.amazonaws.com/quantum-task' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}