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}.

FieldTypeDescription
idstringIdentifier of the batch.
statusstringopen while any item is still in progress, and complete when every item has finished.
model_idstringModel applied to every item in the batch.
file_countintegerNumber of files or texts in the batch.
succeededintegerNumber of items with status succeeded.
failedintegerNumber of items with status failed, cancelled, or expired.
remainingintegerNumber of items still pending, queued, or running.
files[].job_idstringJob identifier for that item.
files[].statusstringpending, queued, running, succeeded, failed, cancelled, or expired.
files[].resultobjectResult for that item once it has succeeded.