Skip to main content
POST
Run a Workflow

Authorizations

Authorization
string
header
required

Session token (JWT) obtained by calling POST /api/auth/login with your email and password.

Path Parameters

workflow_id
string<uuid>
required

The UUID of the Workflow to run.

Body

application/json
inputs
object

Key-value map of input parameters to pass into the first step. Reference these in step configs with {{inputs.field_name}}.

Example:

Response

Workflow run result

id
string<uuid>
workflow_id
string<uuid>
status
enum<string>
Available options:
completed,
failed,
waiting_for_human
inputs
object | null
outputs
unknown
error
string | null
credits_charged
number<float>
execution_time_ms
integer | null
started_at
string<date-time> | null
completed_at
string<date-time> | null
created_at
string<date-time>
step_results
object[]