v1

latestOpenAPI 3.1.02026-08-0458234268.6 KB

batch

Poll batch progress

Returns the current progress of a batch operation. Poll this endpoint until status is completed. When completed, a results_url is included. If all tasks failed, an error field is included with the failure reason.

get/batch/{id}/progress

Path parameters

idstring required

The batch ID returned from the initiating bulk operation

Headers

Authorizationstring required

OAuth2 authentication flows. Auth server URLs will vary by environment

X-Api-Keystring required

API key for authentication

X-API-Versionstring

API version to use (optional, defaults to latest). Supported values: 1.0.0, 1.1.0.

Response

Successful response with current batch progress

versionstring required

batch_idstring required

The batch identifier

progressnumber double required

Fraction of tasks completed (0.0 to 1.0). Value of 1.0 means all tasks have finished (success or failure).

tasks_countinteger required

Total number of tasks in the batch

tasks_completedinteger required

Number of tasks that completed successfully

tasks_failedinteger required

Number of tasks that failed

status'processing' | 'completed' required

processing while tasks are running; completed when all tasks have finished (regardless of individual success/failure)

results_urlstring nullable

URL to fetch per-task results. Present only when status is completed.

errorstring nullable

Error message when all tasks in the batch failed. Null otherwise.