v1

latestOpenAPI 3.1.0MIT Licence2026-07-17613573.4 KB

Batches API v1Alpha

Get a batch

Get a batch by ID.

get/api/v1alpha/batches/{batch_id}

batch_idnumber required

The ID of the batch.

Successfully retrieved the batch.

idinteger

The batch ID

userstring

The user who created the batch

billing_projectstring

The billing project associated with the batch

tokenstring

Token for batch identification

state'open' | 'complete' | 'cancelled' | 'failure' | 'running'

Current state of the batch

completeboolean

Whether the batch is complete

closedboolean

Whether the batch is closed

n_jobsinteger

Total number of jobs in the batch

n_completedinteger

Number of completed jobs

n_succeededinteger

Number of succeeded jobs

n_failedinteger

Number of failed jobs

n_cancelledinteger

Number of cancelled jobs

time_createdstring date-time

When the batch was created

time_completedstring date-time nullable

When the batch completed

attributesobject

Key-value pairs of attributes for the batch