Skip to main content
Voiceflow logo
  • Category: ai agents
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 20
  • Triggers: 0
  • Slug: VOICEFLOW
  • Version: 20261030_00

Tools

Slug: VOICEFLOW_CREATE_VARIABLECreate one user-defined variable in a Voiceflow project environment and return its assigned ID and configuration.

Input Parameters

string
required
Unique variable name used by the agent.
string
Editor display color as a six-digit hex color string.
string
required
Project in which to create the variable.
string
Short explanation of what the variable stores.
string
Initial value at the start of a conversation.
string
required
Environment alias in which to create the variable, such as main.

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: VOICEFLOW_DELETE_VARIABLEPermanently delete one user-defined variable by ID. Use only after confirming it is not a system variable or referenced by the agent.

Input Parameters

string
required
Project that owns the variable.
string
required
User-defined variable ID to permanently delete.
string
required
Environment alias that owns the variable, such as main.

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: VOICEFLOW_EXPORT_ENVIRONMENTReturn a complete JSON snapshot of one Voiceflow environment, including agent, workflows, tools, functions, variables, and knowledge-base records.

Input Parameters

string
required
Project that owns the environment.
string
required
Alias of the environment to export.

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: VOICEFLOW_GET_AGENT_CONFIGReturn one project environment’s agent configuration; optionally include its large global prompt and instructions.

Input Parameters

string
required
Project whose agent configuration to read.
boolean
Set true to include the global prompt, which can be very large; omitted defaults to false.
string
required
Environment alias to read, such as main.
boolean
Set true to include the agent instructions, which can be very large; omitted defaults to false.

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: VOICEFLOW_GET_CONVERSATION_STATERead a user’s Voiceflow conversation variables, storage, and execution stack for a draft or published environment.

Input Parameters

string
required
Stable conversation user ID.
string ("draft" | "published")
Environment version whose state to read.
string
required
Project that owns the conversation.
string
required
Environment alias that owns the conversation, such as main.

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: VOICEFLOW_GET_TRANSCRIPTReturn one transcript with its full conversation logs, properties, evaluations, and recording URL.

Input Parameters

string
required
Project that owns the transcript.
string
required
Transcript ID returned by Search Transcripts.

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: VOICEFLOW_IMPORT_KNOWLEDGE_DOCUMENT_FROM_URLCrawl one public web URL into a Voiceflow knowledge base and return the created document and ingestion status. This may consume knowledge-base quota.

Input Parameters

string
required
Public HTTP or HTTPS web page URL to crawl and ingest.
array
Metadata fields used to filter this document during retrieval.
string
required
Project whose knowledge base should receive the document.
string ("daily" | "weekly" | "monthly" | "never")
How often Voiceflow should recrawl the URL.
integer
Maximum tokens per generated chunk, from 500 through 1500.
string
required
Environment alias whose knowledge base should receive the document.
boolean
Whether Voiceflow converts HTML to Markdown before chunking.

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: VOICEFLOW_LIST_AGENT_COMPONENTSList playbooks, API tools, functions, project-level evaluations, MCP servers or tools, attached tools, or tests for a Voiceflow project and, where applicable, an environment.

Input Parameters

string ("api" | "mcp" | "function" | "integration")
For attached_tool only, optionally filter by underlying api, mcp, function, or integration tool type.
string
required
Project whose components to list.
string
For attached_tool with attachment_target=playbook, the target playbook ID.
string
For mcp_tool only, optionally restrict results to one MCP server ID.
string ("playbook" | "api_tool" | "function" | "evaluation" | "mcp_server" | "mcp_tool" | "attached_tool" | "test")
required
Kind of component to return: playbook, api_tool, function, evaluation, mcp_server, mcp_tool, attached_tool, or test.
string ("agent" | "playbook")
For attached_tool only, choose agent for agent-level attachments or playbook for one playbook’s attachments.
string
Environment alias, such as main. Required for every component type except project-level evaluations.

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: VOICEFLOW_LIST_ENVIRONMENTSReturn a project’s environments, aliases, release history, and live traffic percentages.

Input Parameters

string
required
Project ID returned by List Projects.

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: VOICEFLOW_LIST_KNOWLEDGE_DOCUMENTSReturn all knowledge-base documents in one project environment with their IDs, sources, ingestion status, and chunking settings.

Input Parameters

string
required
Project whose knowledge-base documents to list.
string
required
Environment alias whose documents to list.

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: VOICEFLOW_LIST_PROJECTSReturn every Voiceflow project in one workspace, including project IDs used by agent, runtime, and authoring tools.

Input Parameters

string
required
Workspace ID returned by List Workspaces.

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: VOICEFLOW_LIST_VARIABLESReturn system and user-defined variables in one project environment with IDs, defaults, descriptions, and ownership flags.

Input Parameters

string
required
Project whose variables to list.
string
required
Environment alias whose variables to list.

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: VOICEFLOW_LIST_WORKSPACESReturn every Voiceflow workspace accessible to the connected account, including IDs needed to list projects.

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: VOICEFLOW_PUBLISH_ENVIRONMENTPublish a Voiceflow environment as a named release. This changes the version available to published conversations, is externally visible, creates a persistent release, and is not automatically reversible. Requires explicit confirmation through confirm_publish=true.

Input Parameters

string
required
Project that owns the environment.
string
Optional description of the changes in this release.
string
required
Name for the release created by publishing.
boolean
required
Required confirmation of the production-visible side effect. Set to true only after confirming that this should publish the selected environment, change the version used by published conversations, and create a persistent release that is not automatically reversible.
string
required
Alias of the environment to publish, such as main.

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: VOICEFLOW_QUERY_KNOWLEDGE_BASERetrieve relevant document chunks and optionally synthesize an answer from a project’s draft or published Voiceflow knowledge base. Answer synthesis may consume model usage.

Input Parameters

object
Optional metadata filters restricting which document chunks are eligible.
string ("draft" | "published")
Knowledge-base version to query.
string
required
Natural-language question to answer from the knowledge base.
boolean
Whether to synthesize an answer instead of returning retrieval chunks only.
string
required
Project whose knowledge base to query.
integer
Maximum number of document chunks to retrieve, from 1 through 30.
string
Additional instruction applied when synthesizing the answer.
string
required
Environment alias whose knowledge base to query, such as main.

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: VOICEFLOW_QUERY_PROJECT_ANALYTICSReturn one Voiceflow project-level analytics metric as a time series for a requested date range and interval.

Input Parameters

string ("call_count" | "call_duration" | "transcript_count" | "transcript_cost" | "interaction_count" | "token_usage" | "unique_user_count")
required
Project metric to return: call_count, call_duration, transcript_count, transcript_cost, interaction_count, token_usage, or unique_user_count.
string ("draft" | "published")
Optional environment-version filter; omit to include both versions.
string
required
Inclusive UTC end timestamp in ISO 8601 format.
string ("hour" | "day" | "week" | "month")
required
Time bucket size for returned rows.
string
Optional IANA timezone used to bucket intervals.
string
required
Project whose analytics metric to query.
string
required
Inclusive UTC start timestamp in ISO 8601 format.
string ("Host" | "Build" | "Test" | "Monitor")
For transcript_cost only, optionally filter by Voiceflow usage class.
string
Optional environment alias filter; omit to aggregate all environments.

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: VOICEFLOW_SEARCH_TRANSCRIPTSSearch a project’s conversation transcripts by time, environment, version, session, and transcript-property filters, returning one bounded page.

Input Parameters

integer
Maximum transcripts in this page (1-100).
integer
Number of matching transcripts to skip; pass next_offset from the previous response.
array
Optional Voiceflow transcript-property filters.
string ("draft" | "published")
Optional environment-version filter.
string
Inclusive UTC end timestamp in ISO 8601 format.
string
required
Project whose transcripts to search.
string
Optional conversation session ID filter.
string
Inclusive UTC start timestamp in ISO 8601 format.
string
Optional environment alias filter.

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: VOICEFLOW_SEND_CONVERSATION_MESSAGESend one text turn to a Voiceflow agent and return its typed response traces; this invokes the agent and may consume model usage.

Input Parameters

string
required
User text to send to the agent.
string
required
Stable caller-chosen conversation ID; reuse it to continue the same user’s state.
string ("draft" | "published")
Environment version to run.
string
required
Project whose agent should handle the turn.
string
Existing session ID to continue when one is known.
string
required
Environment alias whose agent should handle the turn.

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: VOICEFLOW_UPDATE_CONVERSATION_VARIABLESMerge named variable values into one user’s existing conversation state without replacing storage or the execution stack.

Input Parameters

string
required
Stable conversation user ID whose variables should be updated.
string ("draft" | "published")
Environment version whose session variables to update.
object
required
Non-empty mapping of existing Voiceflow variable names to JSON-compatible values. Supplied values are merged into the conversation’s variables.
string
required
Project that owns the conversation.
string
required
Environment alias that owns the conversation, such as main.

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: VOICEFLOW_UPDATE_VARIABLEUpdate selected editable fields of one user-defined variable; omitted fields remain unchanged.

Input Parameters

string
New variable name, or omit to keep the current name. Null is not accepted.
string
New editor display color as a six-digit hex string, or omit to keep the current color. Null is not accepted.
string
required
Project that owns the variable.
string
New description; pass null to clear it, or omit to keep it unchanged.
string
required
User-defined variable ID returned by List Variables or Create Variable.
string
New conversation default value; pass null to clear it, or omit to keep it unchanged.
string
required
Environment alias that owns the variable.

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