Get a Batch

GET/v1/batches/{batch_id}

Overview

A batch's status and counts. Once it is completed, cancelled or expired, output_file_id and error_file_id name its result files. Requires llm.write.

Authorizationstring · headerRequired

AudioLab API key sent as Bearer <token>. Authentication guide

batch_idpath · stringRequired

200The batch.

application/json

idstringRequired

Example: "batch_abc123"

objectstringRequired

endpointstringRequired

errorsnull

input_file_idstringRequired

completion_windowstringRequired

statusstringRequired

Values: "in_progress""finalizing""completed""expired""cancelling""cancelled"

output_file_idstring | null

error_file_idstring | null

created_atintegerRequired

in_progress_atinteger | null

expires_atinteger | null

finalizing_atinteger | null

completed_atinteger | null

failed_atnull

expired_atinteger | null

cancelling_atinteger | null

cancelled_atinteger | null

request_countsobjectRequired

Show nested fields

totalintegerRequired

completedintegerRequired

failedintegerRequired

metadataobject | null

401Invalid API key.

404Batch not found in this workspace.