Skip to main content
GET
Retrieve a batch
0 credits Requires batches:read permission. See the guide for examples and usage.

Authorizations

Authorization
string
header
required

Send Authorization: Bearer <API_KEY>. Keys have full access unless restricted to scopes.

Path Parameters

batch_id
string
required

Batch ID.

Example:

"batch_9f2c8a"

Response

Current state of the batch, with download links once it has finished.

What a single-batch read adds to the batch itself.

id
string
required

Batch ID.

Example:

"batch_9f2c8a"

status
enum<string>
required

Current state. completed, cancelled, and failed are final.

Available options:
queued,
running,
cancelling,
completed,
cancelled,
failed
mode
enum<string>
required

scrape (URL list) or crawl.

Available options:
scrape,
crawl
format
enum<string>
required

What each page is returned as. Matches input.data.format on the submit request.

Available options:
markdown,
html
tags
string[]
required

Tags stored on the batch at submission.

Example:
crawl
Crawl controls · object | null
required

How the crawl was configured. Null for scrape batches.

input
object
required

What the submission accepted.

progress
object
required

Pages attempted so far. Use status to check completion.

credits
object
required

Batch credit usage and settlement.

timing
object
required
page_errors
object[]
required

Individual page failures grouped by error code, sorted by count. Unrelated to failure, which is the batch itself failing.

failure
object | null
required

Why the batch as a whole stopped. Null unless status is failed. Individual pages that failed are counted in page_errors instead.

results
object | null
required

Result download links; null until the batch finishes. Files are deleted 180 days after the batch finishes.

request_id
string<uuid>
required

Unique ID of this request, also in X-Request-Id. Include it when contacting support.

Example:

"3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91"

invalid_urls
object[]
required

Rejected URLs (first 100).

key_metadata
object

API key usage for this request.

webhook_delivery_id
string

Batch completion delivery ID, when available.