Retrieve a Batch
Check progress, and get download links once the batch finishes.
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
Current state of the batch, with download links once it has finished.
What a single-batch read adds to the batch itself.
Batch ID used to retrieve or cancel the job.
"batch_9f2c8a"
Current state. completed, cancelled, and failed are final.
queued, running, cancelling, completed, cancelled, failed How pages were selected. Matches input.mode on the submit request.
scrape, crawl What each page is returned as. Matches input.data.format on the submit request.
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.
Pages attempted so far. Use status to check completion.
What this batch has done to your credit balance.
Individual page failures grouped by error code, sorted by count. Unrelated to failure, which is the batch itself failing.
Why the batch as a whole stopped. Null unless status is failed. Individual pages that failed are counted in page_errors instead.
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.
Rejected URLs, up to 100. These are not charged.
API key usage for this request.