Run a workflow
run_workflowStart a workflow run and wait up to 45 seconds for completion; returns final output or a run_id for checking status without resubmitting.
Instructions
Start a workflow run (one submit) and wait up to wait_seconds (≤ 45) for it to finish. Completed → the final output; still running → run_id: call check_workflow_run with it, never resubmit (a new run bills again). Each step is billed as an ordinary request. webhook_url gets ONE signed workflow.completed / workflow.failed delivery when the run ends. Get workflow_id and the inputs shape from list_workflows. Needs a Relay credential.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| inputs | Yes | Template inputs, an object matching the workflow's input_schema. | |
| webhook_url | No | HTTPS URL for one signed workflow.completed / workflow.failed delivery when the run ends. | |
| workflow_id | Yes | Workflow template id from list_workflows, e.g. `script-voiceover`. | |
| store_output | No | Run-level storage for every media step: `provider` (default, 1 h link) or `relay1d` / `relay7d` / `relay30d` (billed per file, see get_pricing). | |
| wait_seconds | No | Seconds to wait for it to finish (0–45, default 45); 0 returns the run_id at once. | |
| idempotency_key | No | Idempotency-Key for the submit: the same key and inputs within 24 h return the same run_id instead of a new run. Generated when omitted. |