Batches API v1Alpha

Get a batch

Get a batch by ID.

get/api/v1alpha/batches/{batch_id}

Path parameters

batch_idnumber required

The ID of the batch.

Response

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

Changes

Changed in 2 of the 9 revisions of this API.1515

Apr 16, 2025afa3b61d1d0915See the full diff
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
Jan 14, 2025559a91071cc115See the full diff
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
This revision also has 35 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history