Skip to main content

​
Overview

This endpoint is part of TokenLab’s OpenAI-compatible Batch API. Batch jobs use uploaded JSONL files, run asynchronously, and can return output/error files later.

​
Notes

  • Batch input files must use purpose=batch.
  • completion_window is currently 24h.
  • Output ordering is not guaranteed; always match by custom_id.
  • Streaming is not supported inside batch items.

​
Example

curl -X POST "https://api.tokenlab.sh/v1/batches/batch_abc123/cancel" \
  -H "Authorization: Bearer sk-your-api-key"

​
Request / Response

Use the interactive OpenAPI panel above for the exact schema.

​
Operational Tips

  • Use custom_id for idempotent downstream reconciliation.
  • Expect output_file_id and error_file_id only after the worker finalizes the batch.
  • Batch pricing may differ from synchronous pricing because isBatchRequest=true discount rules apply.

​
Response example

{
  "id": "batch_abc123",
  "object": "batch",
  "status": "cancelling",
  "input_file_id": "file_abc123"
}

​
Important fields

​
id
string
Identifier used for follow-up calls and support.
​
status
string
Current lifecycle state for this resource.