Get Batch
Retrieve the current state of a batch including status, job IDs, and metadata.
Use this endpoint to poll batch progress after creation. Batch statuses follow the lifecycle: PENDING → RUNNING → CANCELING → CANCELED ↘ DONE | ERROR
Returns: The batch with its current status, job IDs, and child batch IDs.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”Responses
Section titled “ Responses ”Successful Response
object
Response for a batch request that includes only its job ids.
This schema defines all the fields that can be publicly shared by the API.
object
Unique identifier for the batch.
ID of the parent batch if created from a retry.
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.
Serialized Pulser sequence shared by all jobs.
Total number of jobs in the batch.
Number of jobs grouped by status.
object
User-defined labels for organizing batches.
Deprecated. Use backend_configuration. Extra configuration for job execution.
object
Serialized emulator backend configuration.
URL where job results are sent via webhook.
Timestamp when processing started on hardware.
Timestamp when processing finished, errored, or was canceled.
IDs of all jobs in the batch.
IDs of child batches created from retries.
Priority queue on which the batch is scheduled.
Example
{ "id": "00000000-0000-0000-0000-000000000002", "status": "DONE", "complete": true, "open": false, "priority": 0, "device_type": "FRESNEL", "user_id": "user-123", "project_id": "00000000-0000-0000-0000-000000000001", "created_at": "2025-01-15T10:30:00Z", "updated_at": "2025-01-15T10:35:00Z", "sequence_builder": "<serialized Pulser sequence>", "jobs_count": 2, "jobs_count_per_status": { "DONE": 2 }, "tags": [ "experiment-1" ], "start_datetime": "2025-01-15T10:31:00Z", "end_datetime": "2025-01-15T10:35:00Z", "job_ids": [ "00000000-0000-0000-0000-000000000003", "00000000-0000-0000-0000-000000000004" ], "child_ids": [], "queue_priority": "MEDIUM"}Validation Error