Skip to main content
POST
Run a flow

Authorizations

Authorization
string
header
required

One of server.auth.tokens. With no tokens configured the API is open.

Headers

Idempotency-Key
string

Any string that is unique per logical request, for example an MQ message id. Results are kept for server.idempotencyTtlMs (default 10 minutes), per server instance, and are lost on restart. Failed runs are not kept, so a retry after a failure runs again.

Path Parameters

id
string
required

Flow id.

Body

application/json
input
object

Run input. Templates read it as {{input.field}}.

Response

The run finished. Check ok for node failures.

ok
boolean
required

False when any node failed.

runId
string
required
nodes
object
required

The trace, keyed by node id.

output
object

Result of the flow's output node, when one ran.