Skip to main content
POST
Start an async Skill run
The rows are not in this response. Poll GET /v1/runs/{run_id} until status is no longer queued or running, or set webhook_url to receive the finished run as a signed POST. See Webhooks for how to verify the signature.

Authorizations

Authorization
string
header
required

API key with the vd_sk_ prefix. Create keys from Settings, API Keys in the dashboard.

Headers

Idempotency-Key
string

Retry-safe key. The same key from the same account returns what it already started.

Path Parameters

slug
string
required

URL-safe slug of the Skill.

Body

application/json
inputs
object

The Skill's inputs (see input_schema).

Example:
parameters
object

Accepted as another name for inputs.

max_results
integer

Max rows; 0 returns the whole list.

Required range: 0 <= x <= 500
max_pages
integer

Page limit; 0 means all pages.

Required range: x >= 0
browser_type
string

remote, extension, local_profile, or none. Omit for the Skill's saved setting.

proxy_config
string

Region for this run (country code, random, or none).

profile_id
string

Browser profile to use for this run.

scrape_mode
string

deep or flash, for Skills that support it.

webhook_url
string

Public http(s) URL that receives the finished run as a signed POST.

version
integer

Recipe version to replay. Omit for the pinned or live one.

Required range: x >= 1

Response

Run queued (or the existing one, for a repeated Idempotency-Key).

run_id
string
Example:

"run_8c1d2e3f4a5b"

status
string
Example:

"queued"

poll_url
string
Example:

"/v1/runs/run_8c1d2e3f4a5b"

idempotent_replay
boolean