Call your agents and flows
Design agents and flows in the app. Call them from REST, the TypeScript SDK, hosted MCP, webhooks, or a public page.
Build, connect, and share your work
Build with code. Connect over MCP and webhooks. Share with a public page. Design stays in the app.
Build
Connect
Which path fits
You design the agent or flow in the app. These paths discover, run, or chat. They do not edit the graph. Keep API keys in a backend or in secret-managed MCP config.
| Path | Use it when | Auth and streaming |
|---|---|---|
| Backend REST | Your server starts a saved flow with POST /api/runs. | Bearer API key. 201 or 202 admits the run. Poll Get Run for the result. There is no per-flow /run route. |
| TypeScript flow SDK | The same run start from TypeScript. | API key on the server. Same 201 and 202 admission. Run stream is a separate REST or SDK call. |
| Agent chat | Your backend chats with an active agent. | POST /v1/chat/completions. OpenAI-compatible client. stream true sends SSE. No SDK embed widget. |
| Hosted MCP | An MCP client lists and calls your agents and flows. | API key in the MCP config. Hosted MCP does not stream. Use REST or the SDK for live SSE. This is not the third-party MCP catalog. |
| Inbound webhook | Another system POSTs to a flow URL to start a run. | The flow must be active or the handler returns 409. This is not an agent channel trigger. |
| Outbound event webhook | Your URL receives signed flow.run.started, flow.run.succeeded, or flow.run.failed. | Register it under Organization, Webhooks. Verify X-ActionFlows-Signature. This does not start a run. |
| Public page | A person opens one published flow or agent. See Landings. | No API key on that page. Try and copy rules are on Landings, not here. |
From one API call to a result
- 01
POST /api/runs with payload.organizationId, payload.actionFlowId, and inputs keyed by node id, underscore, and input name, as in node_abc_prompt.
- 02
201 means dispatched. 202 means queued. Save the run id or the queue id. Neither status means the graph finished.
- 03
Read the run in history or with Get Run. For a queued item, poll the queue id until a trigger run id is present.
Programmatic access questions
A run spends organization credits. Log storage and other limits follow your plan. See pricing
Start a run from your app
Create an API key, keep it on the server, and send POST /api/runs. Then read the run. Design stays in the app.