Skip to main content
GET
Get batch progress

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

batch_id
string
required

The unique identifier of the batch.

Example:

"123e4567-e89b-12d3-a456-426614174000"

Response

Batch progress returned successfully.

Lightweight batch progress without task details.

completed
boolean
required

Whether all tasks in the batch have finished.

completed_count
number
required

Number of tasks that have completed so far.

id
string
required

Unique identifier for the batch.

progress
number
required

Completion ratio between 0 and 1.

status
string
required
Allowed value: "success"
completed_at
string

ISO timestamp when the batch completed.