Skip to main content
GET
Get Batch Status

Polling Pattern

Poll this endpoint every 2–5 seconds after submitting a batch. Once status is completed, failed, or cancelled, stop polling (the batch will not change further).

Batch Status Values

completed does not guarantee every URL succeeded. A batch is marked completed when all items have a terminal status (completed or failed). Always inspect failedCount and individual item statuses to detect partial failures.

Response

Example — batch in progress:
Example — batch completed:

Top-Level Fields


Per-Item Fields

Each entry in items represents one URL:

Handling Partial Failures

When completedCount + failedCount === totalUrls but some items failed, retry them without re-running the whole batch:

Errors


Retry Failed Batch Scrapes

Re-queue only the failed items

Cancel a Batch

Stop processing and refund credits

Authorizations

Authorization
string
header
required

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

Path Parameters

batchId
string<uuid>
required

The batch ID returned by POST /batch/scrape

Response

Batch status and per-item results

status
enum<string>
Available options:
pending,
running,
completed,
failed,
cancelled
totalUrls
integer
completedCount
integer
failedCount
integer
items
object[]
createdAt
string<date-time>
finishedAt
string<date-time> | null