Create a workflow

POST

/v1/workflows

Create a linear 1–4 stage workflow. Every stage needs a description. Non-final stages require a follow field.

Authorizations

• apiKeyHeader
• apiKeyQuery

Request Body ^required

object

name

required

string

<= 100 characters

description

required

string

url

string format: uri

definition

required

object

stages

required

Array<object>

>= 1 items <= 4 items

object

name

required

string

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

description

required

string

parser_id

required

string

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>

follow

Required except on the final stage.

string

follow_limit

integer

<= 10000

dedupe

string

default: per_run

Allowed values: per_run per_workflow

Responses

201

Workflow created.

object

id

string

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.