Sign in

v10

latestOpenAPI 3.1.02026-08-0375143791.1 KB
Batch

Get a batch

Check progress, and get download links once the batch finishes.

get/batch/{batch_id}

Path parameters

batch_idstring required

ID of the batch to retrieve or cancel.

Example:batch_9f2c8a

ID of the batch to retrieve or cancel.

Response

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

idstring required

Batch ID used to retrieve or cancel the job.

status'queued' | 'running' | 'cancelling' | 'completed' | 'cancelled' | 'failed' required

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

mode'scrape' | 'crawl' required

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

format'markdown' | 'html' required

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

tagsstring[] required

Tags stored on the batch at submission.

Example response

{
  "id": "batch_9f2c8a",
  "tags": [
    "docs"
  ],
  "crawl": {
    "source": {
      "url": "https://example.com/docs"
    },
    "max_pages": 500,
    "url_pattern": "^https://example\\.com/docs/"
  },
  "input": {
    "reserved": 24817,
    "submitted": 25000,
    "duplicates": 183
  },
  "progress": {
    "succeeded": 18091,
    "failed": 311,
    "pending": 6415
  },
  "credits": {
    "reserved": 24817,
    "refunded": 6726,
    "net": 18091
  },
  "page_errors": [
    {
      "code": "WEBSITE_ACCESS_ERROR",
      "count": 204
    }
  ],
  "failure": {
    "code": "stalled",
    "message": "Batch stopped reporting progress and was finalized automatically"
  },
  "invalid_urls": [
    {
      "reason": "Must be a public http:// or https:// URL"
    }
  ]
}