Sign in

v1

latestOpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2026-05-044743166.6 KB
batches

Retrieve a batch

Retrieve a batch by its ID, including its status and the IDs of all runs in the batch.

get/api/v1/batches/{batchId}

Response

Successful request

idstring

The batch ID.

status'PENDING' | 'PROCESSING' | 'COMPLETED' | 'PARTIAL_FAILED' | 'ABORTED'

The current status of the batch.

idempotencyKeystring nullable

The idempotency key provided when triggering, if any.

createdAtstring date-time
updatedAtstring date-time
runCountinteger

The total number of runs in the batch.

runsstring[]

Array of run IDs in the batch.

successfulRunCountinteger nullable

Number of successful runs (populated after completion).

failedRunCountinteger nullable

Number of failed runs (populated after completion).