Skip to main content
POST
Start a workflow run
If your account is busy, the run waits as pending. Read Get a run until it is no longer pending or running, or set webhook_url. 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/workflows/{slug}/run (waits) and /runs (answers at once).

inputs
Inputs · object

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

wait
integer | null

/run only: seconds to wait for the result (default 60, max 120). Still running then → 202 with run_id and status_url.

Required range: 0 <= x <= 120
webhook_url
string | null

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

Response

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

run_id
string
required
status
string
required
status_url
string
required
idempotent_replay
boolean
default:false