Skip to content

Test a workflow

POST
/v1/workflows/{id}/test

Synchronous preflight. Creates no runs, batches, or sink tables. Fetches still consume normal scrape credits. Limited to 10 tests/minute.

id
required
string

Workflow ID

object
urls
required
Array<string>
>= 1 items <= 1000 items
max_items_per_stage
integer
default: 3 >= 1 <= 100
test_next_stage
boolean

Compact stage diagnostics.

object
ok
boolean
stages
Array<object>
object
key
additional properties
any
credits_used
integer

Malformed request.

object
error
required
string
Example
invalid request
field

Field that failed validation.

string
detail
string
hint
string

Missing or invalid API key.

object
error
required
string
Example
invalid request
field

Field that failed validation.

string
detail
string
hint
string

Insufficient unreserved credits.

object
error
required
string
Example
insufficient credits
required
required
integer
available
required
integer

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

Validation failed.

object
error
required
string
Example
invalid request
field

Field that failed validation.

string
detail
string
hint
string

Request, concurrency, or plan limit exceeded.

One of:
object
error
required
string
Example
invalid request
field

Field that failed validation.

string
detail
string
hint
string
Retry-After
integer

Seconds to wait when supplied.