Skip to main content
Flowiseai logo
  • Category: ai agents
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 29
  • Triggers: 0
  • Slug: FLOWISEAI
  • Version: 20261101_00

Tools

Slug: FLOWISEAI_CLONE_CHATFLOWClone a chatflow by ID. If fallback creation encounters a flow limit, the tool may delete another chatflow to free capacity and retry.

Input Parameters

string
required
UUID of the chatflow to clone

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FLOWISEAI_CREATE_CHATFLOWCreates 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 (MULTIAGENT) flows. Only ‘name’ is required; type defaults to ‘CHATFLOW’ and flowData defaults to an empty flow structure.

Input Parameters

string
required
Name for the chatflow. Required.
string ("CHATFLOW" | "MULTIAGENT")
Type of chatflow: ‘CHATFLOW’ for single-agent or ‘MULTIAGENT’ for multi-agent flows.
string
JSON string for analytics settings.
string
API key identifier to attach to this chatflow.
string
Semicolon-delimited categories, e.g., ‘support;sales’.
boolean
Whether the chatflow should be deployed immediately.
string
JSON string representing the flow definition with nodes and edges arrays. Required by API.
boolean
Make the chatflow public if true.
string
JSON string for external API configuration.
string
JSON string for speech-to-text configuration.
string
JSON string for chatbot-specific configuration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FLOWISEAI_CREATE_DOCUMENT_STORECreates 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 embedded and searched.

Input Parameters

string
required
Name of the document store. Required.
string ("EMPTY" | "SYNC" | "SYNCING" | "STALE" | "NEW" | "UPSERTING" | "UPSERTED")
Status values for a document store.
string
Loaders associated with the document store, stored as JSON string.
string
Description of the document store.
string
Configuration for the embedding, stored as JSON string.
string
Configuration for the vector store, stored as JSON string.
string
Configuration for the record manager, stored as JSON string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FLOWISEAI_CREATE_LEADTool 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.

Input Parameters

string
Name of the lead
string
Email address of the lead
string
Phone number of the lead
string
ID of the chat session the lead is associated with
string
required
ID of the chatflow the lead is associated with. Use FLOWISEAI_GET_ALL_CHATFLOWS to get valid chatflow IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FLOWISEAI_CREATE_TOOLTool 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.

Input Parameters

string
JavaScript function code that implements the tool’s execution logic.
string
required
Display name of the tool. This should be a clear, descriptive name.
string
required
Hex color code for the tool’s visual display (format: #RRGGBB).
string
JSON schema string defining the tool’s input parameters. Must be valid JSON.
string
URL pointing to the tool’s icon image.
string
required
Human-readable description explaining what the tool does.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FLOWISEAI_CREATE_VARIABLECreates 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 number variables with optional values.

Input Parameters

string
required
Name of the variable. Required.
string
required
Type of the variable (e.g., string, number). Required.
string
Value of the variable. Can be null.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FLOWISEAI_DELETE_CHATFLOWTool to delete a chatflow by its ID. Use after confirming the chatflow ID is correct.

Input Parameters

string
required
The unique identifier (UUID) of the chatflow to delete. Get this from the get_all_chatflows or get_single_chatflow actions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FLOWISEAI_DELETE_CHAT_MESSAGESTool 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.

Input Parameters

string
required
The UUID of the chatflow to delete messages from. Get this from FLOWISEAI_GET_ALL_CHATFLOWS or FLOWISEAI_GET_SINGLE_CHATFLOW.
string
Filter by specific chat ID
string
ISO-8601 end timestamp, e.g., 2025-01-13T11:28:36.000Z
string ("INTERNAL" | "EXTERNAL")
Filter by chat type
string
Filter by session ID
string
ISO-8601 start timestamp, e.g., 2025-01-01T11:28:36.000Z
boolean
Whether to perform hard delete including third-party storage
string
Filter by memory type, e.g., ‘Buffer Memory’
string ("THUMBS_UP" | "THUMBS_DOWN")
Filter by feedback type

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FLOWISEAI_DELETE_DOCUMENT_STORETool 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.

Input Parameters

string
required
The unique identifier (UUID) of the document store to delete. This is the document store ID that you want to permanently remove.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FLOWISEAI_DELETE_TOOL_BY_IDPermanently 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.

Input Parameters

string
required
The unique UUID identifier of the tool to delete. Use FLOWISEAI_LIST_ALL_TOOLS to get available tool IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FLOWISEAI_DELETE_VARIABLETool to delete a variable by its unique ID. Use when you need to permanently remove a variable from FlowiseAI.

Input Parameters

string
required
The unique UUID identifier of the variable to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FLOWISEAI_EDIT_DOCUMENT_STORE_FILE_CHUNKTool 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.

Input Parameters

string
required
UUID of the specific chunk to update. Get this from chunk listing endpoints.
string
required
UUID of the document store containing the chunk. Get this from document store listing endpoints.
string
required
UUID of the document loader that processed this chunk. Get this from loader listing endpoints.
object
Dictionary of metadata key-value pairs (all values must be strings). Use to store custom attributes like author, date, tags, etc.
string
Updated text content for the chunk. Supports Unicode and special characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FLOWISEAI_GET_ALL_CHATFLOWSRetrieves 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 deployment status. Returns an empty list if no chatflows exist.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FLOWISEAI_GET_ALL_CHAT_MESSAGE_FEEDBACKTool to list all chat message feedbacks for a chatflow. Use when you need to view feedback given on messages in a specific chatflow.

Input Parameters

string
required
Chatflow ID (UUID format) to retrieve feedbacks for. Use FLOWISEAI_GET_ALL_CHATFLOWS to get valid IDs.
string
Filter feedbacks by specific chat session ID
string
Filter feedbacks up to this date (ISO 8601 format)
string ("asc" | "desc")
Sort order for feedbacks.
string
Filter feedbacks starting from this date (ISO 8601 format)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FLOWISEAI_GET_ALL_LEADS_FOR_CHATFLOWTool to retrieve all leads for a specific chatflow. Use when you need to see lead information collected from a chatflow’s interactions.

Input Parameters

string
required
Chatflow ID to retrieve leads for. Get this from ‘Get All Chatflows’ action or from the FlowiseAI dashboard URL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FLOWISEAI_GET_ALL_UPSERT_HISTORYTool to retrieve all upsert history records for a specific chatflow. Use when you need to view the history of upsert operations.

Input Parameters

string
required
Chatflow ID to filter records by. Use ‘Get All Chatflows’ action to retrieve valid chatflow IDs.
string ("ASC" | "DESC")
Sort order for upsert history records.
string
Filter records until this end date (inclusive). ISO 8601 format recommended (e.g., ‘2024-12-31T23:59:59Z’).
string
Filter records from this start date (inclusive). ISO 8601 format recommended (e.g., ‘2024-01-01T00:00:00Z’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FLOWISEAI_GET_ALL_VARIABLESTool 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FLOWISEAI_GET_DOCUMENT_STORE_BY_IDTool 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.

Input Parameters

string
required
UUID of the document store to retrieve. Get this from document store list or from the FlowiseAI dashboard URL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FLOWISEAI_GET_DOCUMENT_STORE_FILE_CHUNKSRetrieves a page of chunks from a specific document loader in a FlowiseAI document store, using the store ID, loader ID, and page number.

Input Parameters

string
required
Pagination number to retrieve. Use ‘1’ for the first page.
string
required
Document Store ID (UUID format) to retrieve chunks from.
string
required
Document loader ID (UUID format) within the document store.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FLOWISEAI_GET_SINGLE_CHATFLOWTool to retrieve a chatflow by its ID. Use when you have a chatflow ID and need its full details.

Input Parameters

string
required
UUID of the chatflow to retrieve. Get this from ‘Get All Chatflows’ action or from the FlowiseAI dashboard URL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FLOWISEAI_GET_TOOL_BY_IDTool to retrieve a specific FlowiseAI tool by its ID. Use when you need detailed metadata of a tool before interacting with it.

Input Parameters

string
required
The UUID of the FlowiseAI tool to retrieve. Get this ID from the FLOWISEAI_LIST_ALL_TOOLS action or from a previous tool creation response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FLOWISEAI_LIST_ALL_TOOLSTool to retrieve a list of all tools. Use when you need to list every tool available after authentication.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FLOWISEAI_LIST_ASSISTANTSTool to retrieve a list of all assistants. Use when you need to list every assistant available in the authenticated FlowiseAI account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FLOWISEAI_LIST_CHAT_MESSAGESTool to list chat messages of a chatflow. Use after selecting a chatflow when you need to view its messages.

Input Parameters

string
required
Chatflow ID (UUID format) to retrieve messages for. Use FLOWISEAI_GET_ALL_CHATFLOWS to get valid IDs.
string ("ASC" | "DESC")
Sort order of messages. Values: ASC or DESC
string
Filter by specific chat session ID
string
Filter messages created on or before this ISO 8601 date-time
string ("INTERNAL" | "EXTERNAL")
Filter by chat type. Values: INTERNAL or EXTERNAL
boolean
Filter by whether feedback was provided
string
Filter by session identifier
string
Filter messages created on or after this ISO 8601 date-time
string
Filter by memory type, e.g., ‘Buffer Memory’
string ("THUMBS_UP" | "THUMBS_DOWN")
Filter by type of feedback when feedback=true. Values: THUMBS_UP or THUMBS_DOWN

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FLOWISEAI_PING_SERVERPings the FlowiseAI server for a basic connectivity check. On an HTTP 200 response, returns the response text and a status of running.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FLOWISEAI_UPDATE_CHATFLOW_DETAILSTool to update details of an existing chatflow. Use when you have confirmed the chatflow ID and want to modify its fields.

Input Parameters

string
required
UUID of the chatflow to update (required). Get this from FLOWISEAI_GET_ALL_CHATFLOWS or FLOWISEAI_GET_SINGLE_CHATFLOW.
string
New display name for the chatflow
string
JSON string for analytics and usage tracking settings
string
UUID of the API key to associate with this chatflow
string
Semicolon-delimited categories for organizing chatflows (e.g., ‘support;faq;sales’)
boolean
Set to true to deploy/activate the chatflow, false to undeploy
string
JSON string containing the flow graph with nodes and edges. Must be valid JSON.
boolean
Set to true to make chatflow publicly accessible without authentication
string
JSON string for API endpoint configuration settings
string
JSON string for speech-to-text input configuration
string
JSON string for chatbot UI settings like welcome message, avatar, theme

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FLOWISEAI_UPDATE_DOCUMENT_STORETool to update a specific document store. Use when you need to modify properties of an existing document store.

Input Parameters

string
required
UUID of the document store to update (required).
string
New name for the document store.
string ("EMPTY" | "SYNC" | "SYNCING" | "STALE" | "NEW" | "UPSERTING" | "UPSERTED")
Status of the document store.
string
Loaders associated with the document store, stored as JSON string. Must be valid JSON.
string
New description of the document store.
string
Configuration for the embedding, stored as JSON string. Must be valid JSON.
string
Configuration for the vector store, stored as JSON string. Must be valid JSON.
string
Configuration for the record manager, stored as JSON string. Must be valid JSON.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FLOWISEAI_UPDATE_TOOL_BY_IDUpdates 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_TOOL_BY_ID. At least one field must be provided for update.

Input Parameters

string
required
UUID of the tool to update. Get this from LIST_ALL_TOOLS or GET_TOOL_BY_ID.
string
JavaScript function code that implements the tool’s logic.
string
New display name for the tool. Supports Unicode characters.
string
Hex color code for the tool’s visual display (format: #RRGGBB).
string
JSON schema string defining the tool’s input parameters. Must be valid JSON.
string
URL pointing to the tool’s icon image.
string
New description explaining what the tool does. Supports Unicode and emojis.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FLOWISEAI_UPDATE_VARIABLETool to update a variable by its ID. Use when you need to modify a variable’s name, value, or type.

Input Parameters

string
required
UUID of the variable to update. Get this from LIST_VARIABLES action or the FlowiseAI dashboard.
string
New name for the variable. Variable names are case-sensitive.
string
Type of the variable (e.g., ‘string’, ‘number’, ‘boolean’). Determines how the value is interpreted.
string
New value for the variable. Can be null. For number types, provide the numeric value as a string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not