Retrieve a batch | Respan Docs

curl https://api.respan.ai/api/v1/batches/batch_abc123 \
     -H "Authorization: Bearer sk_live_xxxxx" \
     -H "Content-Type: application/json"

{
  "id": "batch_abc123",
  "status": "in_progress",
  "object": "batch",
  "endpoint": "/v1/chat/completions",
  "input_file_id": "file-abc123",
  "output_file_id": "file-output789",
  "error_file_id": "file-error456",
  "completion_window": "24h",
  "created_at": 1710000000,
  "in_progress_at": 1710003600,
  "expires_at": 1710086400,
  "finalizing_at": null,
  "completed_at": null,
  "failed_at": null,
  "expired_at": null,
  "cancelling_at": null,
  "cancelled_at": null,
  "request_counts": {
    "total": 100,
    "completed": 97,
    "failed": 3
  },
  "metadata": {
    "model": "gpt-4o-mini",
    "priority": "high",
    "user_id": "user_789xyz"
  },
  "errors": null
}

Retrieve an OpenAI-compatible batch job by ID.

Path parameters

batch_idstringRequired

Batch ID.

Response

Batch details.

idstring

Batch ID.

statusenum

objectstring

endpointstring

input_file_idstring

output_file_idstring or null

Output file ID, available when the batch completes.

error_file_idstring or null

Error file ID, when provider errors are available.

completion_windowstring

created_atinteger

Unix timestamp.

in_progress_atinteger or null

expires_atinteger or null

finalizing_atinteger or null

completed_atinteger or null

failed_atinteger or null

expired_atinteger or null

cancelling_atinteger or null

cancelled_atinteger or null

request_countsobject

metadatamap from strings to any

errorsany or null

Provider error details, when available.

Errors

401

Unauthorized Error

404

Not Found Error

Path parameters

Headers

Response

Errors