Sign in

v1

latestOpenAPI 3.1.02026-07-26132433.7 KB
Batches

Retrieve a batch

Poll batch status and live request_counts while in progress.

get/v1/batches/{batch_id}

Path parameters

batch_idstring required

Headers

x-project-idstring

Optional project identifier. Scopes the request to a specific project when provided.

Response

Batch object

idstring
object'batch'
endpointstring
status'validating' | 'in_progress' | 'finalizing' | 'completed' | 'failed' | 'expired' | 'cancelling' | 'cancelled'
input_file_idstring
output_file_idstring nullable
error_file_idstring nullable
completion_windowstring
created_atinteger
expires_atinteger
metadataobject