v1

latestOpenAPI 3.1.02026-07-26105141.0 KB

Batches API

Get batch request result

Retrieve the result of a specific request within a batch by its custom_id.

get/batches/{batch_id}/{custom_id}

batch_idstring required

The ID of the batch.

custom_idstring required

The custom_id of the request within the batch.

The response object for the given request.

idstring required

object'response' required

created_atinteger required

status'pending' | 'running' | 'failed' | 'completed' | 'cancelled' required

modelstring required

errorobject nullable

incomplete_detailsobject nullable

max_output_tokensinteger nullable

reasoningobject

storeboolean

temperaturenumber

top_pnumber

parallel_tool_callsboolean

toolsobject[]

userstring nullable

metadataobject required