Skip to main content
POST
Cancel remaining batch requests

Authorizations

Authorization
string
header
required

API Token used for authentication. Example: "Authorization: Bearer {token}"

Path Parameters

id
string<uuid>
required

Response

OK

id
string<uuid>
required

The batch ID.

kind
string
required

The task represented by the batch.

status
enum<string>
required

The current batch state.

Available options:
pending,
running,
completed,
cancelling,
cancelled
progress
object
required

The number of requests in each state.

creditsCharged
number<double>
required

The credits charged so far, in user-visible credits.

createdAt
string<date-time>
required

When the batch was created.

statusUrl
string
required

The authenticated URL for checking batch status and progress.

resultsUrl
string
required

The download URL for the task's projected results. It is signed, so it works without credentials for one hour; after that, use the owner's credentials or a URL from a new status response.

rawResultsUrl
string
required

The download URL for raw HTTP outcomes in NDJSON format, signed like resultsUrl.

recordCount
integer<int32> | null

For a search export, the number of records its settled pages returned.

recordLimit
integer<int32> | null

For a search export, the most search results it requests. Results whose record is unavailable are skipped, so recordCount can end below it.

completedAt
string<date-time> | null

When the batch completed or was cancelled, if terminal.