Getting started

This site documents the whole AiFlow API.

That covers what an integration touches: sending events, receiving webhooks, embedding the widget, and connecting over MCP. It also covers everything you can script instead of clicking through the dashboard: agents, knowledge, tools, Orchestrators, triggers, and your team.

Two kinds of work, two kinds of credential

• Integration work (a CRM sending events, a workflow tool receiving webhooks, an MCP client) authenticates with an API key, scoped narrowly to the permissions it actually needs. See Sending events, Webhook subscriptions, Embedding the widget, and MCP server.
• Operating a deployment (configuring agents, knowledge, tools, triggers, Orchestrators, and your team) authenticates with an admin session token, the same credential that powers the admin dashboard itself. See Agents, Context & knowledge, Tools, Triggers, Orchestrators, Team, and the other guides in this section.

Both are documented to the same depth here: every endpoint, every field, and working code in cURL, Python, and TypeScript. See Authentication for how each credential works and where to get one.

Where to start

1. Credentials: the outside accounts your deployment needs before you stand it up at all, starting with Gemini and adding Twilio, WhatsApp, Telegram, Resend, CRM connectors, or SSO as your agents need them.
2. Installation: standing the deployment up on your own server, whichever way suits you, and the commands you run it with afterwards. Skip this if somebody has already deployed it for you.
3. Authentication: how self-hosting shapes your base URL, and how each credential AiFlow issues works once your deployment is running.
4. Quickstart: your first API call, from start to finish.
5. Concepts: Agents, Triggers, Events, and Orchestrators, the ideas behind everything else here.