Sign in

v3

OpenAPI 3.1.0MIT2026-07-31192456807.8 KB
Batches

Get a batch job

Get details of a batch job by ID

get/batches/{id}

Path parameters

idstring required

The ID of the batch job to retrieve

Example:batch_job_abc123def456

Response

OK

idstring uuid
user_idstring
input_file_idstring
file_size_bytesinteger

Size of input file in bytes

status'VALIDATING' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED' | 'EXPIRED' | 'CANCELLED'

Current status of the batch job

job_deadlinestring date-time
created_atstring date-time
endpointstring
progressnumber

Completion progress (0.0 to 100)

model_idstring

Model used for processing requests

output_file_idstring
error_file_idstring
errorstring
completed_atstring date-time

Example response

{
  "id": "01234567-8901-2345-6789-012345678901",
  "user_id": "user_789xyz012",
  "input_file_id": "file-input123abc456def",
  "file_size_bytes": 1048576,
  "status": "IN_PROGRESS",
  "job_deadline": "2024-01-15T15:30:00Z",
  "created_at": "2024-01-15T14:30:00Z",
  "endpoint": "/v1/chat/completions",
  "progress": 75,
  "model_id": "Qwen/Qwen3.5-9B",
  "output_file_id": "file-output789xyz012ghi",
  "error_file_id": "file-errors456def789jkl",
  "completed_at": "2024-01-15T15:45:30Z"
}