Skip to main content
POST
Start a batch

Authorizations

X-API-Key
string
header
required

Headers

Idempotency-Key
string

Any unique string up to 255 visible characters. Send the same key when you retry a request: for 12 hours a repeat returns the first answer again, with an Idempotent-Replayed: true header, without doing the work or charging a second time. A repeat that arrives while the first is still running gets 409 IDEMPOTENCY_IN_PROGRESS; the same key with a different body gets 409 IDEMPOTENCY_KEY_REUSED.

Maximum string length: 255
Example:

"3f2b8c1e-retry-safe-key"

Body

application/json
urls
string[]
required

The explicit list of URLs to scrape, each http(s). Malformed entries are skipped and returned in invalidUrls; the batch is refused only when none is valid.

Required array length: 1 - 25000 elements
Example:
webhook
object

Register a callback to be notified as the batch progresses instead of polling.

scrapeOptions
object

How to scrape each URL. Same options as a single scrape.

Response

The batch was accepted.

batchId
string
required

Poll this batch id for progress and results.

Example:

"019f3c09-6fae-740f-9257-10c2b6af7f43"

status
enum<string>
required

The job has been accepted.

Available options:
queued
Example:

"queued"

invalidUrls
string[]

Entries that were not valid http(s) URLs and were skipped. Absent when every URL was valid.

Example: