Skip to main content
POST
Start a batch

Authorizations

X-API-Key
string
header
required

Body

application/json
urls
string[]
required

The explicit list of URLs to scrape. Each must be http(s).

Required array length: 1 - 1000 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

201 - application/json

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"