Sign in
OpenAI Integration

Retrieve batch job (OpenAI format)

Retrieves details of a batch processing job.

Note: This endpoint also works without the /v1 prefix (e.g., /openai/batches/{batch_id}).

get/openai/v1/batches/{batch_id}

Path parameters

batch_idstring required

Batch job ID

Query parameters

providerstring

Provider for the batch

Response

Successful response

idstring
objectstring
endpointstring
input_file_idstring
completion_windowstring
status'validating' | 'failed' | 'in_progress' | 'finalizing' | 'completed' | 'expired' | 'cancelling' | 'canceled' | 'ended'
metadataobject
created_atinteger
expires_atinteger
in_progress_atinteger
finalizing_atinteger
completed_atinteger
failed_atinteger
expired_atinteger
cancelling_atinteger
cancelled_atinteger
output_file_idstring
error_file_idstring
processing_statusstring
results_urlstring
archived_atinteger
operation_namestring
doneboolean
progressinteger

Changes

No recorded changes to this endpoint across all 1 revision of this API.