Create a cron

POST

/v1/crons

Parser targets require a database sink. Workflow targets use stage sinks and require a final-stage database sink. Account cron count and minimum-interval limits apply.

Authorizations

• apiKeyHeader
• apiKeyQuery

Request Body ^required

object

name

required

string

<= 100 characters

description

required

string

url

string format: uri

schedule

required

Five-field cron expression.

string

timezone

string

default: UTC

target

required

One of:

object

object

parser_id

required

string

urls

required

Array<string>

>= 1 items <= 1000 items

object

object

workflow_id

required

string

urls

required

Array<string>

>= 1 items <= 1000 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>

enabled

boolean

default: true

overlap

string

default: skip

Allowed values: skip queue

Responses

201

Cron created.

object

id

string

next_run_at

string format: date-time

401

Missing or invalid API key.

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.

503

Feature or backing service is unavailable.

object

error

required

string

Example

invalid request

field

Field that failed validation.

string

detail

string

hint

string