v2
latestOpenAPI 3.1.02026-08-07139158192.4 KBBatches
Get a batch by id
get/v1/batches/{id}
Path parameters
idstring required
Response
OK
cancelled_atinteger
completed_atinteger
completion_window'24h' required
created_atinteger required
Unix timestamp (seconds).
endpointstring required
The API family every record in the batch calls.
error_file_idstring
Present once results are written; fetch its content for failed records.
expired_atinteger
expires_atinteger
When the completion window closes (created_at + 24h).
failed_atinteger
idstring required
Batch id (batch_…).
input_file_idstring required
metadataobject
Your key-value pairs, echoed back unchanged.
modelstring
Model id, settled from the input file during validation.
object'batch' required
output_file_idstring
Present once results are written; fetch its content for successful records.
status'validating' | 'in_progress' | 'finalizing' | 'completed' | 'failed' | 'expired' | 'cancelling' | 'cancelled' required
Lifecycle state. validating → in_progress → finalizing → completed | failed | expired; cancelling → cancelled.