Create Batch
const url = 'https://example.com/api/v1/batches';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"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())>"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}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).
Authorizations
Section titled “Authorizations”Request Bodyrequired
Section titled “Request Bodyrequired”Schema to parse request for the creation of a batch.
object
Enumeration of allowed and legacy device type names
Enumeration of allowed and legacy device type names
Deprecated. Use backend_configuration instead.
Keywords used to refine the batch search.
ID of the project to run the batch for.
Responses
Section titled “ Responses ”Successful Response
object
Response for a batch request which includes its jobs data but without the results.
This schema defines all the fields that can be publicly shared by the API.
object
Unique identifier for the batch.
Current batch status.
Deprecated. Use open instead. Indicates whether the batch is still accepting additional jobs. False means the batch is open; True means it is closed.
Whether the batch is open and accepting additional jobs.
Deprecated. Priority of the batch.
Target device type for the batch.
ID of the user who created the batch.
ID of the project this batch belongs to.
Timestamp when the batch was created.
Timestamp of the last batch update.
Total number of jobs in the batch.
Number of jobs grouped by status.
object
User-defined labels for organizing batches.
Response to a request for a job.
This schema defines all the fields that can be publicly shared by the API and do not require significant computational resources. For example, 'logs_links' or 'results link'.
object
Unique identifier for the job.
Current job status.
ID of the batch this job belongs to.
ID of the project this job belongs to.
Timestamp when the job was created.
Timestamp of the last job update.
Position in the creation order within the batch.
Priority queue on which the batch is scheduled.
Example
{ "data": { "complete": false, "created_at": "2025-01-15T10:30:00Z", "device_type": "FRESNEL", "id": "00000000-0000-0000-0000-000000000002", "jobs": [ { "batch_id": "00000000-0000-0000-0000-000000000002", "created_at": "2025-01-15T10:30:00Z", "creation_order": 0, "id": "00000000-0000-0000-0000-000000000003", "progress": 0, "project_id": "00000000-0000-0000-0000-000000000001", "runs": 100, "status": "PENDING", "updated_at": "2025-01-15T10:30:00Z", "variables": { "omega": 5 } } ], "jobs_count": 1, "jobs_count_per_status": { "PENDING": 1 }, "open": true, "priority": 0, "project_id": "00000000-0000-0000-0000-000000000001", "queue_priority": "MEDIUM", "sequence_builder": "<serialized Pulser sequence>", "status": "PENDING", "tags": [], "updated_at": "2025-01-15T10:30:00Z", "user_id": "user-123" }}Validation Error
object
object
Examplegenerated
{ "detail": [ { "loc": [ "example" ], "msg": "example", "type": "example" } ]}