Batch
Retrieve a batch job
GET
/v1/batches/{batch_id}Retrieves a specific batch job by ID.
Path Parameters
batch_id*string
The ID of the batch to retrieve
Query Parameters
provider*string
The provider of the batch
Value in
"openai" | "azure" | "anthropic" | "bedrock" | "cohere" | "vertex" | "vllm" | "mistral" | "ollama" | "groq" | "sgl" | "parasail" | "perplexity" | "replicate" | "cerebras" | "gemini" | "openrouter" | "elevenlabs" | "huggingface" | "nebius" | "xai" | "runway" | "fireworks"Response Body
application/json
application/json
application/json
curl -X GET "http://localhost:8080/v1/batches/string?provider=openai"{
"id": "string",
"object": "string",
"endpoint": "string",
"input_file_id": "string",
"completion_window": "string",
"status": "validating",
"request_counts": {
"total": 0,
"completed": 0,
"failed": 0,
"succeeded": 0,
"expired": 0,
"canceled": 0,
"pending": 0
},
"metadata": {
"property1": "string",
"property2": "string"
},
"created_at": 0,
"expires_at": 0,
"in_progress_at": 0,
"finalizing_at": 0,
"completed_at": 0,
"failed_at": 0,
"expired_at": 0,
"cancelling_at": 0,
"cancelled_at": 0,
"output_file_id": "string",
"error_file_id": "string",
"errors": {
"object": "string",
"data": [
{
"code": "string",
"message": "string",
"param": "string",
"line": 0
}
]
},
"processing_status": "string",
"results_url": "string",
"archived_at": 0,
"operation_name": "string",
"done": true,
"progress": 0,
"extra_fields": {
"request_type": "string",
"provider": "openai",
"model_requested": "string",
"model_deployment": "string",
"latency": 0,
"chunk_index": 0,
"raw_request": {},
"raw_response": {},
"cache_debug": {
"cache_hit": true,
"cache_id": "string",
"hit_type": "string",
"requested_provider": "string",
"requested_model": "string",
"provider_used": "string",
"model_used": "string",
"input_tokens": 0,
"threshold": 0,
"similarity": 0
}
}
}{
"event_id": "string",
"type": "string",
"is_bifrost_error": true,
"status_code": 0,
"error": {
"type": "string",
"code": "string",
"message": "string",
"param": "string",
"event_id": "string"
},
"extra_fields": {
"provider": "openai",
"model_requested": "string",
"request_type": "string"
}
}{
"event_id": "string",
"type": "string",
"is_bifrost_error": true,
"status_code": 0,
"error": {
"type": "string",
"code": "string",
"message": "string",
"param": "string",
"event_id": "string"
},
"extra_fields": {
"provider": "openai",
"model_requested": "string",
"request_type": "string"
}
}