Skip to main content
POST
Start a skill run
Inputs go under inputs. If your account is busy, the run waits in a queue (up to about an hour, then it fails uncharged). The rows are not in this response. Read Get a run until status is no longer queued or running, or set webhook_url to have the finished run sent to you. See Webhooks. Send an Idempotency-Key to make retries safe.

Authorizations

Authorization
string
header
required

API key with the vd_sk_ prefix, as Authorization: Bearer vd_sk_.... Create keys in Settings → API Keys.

Headers

Idempotency-Key
string

Any unique string (such as your order id). Resending the same request with the same key within 24 hours returns the first answer (with Idempotent-Replayed: true) and does nothing twice; the same key with a different request is a 422 idempotency_key_reused.

Required string length: 1 - 255

Path Parameters

slug
string
required

Body

application/json

Body of POST /v1/skills/{slug}/runs.

inputs
Inputs · object

The skill's inputs (see input_schema on GET /v1/skills/{slug}).

parameters
Parameters · object | null
max_results
integer | null

Max rows to return; 0 means the entire list. Omit to use the skill's saved default.

Required range: 0 <= x <= 500
max_pages
integer | null
Required range: x >= 0
browser_type
string | null
proxy_config
string | null
profile_id
string | null
scrape_mode
string | null
webhook_url
string | null

https URL that receives the finished run as a signed POST (X-Valendata-Signature).

version
integer | null

Recipe version to replay (GET /v1/skills/{slug}/versions). 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
required
status
string
required
poll_url
string
required
idempotent_replay
boolean
default:false
draft_run
boolean
default:false