Cancel a Batch
Stop a batch from starting new pages. In-progress pages finish, and unused credits are refunded.
Authorizations
Bearer authentication header of the form Bearer <API_KEY>, where <API_KEY> is your api key.
Path Parameters
ID of the batch to retrieve or cancel.
"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.
Batch ID.
"batch_9f2c8a"
Always cancelling. Work already in flight finishes; the batch reaches cancelled shortly after.
cancelling How pages were selected.
scrape, crawl What each page is returned as.
markdown, html Tags stored on the batch at submission.
How the crawl was configured. Null for scrape batches.
What submission took in, and what it charged for.
How far the batch got before cancellation.
What this batch cost so far.
There is no finish time yet — the batch is still winding down.
Page failures so far, grouped by error code and sorted by count.
API key usage for this request.