Skip to content

Results are limited to the current section: Cloud services

Product news

Create Batch

POST
/api/v1/batches
curl --request POST \
--url https://example.com/api/v1/batches \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "device_type": "FRESNEL", "jobs": [ { "runs": 100, "variables": { "omega": 5 } } ], "project_id": "00000000-0000-0000-0000-000000000001", "sequence_builder": "<serialized Pulser sequence (sequence.to_abstract_repr())>" }'

Create a new batch to submit quantum computing jobs.

The authenticated user must be a member of the target project. The project will be billed for all jobs in the batch.

A batch groups one or more jobs sharing the same target device. The pulse sequence can be defined once at the batch level (sequence_builder) or individually per job (jobs[].sequence). The batch-level sequence can be parametrized: each job then provides its own variable bindings via variables instead of a full sequence.

Required fields:

  • project_id — the project that will be billed.
  • At least one job in jobs, unless the batch is left open (complete=false) for jobs to be added later.

Optional fields:

  • device_type — when omitted, inferred from the device embedded in the sequence. Use GET /api/v2/devices to discover available devices (includes private devices accessible to the authenticated user).

Returns: The created batch with its ID and initial status (PENDING).

Media typeapplication/json
CreateBatchSchema

Schema to parse request for the creation of a batch.

object
priority
Any of:
number
sequence_builder
Any of:
string
emulator
Any of:
DeviceTypeName

Enumeration of allowed and legacy device type names

string
Allowed values: EMU_FREE EMU_SV EMU_TN EMU_C FRESNEL FRESNEL_CAN1 FRESNEL_SA1 FRESNEL8 EMU_FRESNEL FRESNEL_RD EMU_MPS
device_type
Any of:
DeviceTypeName

Enumeration of allowed and legacy device type names

string
Allowed values: EMU_FREE EMU_SV EMU_TN EMU_C FRESNEL FRESNEL_CAN1 FRESNEL_SA1 FRESNEL8 EMU_FRESNEL FRESNEL_RD EMU_MPS
configuration
Any of:
Configuration

Deprecated. Use backend_configuration instead.

complete
Any of:
boolean
open
Any of:
boolean
tags
Tags

Keywords used to refine the batch search.

Array<string>
unique items
project_id
required
Project Id

ID of the project to run the batch for.

string format: uuid
backend_configuration
Any of:
string
jobs
Jobs

The list of jobs to execute in the batch. Required if the batch is not open.

Array<object>
CreateJobSchema

Schema to create a job within a batch.

object
runs
Any of:
integer
variables
Any of:
object
key
additional properties
any
sequence
Any of:
string

Successful Response

Media typeapplication/json
NonPaginatedResponse[ProducedBatchWithPartialJobsResponse]
object
data
Any of:
Examplegenerated
{
"data": "example"
}

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
"detail": [
{
"loc": [
"example"
],
"msg": "example",
"type": "example"
}
]
}