v1

latestOpenAPI 3.1.0Apache 2.02026-07-264001921002.3 KB
Batch

Retrieve a batch job

Retrieves a specific batch job by ID.

get/v1/batches/{batch_id}

Path parameters

batch_idstring required

The ID of the batch to retrieve

Query parameters

provider'openai' | 'azure' | 'anthropic' | 'bedrock' | 'cohere' | 'vertex' | 'vllm' | 'mistral' | 'ollama' | 'groq' | 'sgl' | 'parasail' | 'perplexity' | 'replicate' | 'cerebras' | 'deepseek' | 'gemini' | 'openrouter' | 'elevenlabs' | 'huggingface' | 'nebius' | 'xai' | 'runway' | 'fireworks' required

AI model provider identifier

The provider of 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