Skip to main content
GET
JavaScript
0 Credits

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <API_KEY>, where <API_KEY> is your api key.

Path Parameters

batch_id
string
required

ID of the batch to retrieve or cancel.

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 used to retrieve or cancel the job.

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

How pages were selected. Matches input.mode on the submit request.

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 submission took in, and what it charged for.

progress
object
required

Pages attempted so far. Use status to check completion.

credits
object
required

What this batch has done to your credit balance.

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

Download links, available once the batch reaches a final status and null before then. GET /batch/{batch_id}/results serves the same records as paginated JSON.

invalid_urls
object[]
required

Rejected URLs, up to 100. These are not charged.

key_metadata
object

API key usage for this request.