Skip to main content
POST
Start a run
The run starts asynchronously and returns a runId immediately. Poll Get a run until its status is completed or failed. The request body’s inputs array is unchanged from before; an optional params object sits alongside it for the flow’s exposed advanced options (from Get a flow’s params[]), keyed by each param’s name, with a value matching its kind. Every param is optional and defaults to the value it was published with, so a caller that only ever sent inputs keeps working verbatim. inputs stays lenient: an unrecognized node_id, or a missing required content input, never fails the request. It comes back as a warnings entry (unknown_input / missing_input) on the 202 response instead. params is strict: an unknown name or an out-of-range/wrong-type value is rejected with 400 (unknown_param / invalid_param) before the run starts. See Run a flow for the full walkthrough and Errors for the error shapes.

Authorizations

Authorization
string
header
required

A workspace API key. Secret keys (flowy_…) are server-side — keep them private. Publishable keys (flowy_pk_…) are browser-safe but only work from their allowlisted domains.

Path Parameters

appId
string
required

Body

application/json
inputs
object

Map of input nodeId -> value (text, or a URL for media inputs). Get the keys from GET /v1/apps/{appId}.

Response

Run accepted. Poll GET /v1/runs/{runId}.

data
object
Last modified on September 8, 2026