Skip to main content
GET
/
v1
/
batches
/
{batch_id}
Retrieve Batch
curl --request GET \
  --url http://localhost:8080/v1/batches/{batch_id} \
  --header 'x-model-provider: <x-model-provider>'
{
  "id": "<string>",
  "object": "<string>",
  "endpoint": "<string>",
  "input_file_id": "<string>",
  "completion_window": "<string>",
  "status": "validating",
  "request_counts": {
    "total": 123,
    "completed": 123,
    "failed": 123
  },
  "created_at": 123,
  "expires_at": 123,
  "in_progress_at": 123,
  "completed_at": 123,
  "failed_at": 123,
  "output_file_id": "<string>",
  "error_file_id": "<string>",
  "extra_fields": "<unknown>"
}

Headers

x-model-provider
string
required

The model provider

Path Parameters

batch_id
string
required

The ID of the batch to retrieve

Response

200 - application/json

Batch details

id
string
object
string
endpoint
string
input_file_id
string
completion_window
string
status
enum<string>
Available options:
validating,
failed,
in_progress,
finalizing,
completed,
expired,
cancelling,
cancelled
request_counts
object
created_at
integer
expires_at
integer
in_progress_at
integer
completed_at
integer
failed_at
integer
output_file_id
string
error_file_id
string
extra_fields
any