Skip to main content
POST
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

Cancellation started. Poll GET /batch/{batch_id} until the batch settles.

Acknowledgement that cancellation was requested. The batch has not settled, so it carries no results, no failure, no refund and no finish time; poll GET /batch/{batch_id} for those.

id
string
required

Batch ID.

Example:

"batch_9f2c8a"

status
enum<string>
required

Always cancelling. Work already in flight finishes; the batch reaches cancelled shortly after.

Available options:
cancelling
mode
enum<string>
required

How pages were selected.

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

What each page is returned as.

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

How far the batch got before cancellation.

credits
object
required

What this batch cost so far.

timing
object
required

There is no finish time yet — the batch is still winding down.

page_errors
object[]
required

Page failures so far, grouped by error code and sorted by count.

key_metadata
object

API key usage for this request.