Skip to main content
GET
Get Batch Status

Authorizations

x-api-key
string
header
required

Headers

Pulse-Version
string
default:2

Path Parameters

batch_id
string
required

The batch_id that POST /parse/batch returned.

Response

The batch's status, with its documents counted by state.

A batch's status, with its documents counted by state.

batch_id
string
required

The batch's id, batch-<uuid>.

summary
BatchSummary · object
required

How many of the batch's documents are in each state.

created_at
string
required

When the batch was accepted.

status
enum<string>
required

completed: every job ended and not all failed. failed: every job failed, it passed 48 hours, or it was interrupted (once its jobs end, resend the documents missing from the manifest). canceled: you canceled it.

Available options:
processing,
completed,
failed,
canceled
completed_at
string

When the batch ended. Absent while it runs. After a failure or a cancel, its jobs can still end later.

expires_at
string

Never set, because a batch and its manifest don't expire. Each job's own status gives its expires_at.

error
Problem · object

Why the batch failed. Present only when failed.