Files and batches glossary
Terms for uploads and asynchronous processing. Shorter definitions of the core API terms are on the main Glossary.
Batch
A set of up to many thousands of requests processed asynchronously within 24 hours at a discount. See batches.
Batch window
The 24 hours a batch has to finish; unfinished requests are then expired.
custom_id
Your own id for each request in a batch, used to match results, which arrive in any order.
Error file
The JSONL file of failed requests and their errors.
expires_at
When a file is deleted automatically. A file.expired webhook fires then.
File id
The file_... id returned on upload, used to reference the file in requests, batches and agents. See files.
Input file
The JSONL file of requests a batch runs.
JSONL
A file with one JSON object per line, the format for batch input and results.
Output file
The JSONL file of successful results.
Purpose
Why a file was uploaded (batch, agent_input, eval_dataset, plugin, tool_output…). It decides where the file may be used.
request_counts
Totals of succeeded, failed and canceled requests in a batch.
Results stream
GET /v1/batches/{id}/results: successes and failures merged into one JSONL stream. See results.