Create a batch

POST

/v1/batches

Submit either parser URLs or prebuilt API inputs. The two shapes are mutually exclusive. Inputs are deduplicated and credits are reserved atomically. More than 100 jobs requires a database sink.

Authorizations

• apiKeyHeader
• apiKeyQuery

Parameters

Header Parameters

Idempotency-Key

string

<= 128 characters

Deduplicates retries for 24 hours. Maximum 128 characters.

Request Body ^required

One of:

object

object

parser_id

required

string

urls

required

Array<string>

>= 1 items <= 10000 items

scrape_config

Fetch override. Credit price depends on browser and proxy settings.

object

useBrowser

boolean

waitSeconds

number

waitForBrowser

string

proxy

default, highquality, hardcore, premium, or premium:<country code>.

string

sink

Return data or write rows to an owned database.

object

mode

required

string

default: return

Allowed values: return database

database

string

/^[a-z0-9-]{1,32}$/

table

string

/^[a-z0-9_]{1,48}$/

key

Upsert key columns; defaults to _url for parser jobs.

Array<string>

object

object

api

required

string

inputs

required

Array<object>

>= 1 items <= 10000 items

object

key

additional properties

any

sink

Return data or write rows to an owned database.

object

mode

required

string

default: return

Allowed values: return database

database

string

/^[a-z0-9-]{1,32}$/

table

string

/^[a-z0-9_]{1,48}$/

key

Upsert key columns; defaults to _url for parser jobs.

Array<string>

Responses

202

Batch accepted.

object

batch_id

string

total

integer

duplicates_removed

integer

credits_reserved

integer

sink

Return data or write rows to an owned database.

object

mode

required

string

default: return

Allowed values: return database

database

string

/^[a-z0-9-]{1,32}$/

table

string

/^[a-z0-9_]{1,48}$/

key

Upsert key columns; defaults to _url for parser jobs.

Array<string>

replayed

boolean

400

Malformed request.

object

error

required

string

Example

invalid request

field

Field that failed validation.

string

detail

string

hint

string

401

Missing or invalid API key.

object

error

required

string

Example

invalid request

field

Field that failed validation.

string

detail

string

hint

string

402

Insufficient unreserved credits.

object

error

required

string

Example

insufficient credits

required

required

integer

available

required

integer

404

Resource missing or not owned by this account.

object

error

required

string

Example

invalid request

field

Field that failed validation.

string

detail

string

hint

string

422

Validation failed.

object

error

required

string

Example

invalid request

field

Field that failed validation.

string

detail

string

hint

string

429

Request, concurrency, or plan limit exceeded.

One of:

object

object

error

required

string

Example

invalid request

field

Field that failed validation.

string

detail

string

hint

string

object

object

error

required

string

Example

pending limit

pending

required

integer

limit

required

integer

accepted

required

integer

0

Headers

Retry-After

integer

Seconds to wait when supplied.