# Flowra

> Build AI agents and workflows in chat, then integrate with the Flowra API, MCP, and embeds.

- [Introduction](https://docs.flowra.dev/index.md): Flowra is the platform for AI agents and workflows. Build in chat, then integrate with the API when you need to.
- [How Flowra works](https://docs.flowra.dev/product/how-flowra-works.md): The mental model for Flowra: projects, end users, tools, workflows, entry points, and data — in plain language.
- [First agent in chat](https://docs.flowra.dev/product/first-agent-in-chat.md): Create or pick an agent and run your first conversation in the Flowra dashboard.
- [Compare Flowra](https://docs.flowra.dev/product/compare.md): Flowra next to Composio, Pipedream, Zapier, and n8n: app count, OAuth, price, self-hosting, and MCP.
- [FAQ](https://docs.flowra.dev/product/faq.md): Short answers about Flowra: apps, MCP, the six meta tools, pricing, self-hosting, and the agent skill.
- [Projects and API keys](https://docs.flowra.dev/product/projects-and-keys.md): What a Flowra project is, project settings tabs, API keys, and AI Key (OpenRouter).
- [Account and pricing](https://docs.flowra.dev/product/account-and-pricing.md): Credit balance, active plan, usage limits, and how to upgrade or buy credits.
- [External users switcher](https://docs.flowra.dev/product/external-users.md): Each end user gets their own layer: agents, connections, and data. How the switcher works, with full examples.
- [App credentials](https://docs.flowra.dev/product/app-credentials.md): Create project-level OAuth and API-key credentials (auth configs) so end users can connect toolkits.
- [Connections](https://docs.flowra.dev/product/connections.md): Link third-party accounts (OAuth) so tools and workflows can act on behalf of the selected end user.
- [Toolkits and tools](https://docs.flowra.dev/product/toolkits-and-tools.md): Browse the project tool catalog, create custom tools, connect accounts, and attach tools to agents.
- [Skills](https://docs.flowra.dev/product/skills.md): Browse, create, and install playbooks for the selected end user, then attach them to agents.
- [Workflows in the dashboard](https://docs.flowra.dev/product/workflows-in-dashboard.md): Create, configure, run, and debug agents and static workflows in the Flowra dashboard — every main editor surface.
- [Entry points and channels](https://docs.flowra.dev/product/entry-points-and-channels.md): How people reach an agent: dashboard chat, MCP, messaging channels, schedules, events, widgets, and API.
- [Triggers in the dashboard](https://docs.flowra.dev/product/triggers-in-dashboard.md): Manage trigger instances for schedules and events. For messaging channels, see Entry points.
- [Database](https://docs.flowra.dev/product/data/database.md): Manage table collections and documents for the selected end user, and attach them to agents.
- [Files](https://docs.flowra.dev/product/data/files.md): Browse, preview, download, and free project file storage used by chat and workflows.
- [Knowledge](https://docs.flowra.dev/product/data/knowledge.md): Manage RAG collections, sources, and semantic search for the selected end user.
- [Templates](https://docs.flowra.dev/product/marketplace.md): Browse workflow templates (Templates / Catalog) and clone them into your project.
- [Widgets and embeds](https://docs.flowra.dev/product/widgets-and-embeds.md): Add a Flowra chat widget to your website, bound to an agent.
- [MCP in the dashboard](https://docs.flowra.dev/product/mcp-in-dashboard.md): Register MCP servers so agents can use their tools, and install Cursor or Claude with OAuth or an API key.
- [Clone from Templates](https://docs.flowra.dev/product/try-marketplace.md): Clone a template workflow, reconnect accounts, and run it in chat.
- [Embed a widget](https://docs.flowra.dev/product/try-embed.md): Create a chat widget, copy the embed URL, and smoke-test it on a page.
- [Schedule a daily trigger](https://docs.flowra.dev/product/try-schedule.md): Run a workflow every day with a cron trigger.
- [Quickstart](https://docs.flowra.dev/quickstart.md): Get your API key and make your first Flowra API request
- [Authentication](https://docs.flowra.dev/authentication.md): Authenticate to the Flowra API with project API keys, and optionally scope requests with x-username.
- [SDKs](https://docs.flowra.dev/guides/sdk.md): Official TypeScript and Python clients for the Flowra API — install, auth, common examples, and namespaces.
- [TypeScript SDK](https://docs.flowra.dev/guides/sdk-typescript.md): Install @flowra/sdk with examples for tools, workflows, connections, chat, files, sandbox, and usage.
- [Python SDK](https://docs.flowra.dev/guides/sdk-python.md): Install flowra-sdk with examples for tools, workflows, connections, chat, files, sandbox, and usage.
- [SDK namespaces](https://docs.flowra.dev/guides/sdk-namespaces.md): Facade method map for @flowra/sdk and flowra — TypeScript camelCase ↔ Python snake_case.
- [SDK method examples](https://docs.flowra.dev/guides/sdk-method-examples.md): Copy-paste TypeScript and Python examples for every Flowra SDK facade method.
- [Usage and credits](https://docs.flowra.dev/guides/usage-and-credits.md): Track Flowra credit usage via the SDK — balance, ledger, chat SSE usage events, and workflow execution usage.
- [Chat streaming](https://docs.flowra.dev/guides/sdk-chat-streaming.md): Stream Graphify chat runs with the Flowra SDKs and parse SSE usage events — with full examples.
- [Workflows and agents](https://docs.flowra.dev/guides/workflows-and-agents.md): Canonical explanation of static workflows vs agents in Flowra — when to use each and how they run.
- [Workflows](https://docs.flowra.dev/guides/workflows.md): Create, list, run, and manage workflows (agents) via the API
- [Tools](https://docs.flowra.dev/guides/tools.md): Browse, create, execute tools and list toolkits for agents and workflows
- [Auth configs](https://docs.flowra.dev/guides/auth-configs.md): Create and manage OAuth and API key configurations for tools
- [Connected accounts](https://docs.flowra.dev/guides/connected-accounts.md): OAuth connected accounts and link creation
- [Triggers](https://docs.flowra.dev/guides/triggers.md): Schedule and event-based trigger instances
- [Threads (Chat & agents)](https://docs.flowra.dev/guides/threads.md): Create and manage conversation threads and stream agent runs via the Graphify API
- [Skills](https://docs.flowra.dev/guides/skills.md): Browse, create, import, and install skills so agents follow reusable playbooks.
- [Human in the loop](https://docs.flowra.dev/guides/human-in-the-loop.md): Pause workflow runs for approval or user input, then resume with the API.
- [Files](https://docs.flowra.dev/guides/files.md): Upload, list, download, and delete files via the API
- [Knowledge (RAG collections)](https://docs.flowra.dev/guides/knowledge.md): List and delete knowledge collections for RAG in workflows and agents
- [Data collections (Table)](https://docs.flowra.dev/guides/table.md): List collections, read and write documents via the Table API
- [Sandbox](https://docs.flowra.dev/guides/sandbox.md): Run code in ephemeral or durable sandboxes for custom tools and agent workbenches.
- [Browser sessions](https://docs.flowra.dev/guides/browser-sessions.md): Monitor and control live browser sessions used by agents — status, live view, heartbeat, and close.
- [MCP](https://docs.flowra.dev/guides/mcp.md): Model Context Protocol: connect with OAuth or an API key, register servers, and call tools
- [Multi-tenancy](https://docs.flowra.dev/guides/multi-tenancy.md): How Flowra isolates your project and your end users — project scope, external users, x-username, and which resources are per-tenant
- [AI models & text generation](https://docs.flowra.dev/guides/ai-models-and-llm.md): List available AI models and generate text with the LLM API
- [Run a workflow](https://docs.flowra.dev/recipes/run-a-workflow.md): List workflows, execute one via the API or SDK, and poll the thread or execution status.
- [Connect an account](https://docs.flowra.dev/recipes/connect-an-account.md): Create an auth config if needed, generate an OAuth link, and list connected accounts.
- [Use MCP in Cursor](https://docs.flowra.dev/recipes/use-mcp-in-cursor.md): Connect Cursor to Flowra MCP with OAuth (URL only) or a project API key.
- [Multi-tenant basics](https://docs.flowra.dev/recipes/multi-tenant-basics.md): Use x-username so each end user gets isolated connected accounts and runs.
- [Native tools](https://docs.flowra.dev/guides/native-tools/index.md): Flowra built-in tools for workflows, MCP Smart mode, and the platform
- [Workflow & agent](https://docs.flowra.dev/guides/native-tools/workflow.md): Native tools to create, list, run, and delete workflows and agents, manage triggers, and list AI models
- [Meta tools](https://docs.flowra.dev/guides/native-tools/meta.md): Discover, schema, execute, connect, and sandbox tools exposed in MCP Smart mode
- [Toolkit & custom tools](https://docs.flowra.dev/guides/native-tools/toolkit-tool.md): Create and manage local toolkits and custom HTTP/JS tools in your project
- [Database (Table)](https://docs.flowra.dev/guides/native-tools/database.md): Native tools for Flowra Table — collections and documents with project and owner isolation
- [RAG (Knowledge)](https://docs.flowra.dev/guides/native-tools/rag.md): Native tools to ingest, search, and manage knowledge collections
- [File](https://docs.flowra.dev/guides/native-tools/file.md): Read, edit, convert, export, and upload files in your project
- [Web](https://docs.flowra.dev/guides/native-tools/web.md): Search the public web and fetch URL content
- [Browser](https://docs.flowra.dev/guides/native-tools/browser.md): Stagehand browser automation — sessions, navigate, act, observe, extract, and agent
- [Development](https://docs.flowra.dev/development.md): Preview and contribute to the Flowra documentation site
- [Get current user profile](https://docs.flowra.dev/api-reference/users/get-current-user-profile.md): Returns the profile of the authenticated user (dashboard account). Prefer the x-api-key header for API access; JWT Bearer also works for the dashboard session.
- [List external users](https://docs.flowra.dev/api-reference/external-users/list-external-users.md): List end users for your project with optional channel/source filters, pagination, sorting, and credit usage totals.
- [Create external user](https://docs.flowra.dev/api-reference/external-users/create-external-user.md): Create or resolve an external user by username (`name`) within your project. Same as sending `x-username` on a request with a new name.
- [Refresh external user profile photo](https://docs.flowra.dev/api-reference/external-users/refresh-external-user-profile-photo.md): Re-fetch the messaging-channel profile photo for this end user (Telegram / WhatsApp / Bale). Concurrent calls for the same user share one in-flight request.
- [Toggle external user active status](https://docs.flowra.dev/api-reference/external-users/toggle-external-user-active-status.md): Enable or disable an external user. Project default users cannot be deactivated. Inactive users cannot resolve via x-username or channels.
- [Get external user by username](https://docs.flowra.dev/api-reference/external-users/get-external-user-by-username.md): Get one external user by their username (name) within your project. Returns null if not found. Use to look up a user before assigning them to workflows or resources.
- [List auth configurations](https://docs.flowra.dev/api-reference/auth-configs/list-auth-configurations.md): List OAuth or API-key auth configurations used by your toolkits (e.g. Slack, Google). Use to see which connections are set up and manage credentials.
- [Create auth configuration](https://docs.flowra.dev/api-reference/auth-configs/create-auth-configuration.md): Create an authentication configuration (OAuth or API key) for a toolkit. Workflows and agents can then use this config to connect to the external service (e.g. Slack, CRM).
- [Get auth configuration by ID](https://docs.flowra.dev/api-reference/auth-configs/get-auth-configuration-by-id.md): Get details of one auth configuration by ID. Use to inspect provider, scopes, or linked toolkits before using it in a workflow.
- [Delete auth configuration](https://docs.flowra.dev/api-reference/auth-configs/delete-auth-configuration.md): Remove an auth configuration. It will no longer be available for toolkits or workflows. Any workflows using it may need a new connection.
- [List connected accounts](https://docs.flowra.dev/api-reference/connected-accounts/list-connected-accounts.md): Returns all OAuth-connected accounts (e.g. Google, Slack) linked to your project. Use these when workflows or agents need to act on behalf of a connected user.
- [Create connected account (provider dispatch)](https://docs.flowra.dev/api-reference/connected-accounts/create-connected-account-provider-dispatch.md): Creates a connection by delegating to the auth config’s provider (local, Composio, …). Each provider implements its own behavior.
- [Delete a connected account](https://docs.flowra.dev/api-reference/connected-accounts/delete-a-connected-account.md): Disconnects and removes a connected account. It will no longer be available for workflows or API calls. The user can connect again later by going through the OAuth flow.
- [Update a connected account (e.g. display name)](https://docs.flowra.dev/api-reference/connected-accounts/update-a-connected-account-eg-display-name.md): Updates Flowra-only fields on the connection row. Currently supports `displayName` for labeling in the dashboard.
- [List connections grouped by toolkit (dashboard)](https://docs.flowra.dev/api-reference/connected-accounts/list-connections-grouped-by-toolkit-dashboard.md): Returns connections for one external user (default: project default user when eUID is omitted), grouped by toolkit. Supports search `q` over toolkit and connection fields.
- [Create a new auth link session](https://docs.flowra.dev/api-reference/connected-accounts/create-a-new-auth-link-session.md): Generates a one-time URL to start the OAuth flow. Send your end users to this URL so they can sign in with the provider (e.g. Google, Slack) and connect their account to your project. After they complete the flow, the account appears in the connected accounts list.
- [Get all toolkits](https://docs.flowra.dev/api-reference/toolkits/get-all-toolkits.md): List toolkits (groups of related tools) you can attach to workflows and agents. Each toolkit can contain multiple tools (e.g. Slack toolkit, custom API toolkit). Unauthenticated requests only see global (non–project-scoped) toolkits.
- [Create a new toolkit](https://docs.flowra.dev/api-reference/toolkits/create-a-new-toolkit.md): Create a toolkit to group related tools (e.g. “Slack”, “CRM API”). You can then add tools to it and attach the toolkit to workflows and agents.
- [Get toolkit by ID](https://docs.flowra.dev/api-reference/toolkits/get-toolkit-by-id.md): Get details of one toolkit including its name, slug, and metadata. Use to inspect a toolkit before assigning it to a workflow.
- [Delete a toolkit](https://docs.flowra.dev/api-reference/toolkits/delete-a-toolkit.md): Permanently removes a toolkit. Its tools will no longer be available as a group; individual tools may still exist.
- [Update an existing toolkit](https://docs.flowra.dev/api-reference/toolkits/update-an-existing-toolkit.md): Update a toolkit’s name, slug, or other settings. Only the fields you send are changed.
- [Set toolkit active status](https://docs.flowra.dev/api-reference/toolkits/set-toolkit-active-status.md): Enable or disable a toolkit without deleting it. Disabled toolkits and their tools cannot be used in workflows.
- [Get public catalog toolkit by slug](https://docs.flowra.dev/api-reference/toolkits/get-public-catalog-toolkit-by-slug.md): Public detail for a global (non–project-scoped) toolkit, including SEO copy for the marketing page. Disabled and project toolkits are not returned.
- [List toolkit categories](https://docs.flowra.dev/api-reference/toolkits/list-toolkit-categories.md): Returns the fixed list of toolkit categories used for browsing and filtering (e.g. crm, communication). Use with GET /toolkits `category` query.
- [List messaging channels for agent entry points](https://docs.flowra.dev/api-reference/toolkits/list-messaging-channels-for-agent-entry-points.md): Bidirectional messaging channels (Telegram, WhatsApp, Gmail, Slack, Discord, …) from the server registry, joined with available trigger tools. Use for the agent “Choose messaging channel” picker. Channels whose tools are not seeded/visible are omitted.
- [Get toolkits with nested tools](https://docs.flowra.dev/api-reference/toolkits/get-toolkits-with-nested-tools.md): List toolkits including the full list of tools in each. Use when building a tool picker (e.g. for agents or MCP) so users can see which tools belong to which toolkit.
- [List available tools](https://docs.flowra.dev/api-reference/tools/list-available-tools.md): List all tools you can use in workflows and agents. Supports filtering, sorting, and search. Tools can be custom (API calls, scripts) or from toolkits/MCP.
- [Create a new tool](https://docs.flowra.dev/api-reference/tools/create-a-new-tool.md): Create a custom tool (e.g. API call, script, or custom logic) that your workflows and agents can call. Define name, description, and input schema.
- [Get tool by ID](https://docs.flowra.dev/api-reference/tools/get-tool-by-id.md): Get full details of a tool: name, description, input schema, script, and configuration. Use the tool slug or ID when executing or editing the tool.
- [Delete a tool](https://docs.flowra.dev/api-reference/tools/delete-a-tool.md): Permanently removes a tool. It will no longer appear in the tools list or be usable in workflows or agents.
- [Update an existing tool](https://docs.flowra.dev/api-reference/tools/update-an-existing-tool.md): Update a tool’s name, description, input schema, or configuration. Only the fields you send are changed.
- [Set tool active status](https://docs.flowra.dev/api-reference/tools/set-tool-active-status.md): Enable or disable a tool without deleting it. Disabled tools cannot be executed or selected in workflows.
- [Execute tool](https://docs.flowra.dev/api-reference/tools/execute-tool.md): Run a tool by its slug with the arguments you provide. Use this when building agents or automation that need to call tools (e.g. send email, call an API).
- [List tool execution logs](https://docs.flowra.dev/api-reference/tools/list-tool-execution-logs.md): View history of tool runs with status, inputs, and outputs. Use for debugging and monitoring how often tools are called and whether they succeed or fail.
- [Browse skill catalog](https://docs.flowra.dev/api-reference/skills/browse-skill-catalog.md): Without q: platform skills. With q: platform + skills.sh registry, tagged with kind, links, installCount.
- [Create a custom skill](https://docs.flowra.dev/api-reference/skills/create-a-custom-skill.md): Creates a project skill from name, instructions, and optional metadata.
- [Soft-delete a skill](https://docs.flowra.dev/api-reference/skills/soft-delete-a-skill.md): Soft-deletes a skill from My Skills (does not remove platform/registry catalog entries).
- [Get skill by ID](https://docs.flowra.dev/api-reference/skills/get-skill-by-id.md): Returns one skill from My Skills if the caller can access it.
- [Import SKILL.md from GitHub URL](https://docs.flowra.dev/api-reference/skills/import-skillmd-from-github-url.md): Parses a SKILL.md (or skill pack) from a public GitHub URL into My Skills.
- [Add a platform/registry catalog skill to My Skills](https://docs.flowra.dev/api-reference/skills/add-a-platformregistry-catalog-skill-to-my-skills.md): Installs a catalog skill into the current user’s library so it can be attached to agents.
- [List My Skills](https://docs.flowra.dev/api-reference/skills/list-my-skills.md): Skills the current user created or installed (skill_users membership).
- [Install skill from registry / GitHub repo](https://docs.flowra.dev/api-reference/skills/install-skill-from-registry-github-repo.md): Fetches a skill from the skills.sh registry or a GitHub repo and adds it to My Skills.
- [List skills.sh leaderboard](https://docs.flowra.dev/api-reference/skills/list-skillssh-leaderboard.md): Requires SKILLS_SH_API_KEY when available.
- [Search skills.sh registry](https://docs.flowra.dev/api-reference/skills/search-skillssh-registry.md): Public search against skills.sh (no API key required for search).
- [Sync a registry skill from GitHub](https://docs.flowra.dev/api-reference/skills/sync-a-registry-skill-from-github.md): Re-fetches the shared catalog copy from GitHub. No-op when the folder hash already matches. Attached agents pick up the new playbook on the next run.
- [Update a skill](https://docs.flowra.dev/api-reference/skills/update-a-skill.md): Updates fields on a skill the current user owns or has in My Skills.
- [Get executions for a specific workflow](https://docs.flowra.dev/api-reference/workflow-&-agent/get-executions-for-a-specific-workflow.md): List all past runs for one workflow with pagination and filters. Use to see the execution history of a single workflow.
- [Get workflow/agent statistics](https://docs.flowra.dev/api-reference/workflow-&-agent/get-workflowagent-statistics.md): Health, credit min/max/avg per run, tool and model breakdown, triggers, and recent logs for one workflow or agent.
- [Update workflow status](https://docs.flowra.dev/api-reference/workflow-&-agent/update-workflow-status.md): Turn a workflow on (active) or off (inactive). Only lifecycle=ready workflows can be activated. Inactive workflows are not auto-fired by cron/webhooks; manual EXECUTE may still run them for testing.
- [Add connection after OAuth for a workflow](https://docs.flowra.dev/api-reference/workflow-&-agent/add-connection-after-oauth-for-a-workflow.md): Links the connected account to the acting user after OAuth return (`?connectionId=` on the workflow page). Connections are user-scoped.
- [Change workflow connection](https://docs.flowra.dev/api-reference/workflow-&-agent/change-workflow-connection.md): Switch which connected account (OAuth) is used for a given toolkit in this workflow. Use when you want the workflow to run with a different user’s credentials.
- [Clear AuthConfig binding for a toolkit on an agent workflow](https://docs.flowra.dev/api-reference/workflow-&-agent/clear-authconfig-binding-for-a-toolkit-on-an-agent-workflow.md): Removes the AuthConfig this agent uses for a toolkit when end users connect. Does not delete the AuthConfig itself.
- [Clear preferred connected account for a toolkit](https://docs.flowra.dev/api-reference/workflow-&-agent/clear-preferred-connected-account-for-a-toolkit.md): Removes the bound ConnectedAccount for a toolkit on this workflow. Used when disconnecting visitor owner-connections or cron owner binds.
- [Create workflow (agent)](https://docs.flowra.dev/api-reference/workflow-&-agent/create-workflow-agent.md): Create a new agent/workflow with name, tools, system prompt, and model. Can be triggered manually or by schedules/webhooks.
- [Delete workflow](https://docs.flowra.dev/api-reference/workflow-&-agent/delete-workflow.md): Permanently removes a workflow. It can no longer be run or triggered.
- [Get workflow detail](https://docs.flowra.dev/api-reference/workflow-&-agent/get-workflow-detail.md): Returns full configuration of a workflow: name, tools, prompt, model, and connection settings. Use this to inspect or edit a workflow.
- [Trigger workflow execution manually](https://docs.flowra.dev/api-reference/workflow-&-agent/trigger-workflow-execution-manually.md): Start a workflow run immediately with an optional input payload. Returns a thread ID you can use to poll status or resume if the workflow pauses.
- [Get workflow executions list](https://docs.flowra.dev/api-reference/workflow-&-agent/get-workflow-executions-list.md): List past runs of your workflows with filters (status, date range, workflow ID) and pagination. Use to monitor runs and find a specific execution.
- [Get workflow execution detail](https://docs.flowra.dev/api-reference/workflow-&-agent/get-workflow-execution-detail.md): Returns full details of a single run: inputs, outputs, steps executed, status, and any errors. Use to debug or inspect a specific execution.
- [Resume workflow execution](https://docs.flowra.dev/api-reference/workflow-&-agent/resume-workflow-execution.md): Continue a paused workflow run (e.g. after a step that waits for user input or approval). Send the thread ID and any required input to resume.
- [Get execution status by thread ID](https://docs.flowra.dev/api-reference/workflow-&-agent/get-execution-status-by-thread-id.md): Check whether a run is still in progress, completed, or failed. Use the thread ID returned when you started the execution to poll for status.
- [Get workflow list](https://docs.flowra.dev/api-reference/workflow-&-agent/get-workflow-list.md): List your workflows (agents) with pagination and filters. Each workflow can be run manually or by triggers.
- [Bind AuthConfig for a toolkit on an agent workflow](https://docs.flowra.dev/api-reference/workflow-&-agent/bind-authconfig-for-a-toolkit-on-an-agent-workflow.md): Sets which project AuthConfig this agent uses for a given toolkit when end users connect.
- [Update workflow](https://docs.flowra.dev/api-reference/workflow-&-agent/update-workflow.md): Update workflow name, tools, system prompt, model, or other settings. Send only the fields you want to change.
- [Create or update trigger](https://docs.flowra.dev/api-reference/triggers/create-or-update-trigger.md): Create or update a trigger (e.g. cron schedule or webhook) that runs a workflow automatically. Use the trigger slug to identify the trigger type; pass configuration such as schedule or webhook URL.
- [List active triggers](https://docs.flowra.dev/api-reference/triggers/list-active-triggers.md): List your active triggers (scheduled or webhook) with optional filters and pagination. Use to see which workflows are triggered automatically and when.
- [List trigger invocation logs](https://docs.flowra.dev/api-reference/triggers/list-trigger-invocation-logs.md): Unified history of trigger deliveries (connected app, direct webhook, scheduled poll). Scoped to the current project.
- [Replay trigger invocation as webhook](https://docs.flowra.dev/api-reference/triggers/replay-trigger-invocation-as-webhook.md): Re-sends the stored invocation payload through the same webhook pipeline (Composio or local) so workflows run again. Does not execute the trigger tool directly.
- [Delete trigger](https://docs.flowra.dev/api-reference/triggers/delete-trigger.md): Permanently remove a trigger. The workflow will no longer run on that schedule or webhook.
- [Enable or disable trigger](https://docs.flowra.dev/api-reference/triggers/enable-or-disable-trigger.md): Turn a trigger on or off without deleting it. Disabled triggers do not run the workflow until enabled again.
- [Create thread](https://docs.flowra.dev/api-reference/chat/create-thread.md): Create a new conversation thread. Use for chat or agent sessions; each thread has its own history and state.
- [Get thread](https://docs.flowra.dev/api-reference/chat/get-thread.md): Get a thread’s metadata and info. Use to load a conversation before continuing or to show thread details.
- [Delete thread](https://docs.flowra.dev/api-reference/chat/delete-thread.md): Permanently delete a thread and its conversation history. It cannot be recovered.
- [Update thread](https://docs.flowra.dev/api-reference/chat/update-thread.md): Update thread metadata such as title or custom fields. Use to rename a conversation or store tags.
- [Generate thread title](https://docs.flowra.dev/api-reference/chat/generate-thread-title.md): Generate a short title for the thread from its conversation content using AI. Use to display a meaningful title in the thread list.
- [Get thread history](https://docs.flowra.dev/api-reference/chat/get-thread-history.md): Get the execution history for a thread: past runs, steps, and state snapshots. Use to show a timeline or debug a conversation.
- [Send operator channel reply](https://docs.flowra.dev/api-reference/chat/send-operator-channel-reply.md): Send a message to the end user on the originating messaging channel. Requires reply mode human.
- [Set channel reply mode](https://docs.flowra.dev/api-reference/chat/set-channel-reply-mode.md): Take over a messaging-channel thread from the agent (`human`) or hand it back (`agent`). Only applies to trigger/channel conversations.
- [List thread runs](https://docs.flowra.dev/api-reference/chat/list-thread-runs.md): List runs for a thread. Use to find an in-flight run (pending/running) so the client can rejoin its stream after leaving the chat.
- [Cancel run](https://docs.flowra.dev/api-reference/chat/cancel-run.md): Stop a running thread execution (e.g. when the user clicks stop in the chat). Optionally wait for the run to fully stop or rollback.
- [Join run stream](https://docs.flowra.dev/api-reference/chat/join-run-stream.md): Join an existing run’s SSE stream. Use after navigating away so the client can resume live updates without cancelling the run.
- [Stream thread run](https://docs.flowra.dev/api-reference/chat/stream-thread-run.md): Run the agent/chat for this thread and stream the response via Server-Sent Events (SSE). Use for real-time chat UIs; events include message deltas and run status. A final `event: usage` reports credits for this turn and the thread total.
- [Get thread state](https://docs.flowra.dev/api-reference/chat/get-thread-state.md): Get the current state of a thread (e.g. latest messages, checkpoint). Use to resume a conversation or inspect state for debugging.
- [Search threads](https://docs.flowra.dev/api-reference/chat/search-threads.md): Search conversation threads by metadata (e.g. user id, tags). Use to list or filter threads in a chat UI or dashboard.
- [List files](https://docs.flowra.dev/api-reference/file/list-files.md): List files uploaded to your project with pagination and filters. Use to show a file library or pick a file for use in workflows (e.g. knowledge, attachments).
- [Serve file by filename](https://docs.flowra.dev/api-reference/file/serve-file-by-filename.md): Serve a file by its stored filename (e.g. for public or signed URLs). Use when you have the filename from upload response.
- [Delete file](https://docs.flowra.dev/api-reference/file/delete-file.md): Permanently remove a file. It will no longer be available for download or use in workflows.
- [Delete multiple files](https://docs.flowra.dev/api-reference/file/delete-multiple-files.md): Permanently remove one or more files you own in the current project scope. Use for bulk cleanup from the file library.
- [Download file](https://docs.flowra.dev/api-reference/file/download-file.md): Download a file by its ID. Possession of the id is enough (capability URL). Returns the file bytes with the stored content-type.
- [Get file type info](https://docs.flowra.dev/api-reference/file/get-file-type-info.md): Returns allowed file extensions and metadata for a given type (e.g. image, document). Use to validate uploads or show users which formats are accepted.
- [List supported file types](https://docs.flowra.dev/api-reference/file/list-supported-file-types.md): List all supported file types and their allowed extensions. Use to build upload forms or validate file types before uploading.
- [Delete oldest files to free storage](https://docs.flowra.dev/api-reference/file/delete-oldest-files-to-free-storage.md): Removes the oldest files for the current end user in the current project (not automatic). Use when storage quota is full.
- [File storage breakdown](https://docs.flowra.dev/api-reference/file/file-storage-breakdown.md): Returns used storage (KiB) for your whole account, the current project, and the current end user, plus the plan limit in GiB.
- [Upload a single file](https://docs.flowra.dev/api-reference/file/upload-a-single-file.md): Upload a file (image or document) via multipart form. Pass the file type in the URL path. Returns the file ID to use in other APIs (e.g. knowledge, workflows).
- [Get all RAG collections](https://docs.flowra.dev/api-reference/knowledge/get-all-rag-collections.md): Retrieve all knowledge collections for the current project
- [Create an empty knowledge collection](https://docs.flowra.dev/api-reference/knowledge/create-an-empty-knowledge-collection.md): Create a named collection owned by the current end user. Does not add content.
- [Get knowledge collection details](https://docs.flowra.dev/api-reference/knowledge/get-knowledge-collection-details.md): Retrieve metadata, chunk count, and source count for one collection
- [Delete knowledge collection](https://docs.flowra.dev/api-reference/knowledge/delete-knowledge-collection.md): Delete a knowledge collection and all its chunks
- [Rename a knowledge collection](https://docs.flowra.dev/api-reference/knowledge/rename-a-knowledge-collection.md): Updates the display name only. The collection id does not change.
- [List chunks in a knowledge collection](https://docs.flowra.dev/api-reference/knowledge/list-chunks-in-a-knowledge-collection.md): Paginated chunk list, optionally filtered by source key
- [Toggle read-only share with project members via MCP](https://docs.flowra.dev/api-reference/knowledge/toggle-read-only-share-with-project-members-via-mcp.md): When exposeViaMcp is true, other members of this project may list and semantically search this collection read-only via MCP. Writes stay owner-only. The collection still only appears in the owner’s dashboard list.
- [Add an uploaded file to a knowledge collection](https://docs.flowra.dev/api-reference/knowledge/add-an-uploaded-file-to-a-knowledge-collection.md): Extracts text, splits it, embeds, and indexes the file into this collection.
- [Add pasted text to a knowledge collection](https://docs.flowra.dev/api-reference/knowledge/add-pasted-text-to-a-knowledge-collection.md): Splits, embeds, and indexes raw text into this collection.
- [Add a web page to a knowledge collection](https://docs.flowra.dev/api-reference/knowledge/add-a-web-page-to-a-knowledge-collection.md): Fetches the page, splits, embeds, and indexes it into this collection.
- [Semantic search within a knowledge collection](https://docs.flowra.dev/api-reference/knowledge/semantic-search-within-a-knowledge-collection.md): Run similarity search limited to this collection
- [List sources in a knowledge collection](https://docs.flowra.dev/api-reference/knowledge/list-sources-in-a-knowledge-collection.md): Aggregate chunks into file / URL / text sources
- [Delete a source from a knowledge collection](https://docs.flowra.dev/api-reference/knowledge/delete-a-source-from-a-knowledge-collection.md): Remove all chunks belonging to the given source key
- [List collections](https://docs.flowra.dev/api-reference/table/list-collections.md): List your data collections (tables). Use to choose a collection for reading or writing documents via the documents endpoints.
- [Create document](https://docs.flowra.dev/api-reference/table/create-document.md): Create a new document in a collection. Send the document fields as JSON; the response includes the new document ID.
- [Delete document](https://docs.flowra.dev/api-reference/table/delete-document.md): Permanently remove a document from a collection. It cannot be recovered.
- [Update document](https://docs.flowra.dev/api-reference/table/update-document.md): Update one or more fields of a document by collection and document ID. Send only the fields you want to change.
- [Get collection metadata](https://docs.flowra.dev/api-reference/table/get-collection-metadata.md): Get metadata for one collection: name, schema, and document count. Use before querying documents to understand the structure.
- [Delete collection](https://docs.flowra.dev/api-reference/table/delete-collection.md): Permanently delete a collection and all documents in it. Use with care; this cannot be undone.
- [List collection documents](https://docs.flowra.dev/api-reference/table/list-collection-documents.md): List documents in a collection with pagination, sorting, and optional search. Use to display records or feed data into workflows.
- [Toggle read-only share with project members via MCP](https://docs.flowra.dev/api-reference/table/toggle-read-only-share-with-project-members-via-mcp.md): When exposeViaMcp is true, other members of this project may list and read this Mongo-backed collection via MCP. Writes stay owner-only. The collection still only appears in the owner’s dashboard list.
- [Run code in an ephemeral sandbox](https://docs.flowra.dev/api-reference/sandbox/run-code-in-an-ephemeral-sandbox.md): Create → run → kill. Use for tool script previews. Returns a structured status/result payload.
- [Create a durable sandbox session](https://docs.flowra.dev/api-reference/sandbox/create-a-durable-sandbox-session.md): Starts a persistent code sandbox billed for the session lifetime. Default threadId is http:{uuid}.
- [Get sandbox session status](https://docs.flowra.dev/api-reference/sandbox/get-sandbox-session-status.md): Returns ownership-checked session status by ledger session id.
- [Release a sandbox session](https://docs.flowra.dev/api-reference/sandbox/release-a-sandbox-session.md): Kills the sandbox and settles billing for the session.
- [Execute code in a sandbox session](https://docs.flowra.dev/api-reference/sandbox/execute-code-in-a-sandbox-session.md): Runs JavaScript or Python inside an existing live session. The session stays alive after the run.
- [Chat computer status for a thread](https://docs.flowra.dev/api-reference/sandbox/chat-computer-status-for-a-thread.md): Returns power state (off/on/paused) for the agent-thread sandbox. Does not create a sandbox.
- [Power off chat computer for a thread](https://docs.flowra.dev/api-reference/sandbox/power-off-chat-computer-for-a-thread.md): Releases the agent-thread sandbox and stops billing for it.
- [Warm-start chat computer for a thread](https://docs.flowra.dev/api-reference/sandbox/warm-start-chat-computer-for-a-thread.md): Optional manual power-on: prepare/resume the agent-thread sandbox. Agents also auto-start on real FS/execute need.
- [Close live browser session](https://docs.flowra.dev/api-reference/browser/close-live-browser-session.md): Flushes profile when possible, stops billing, and ends the Browserbase session.
- [Browser session status](https://docs.flowra.dev/api-reference/browser/browser-session-status.md): Alive flag, live-pulse, and official liveViewUrl when available.
- [Heartbeat for open browser panel](https://docs.flowra.dev/api-reference/browser/heartbeat-for-open-browser-panel.md): Keeps the Live pulse fresh while the panel is open (including minimized). Does not extend hosted-session idle lifetime — idle is based on agent/user activity.
- [Live browser panel (iframe)](https://docs.flowra.dev/api-reference/browser/live-browser-panel-iframe.md): Embeds the live browser viewer for this session. Requires auth.
- [Chat with conversation history](https://docs.flowra.dev/api-reference/llm/chat-with-conversation-history.md): Send a list of messages (user/assistant/system) and get the next assistant reply. Use for multi-turn conversations.
- [Generate text](https://docs.flowra.dev/api-reference/llm/generate-text.md): Send a prompt and receive generated text from the configured LLM. Use for one-off completions, chat replies, or any task that needs AI-generated text. Supports long prompts.
- [Get apiv1aimodels](https://docs.flowra.dev/api-reference/llm/get-apiv1aimodels.md): Get models - returns all for admin, active only for others
- [Hosted MCP SSE endpoint](https://docs.flowra.dev/api-reference/mcp/hosted-mcp-sse-endpoint.md): Same as GET /mcp/{serverId} for the project’s default META server. Authenticate with x-api-key or MCP OAuth.
- [Hosted MCP JSON-RPC endpoint](https://docs.flowra.dev/api-reference/mcp/hosted-mcp-json-rpc-endpoint.md): Same as POST /mcp/{serverId}, but routes to the project’s default META server (created on first use). Authenticate with x-api-key or MCP OAuth (Authorization: Bearer). Optional x-username.
- [List MCP servers](https://docs.flowra.dev/api-reference/mcp/list-mcp-servers.md): List your registered MCP servers with pagination. Each server exposes a set of tools that can be used in workflows and agents.
- [Create a new MCP server](https://docs.flowra.dev/api-reference/mcp/create-a-new-mcp-server.md): Register a new MCP (Model Context Protocol) server by URL and optional headers. Once registered, its tools can be used in workflows and agents. MCP is a standard for exposing tools to AI applications.
- [Get MCP server by ID](https://docs.flowra.dev/api-reference/mcp/get-mcp-server-by-id.md): Get connection details and metadata for one MCP server. Use to inspect URL, headers, or status before using its tools.
- [Delete MCP server](https://docs.flowra.dev/api-reference/mcp/delete-mcp-server.md): Remove an MCP server. Its tools will no longer be available in the tools list or for use in workflows and agents.
- [Update MCP server](https://docs.flowra.dev/api-reference/mcp/update-mcp-server.md): Update an MCP server’s URL, name, headers, or other settings. Use when the server URL or auth changes.
- [Get MCP server config (tools list)](https://docs.flowra.dev/api-reference/mcp/get-mcp-server-config-tools-list.md): Get the list of tools exposed by this MCP server in standard format (name, description, input schema). Use to build a tool picker or to call tools via the MCP JSON-RPC endpoint.
- [Clear AuthConfig binding for a toolkit on an MCP server](https://docs.flowra.dev/api-reference/mcp/clear-authconfig-binding-for-a-toolkit-on-an-mcp-server.md): Removes the AuthConfig this MCP server uses for a toolkit. Does not delete the AuthConfig itself.
- [Bind AuthConfig for a toolkit on an MCP server](https://docs.flowra.dev/api-reference/mcp/bind-authconfig-for-a-toolkit-on-an-mcp-server.md): Sets which project AuthConfig this MCP server uses for a given toolkit when end users connect.
- [MCP SSE endpoint](https://docs.flowra.dev/api-reference/mcp/mcp-sse-endpoint.md): SSE (Server-Sent Events) endpoint for MCP clients that use the streaming transport. The response includes the POST URL to use for JSON-RPC requests. Use the same serverId as in the MCP server list.
- [MCP JSON-RPC endpoint](https://docs.flowra.dev/api-reference/mcp/mcp-json-rpc-endpoint.md): Send MCP (Model Context Protocol) JSON-RPC 2.0 requests to the specified server. Use for methods like tools/list and tools/call. Pass the server ID you got when registering the MCP server. Authenticate with x-api-key or MCP OAuth.
- [Agent as MCP SSE endpoint](https://docs.flowra.dev/api-reference/mcp/agent-as-mcp-sse-endpoint.md): SSE transport for the per-agent MCP server. Same agentId as POST /mcp/agents/{agentId}.
- [Agent as MCP JSON-RPC endpoint](https://docs.flowra.dev/api-reference/mcp/agent-as-mcp-json-rpc-endpoint.md): Expose one Flowra agent as an MCP server. tools/list returns a single ask tool. Authenticate with x-api-key or MCP OAuth. Optional x-username.
- [Credit usage ledger (API key)](https://docs.flowra.dev/api-reference/usage/credit-usage-ledger-api-key.md): Paginated credit usage for the authenticated project. Filter by workflow, execution, thread, or external user.
- [Credit balance (API key)](https://docs.flowra.dev/api-reference/usage/credit-balance-api-key.md): Current credit balance for the account tied to the API key.
- [Usage for one execution](https://docs.flowra.dev/api-reference/usage/usage-for-one-execution.md): Net credits and breakdown for a single workflow_execution_logs row.
- [API keys](https://docs.flowra.dev/api-keys.md): Create and manage API keys for the Flowra API
- [External users](https://docs.flowra.dev/guides/external-users.md): List and look up end users (external users) for your project
- [Toolkits](https://docs.flowra.dev/guides/toolkits.md): List and search toolkits via the API. Toolkits group tools (e.g. Slack, Gmail) for use in agents and workflows.

## OpenAPI Specs

- [openapi](/api-reference/openapi.json)

## Optional

- [Dashboard](https://flowra.dev/dashboard)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.