Skip to main content
GET
Get batch status and results

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

batch_id
string
required

Response

Batch status and counts, with inline results when complete and within the inline size limit.

id
string
required

Unique identifier for the batch.

object
enum<string>
required
Available options:
batch
endpoint
enum<string>
required

Endpoint used by the requests in this batch.

Available options:
/v1/responses
status
enum<string>
required

Completed means every request has finished, including any that failed or were cancelled.

Available options:
in_progress,
completed
request_counts
object
required

Progress counts for this batch. The create and list endpoints return request_counts as an integer instead.

created_at
integer
required

Unix timestamp of when the batch was created.

request_status
object
required

Current statuses keyed by custom_id. Status updates may be partial; use the batch status field to decide when it is complete.

results
object[] | null
required

Results for a completed batch, matched to inputs by custom_id. Null while the batch is in progress or when its results exceed the inline size limit.

error
object | null
required

Null unless inline results are unavailable because the batch exceeds the inline size limit. In that case, code is batch_results_too_large; retrieve results by custom_id.

label
string

The label for the batch, if provided.