GET /v1/{product}/batch/{batch_id}
List jobs
A batch response lists every file or text in that batch.
Retrieve one job with GET /v1/{product}/{job_id}. Retrieve a batch with GET /v1/{product}/batch/{batch_id}.
| Field | Type | Description |
|---|---|---|
id | string | Identifier of the batch. |
status | string | open while any item is still in progress, and complete when every item has finished. |
model_id | string | Model applied to every item in the batch. |
file_count | integer | Number of files or texts in the batch. |
succeeded | integer | Number of items with status succeeded. |
failed | integer | Number of items with status failed, cancelled, or expired. |
remaining | integer | Number of items still pending, queued, or running. |
files[].job_id | string | Job identifier for that item. |
files[].status | string | pending, queued, running, succeeded, failed, cancelled, or expired. |
files[].result | object | Result for that item once it has succeeded. |