# Flowiseai — how to use (mcp.ai)

Connect your Flowiseai account and use 29 tools for AI agents straight from your AI agent. Connect with your own API key. FlowiseAI is an open-source generative AI development platform for building AI Agents and LLM workflows.

## Option A — via MCP (recommended)
Remote MCP endpoint (HTTP, streamable): `https://api.mcp.ai/p_flowiseai?ms=1787295960000`
Add it as a custom/remote MCP connector in your client (Claude, Cursor, VS Code…), then authenticate when prompted. Once connected, ask the agent to use the server's tools (e.g. `flowiseai_clone_chatflow`).

## Option B — via direct REST API
Base URL: `https://api.mcp.ai/api/flowiseai`
Auth: `Authorization: Bearer sk_live_…` — create a workspace API key at https://mcp.ai/settings/api-keys
Discover endpoints: `GET https://api.mcp.ai/api/flowiseai/_endpoints`

### Endpoints
- `POST https://api.mcp.ai/api/flowiseai/clone/chatflow` — Tool to clone an existing chatflow. Use when you need to duplicate a chatflow by its ID.
  - body: { id: string }
- `POST https://api.mcp.ai/api/flowiseai/create/chatflow` — Creates a new chatflow in FlowiseAI. Chatflows are visual workflows that define AI agent behavior using nodes and edges. Use this to programmatically create single-agent (CHATFLOW) or multi-agent (MUL
  - body: { name: string, type?: string, analytic?: string, apikeyid?: string, category?: string, deployed?: boolean, flowData?: string, isPublic?: boolean, apiConfig?: string, speechToText?: string, chatbotConfig?: string }
- `POST https://api.mcp.ai/api/flowiseai/create/document/store` — Creates a new document store in FlowiseAI. Document stores are used to manage embeddings and vector data for AI applications. Use this to programmatically create storage for documents that will be emb
  - body: { name: string, status?: string, loaders?: string, description?: string, embeddingConfig?: string, vectorStoreConfig?: string, recordManagerConfig?: string }
- `POST https://api.mcp.ai/api/flowiseai/create/lead` — Tool to create a new lead in a chatflow. Use when you need to capture lead information from a chat session for follow-up or CRM integration.
  - body: { name?: string, email?: string, phone?: string, chatId?: string, chatflowid: string }
- `POST https://api.mcp.ai/api/flowiseai/create/tool` — Tool to create a new FlowiseAI tool. Use when you need to create a custom tool with specific name, description, and color. Optionally provide icon URL, JSON schema, or JavaScript function code.
  - body: { func?: string, name: string, color: string, schema?: string, iconSrc?: string, description: string }
- `POST https://api.mcp.ai/api/flowiseai/create/variable` — Creates a new variable in FlowiseAI. Variables are used to store configuration values, API keys, and other data that can be referenced across chatflows. Use this to programmatically create string or n
  - body: { name: string, type: string, value?: string }
- `POST https://api.mcp.ai/api/flowiseai/delete/chat/messages` — Tool to delete chat messages for a specific chatflow. Use when you need to remove messages based on optional filters. Use after confirming the chatflow ID.
  - body: { id: string, chatId?: string, endDate?: string, chatType?: string, sessionId?: string, startDate?: string, hardDelete?: boolean, memoryType?: string, feedbackType?: string }
- `POST https://api.mcp.ai/api/flowiseai/delete/chatflow` — Tool to delete a chatflow by its ID. Use after confirming the chatflow ID is correct.
  - body: { id: string }
- `POST https://api.mcp.ai/api/flowiseai/delete/document/store` — Tool to delete a specific document store by its ID. Use when you need to permanently remove a document store. This action is destructive and cannot be undone.
  - body: { id: string }
- `POST https://api.mcp.ai/api/flowiseai/delete/tool/by/id` — Permanently deletes a FlowiseAI tool by its unique ID. This action is destructive and cannot be undone. Use FLOWISEAI_LIST_ALL_TOOLS first to verify the correct tool ID before deletion.
  - body: { id: string }
- `POST https://api.mcp.ai/api/flowiseai/delete/variable` — Tool to delete a variable by its unique ID. Use when you need to permanently remove a variable from FlowiseAI.
  - body: { id: string }
- `POST https://api.mcp.ai/api/flowiseai/edit/document/store/file/chunk` — Tool to update a specific chunk in a FlowiseAI document store. Use when you need to modify the content or metadata of an existing chunk. At least one of pageContent or metadata must be provided.
  - body: { chunkId: string, storeId: string, loaderId: string, metadata?: object, pageContent?: string }
- `POST https://api.mcp.ai/api/flowiseai/get/all/chat/message/feedback` — Tool to list all chat message feedbacks for a chatflow. Use when you need to view feedback given on messages in a specific chatflow.
  - body: { id: string, chatId?: string, endDate?: string, sortOrder?: string, startDate?: string }
- `POST https://api.mcp.ai/api/flowiseai/get/all/chatflows` — Retrieves all chatflows from the authenticated FlowiseAI account. Use this to list available chatflows, get their IDs for subsequent operations (like update, delete, export), or check chatflow deploym
- `POST https://api.mcp.ai/api/flowiseai/get/all/leads/for/chatflow` — Tool to retrieve all leads for a specific chatflow. Use when you need to see lead information collected from a chatflow's interactions.
  - body: { id: string }
- `POST https://api.mcp.ai/api/flowiseai/get/all/upsert/history` — Tool to retrieve all upsert history records for a specific chatflow. Use when you need to view the history of upsert operations.
  - body: { id: string, order?: string, endDate?: string, startDate?: string }
- `POST https://api.mcp.ai/api/flowiseai/get/all/variables` — Tool to retrieve a list of all variables. Use when you need to list all variables available in the FlowiseAI workspace. Returns an empty list if no variables exist.
- `POST https://api.mcp.ai/api/flowiseai/get/document/store/by/id` — Tool to retrieve a document store by its ID. Use when you have a document store ID and need its full details including configuration and status.
  - body: { id: string }
- `POST https://api.mcp.ai/api/flowiseai/get/document/store/file/chunks` — Tool to get chunks from a specific document loader. Use when you need to retrieve chunked content from a document in a FlowiseAI document store.
  - body: { page_no: string, store_id: string, loader_id: string }
- `POST https://api.mcp.ai/api/flowiseai/get/single/chatflow` — Tool to retrieve a chatflow by its ID. Use when you have a chatflow ID and need its full details.
  - body: { id: string }
- `POST https://api.mcp.ai/api/flowiseai/get/tool/by/id` — Tool to retrieve a specific FlowiseAI tool by its ID. Use when you need detailed metadata of a tool before interacting with it.
  - body: { id: string }
- `POST https://api.mcp.ai/api/flowiseai/list/all/tools` — Tool to retrieve a list of all tools. Use when you need to list every tool available after authentication.
- `POST https://api.mcp.ai/api/flowiseai/list/assistants` — Tool to retrieve a list of all assistants. Use when you need to list every assistant available in the authenticated FlowiseAI account.
- `POST https://api.mcp.ai/api/flowiseai/list/chat/messages` — Tool to list chat messages of a chatflow. Use after selecting a chatflow when you need to view its messages.
  - body: { id: string, order?: string, chatId?: string, endDate?: string, chatType?: string, feedback?: boolean, sessionId?: string, startDate?: string, memoryType?: string, feedbackType?: string }
- `POST https://api.mcp.ai/api/flowiseai/ping/server` — Tool to ping the FlowiseAI server to verify it is running and accessible. Use this to perform a health check before executing other operations or to diagnose connectivity issues.
- `POST https://api.mcp.ai/api/flowiseai/update/chatflow/details` — Tool to update details of an existing chatflow. Use when you have confirmed the chatflow ID and want to modify its fields.
  - body: { id: string, name?: string, analytic?: string, apikeyid?: string, category?: string, deployed?: boolean, flowData?: string, isPublic?: boolean, apiConfig?: string, speechToText?: string, chatbotConfig?: string }
- `POST https://api.mcp.ai/api/flowiseai/update/document/store` — Tool to update a specific document store. Use when you need to modify properties of an existing document store.
  - body: { id: string, name?: string, status?: string, loaders?: string, description?: string, embeddingConfig?: string, vectorStoreConfig?: string, recordManagerConfig?: string }
- `POST https://api.mcp.ai/api/flowiseai/update/tool/by/id` — Updates a FlowiseAI tool's properties by its ID. Use this to modify tool name, description, color, icon, JSON schema, or JavaScript function code. Requires the tool's UUID from LIST_ALL_TOOLS or GET_T
  - body: { id: string, func?: string, name?: string, color?: string, schema?: string, iconSrc?: string, description?: string }
- `POST https://api.mcp.ai/api/flowiseai/update/variable` — Tool to update a variable by its ID. Use when you need to modify a variable's name, value, or type.
  - body: { id: string, name?: string, type?: string, value?: string }

## Example prompts
- "What can I do in Flowiseai?"
- "Show me a summary of my Flowiseai account"

## More
- Page: https://mcp.ai/flowiseai
- Agent spec (llms.txt): https://mcp.ai/flowiseai/llms.txt
- Postman collection: https://mcp.ai/flowiseai/postman.json
