Skip to main content

run_actionflow

Trigger an ActionFlow run. Optional inputs and trigger match the SDK. The server builds the REST payload.

run_actionflow

Start a run of an organization-owned flow. The server builds the REST payload. This tool does not create or edit flows. The flow is validated (validateFlow) before enqueue.

Use this after you resolve actionFlowId with list_actionflows. Do not use it when the flow is invalid. Fix the graph in the playground first.

See Installation for auth and response_format.

Arguments

ArgumentTypeRequiredDescription
actionFlowIdstringYesFlow ID from list_actionflows.
organizationIdstringYesOrganization that owns the flow.
inputsobjectNoPer-run overrides keyed like Studio Flow inputs: {nodeId}_{inputName}.
triggerobjectNoOptional start-node envelope: body, headers, query, method.
delaystringNoISO 8601 duration, for example PT5M.
idempotencyKeystringNoDeduplicate retries of the same run request.
maxAttemptsnumberNoRetry budget for the run.
maxDurationnumberNoMaximum run duration in seconds.
tagsstring[]NoExtra run tags. The organization tag is added automatically.
response_formatjson or markdownNoDefault json.

inputs and trigger are optional. Webhook and scheduled starts still supply their own envelopes.

There is no MCP upload tool. Put files in the app (ActionFlow artifacts), or pass values the flow already expects in inputs.

Example

{
  "organizationId": "org_123",
  "actionFlowId": "flow_456",
  "idempotencyKey": "run-onboarding-1",
  "tags": ["production"],
  "inputs": {
    "node_abc_prompt": "Hello"
  },
  "trigger": {
    "body": { "hello": "world" },
    "method": "POST"
  }
}

Returns

JSON with success, data (run or queue item), and useQueue.

When useQueue is true, the organization is at capacity. Poll list_queued_runs or get_queued_run.

Validation errors return a tool error with the playground messages. Not found: confirm actionFlowId. Forbidden: pass the owning organizationId.

On this page