Skip to main content
POST
Start an async Workflow run
The outputs are not in this response. Poll GET /v1/workflow-runs/{run_id} until status is no longer pending 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 the run it already started.

Path Parameters

slug
string
required

The workflow's slug (shown on its API tab).

Body

application/json
inputs
object

The workflow's inputs (see input_schema). Values are converted like skill inputs: "5" → 5 for an integer.

wait
integer

/run only: seconds to wait (default 60).

Required range: 0 <= x <= 120
webhook_url
string<uri>

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
Example:

"/v1/workflow-runs/0f533c1b-9134-466f-b6ba-38592ca5d21c"

idempotent_replay
boolean