> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Voiceflow

> Voiceflow is a platform for building, deploying, testing, and analyzing conversational AI agents.

![Voiceflow logo](https://mintcdn.com/composio-preview/DMB8UrgJmE7r-ZQ5/images/toolkits/voiceflow.svg?fit=max\&auto=format\&n=DMB8UrgJmE7r-ZQ5\&q=85\&s=46525949a3673317fe1ff03fda12cf97)

* **Category:** ai agents
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 20
* **Triggers:** 0
* **Slug:** `VOICEFLOW`
* **Version:** 20261030\_00

## Tools

> [accordion] Create Variable
>
> **Slug:** `VOICEFLOW_CREATE_VARIABLE`
>
> Create one user-defined variable in a Voiceflow project environment and return its assigned ID and configuration.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Unique variable name used by the agent.
>
> **color** `string`
>
> Editor display color as a six-digit hex color string.
>
> **project\_id** `string` *required*
>
> Project in which to create the variable.
>
> **description** `string`
>
> Short explanation of what the variable stores.
>
> **default\_value** `string`
>
> Initial value at the start of a conversation.
>
> **environment\_alias** `string` *required*
>
> Environment alias in which to create the variable, such as main.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Variable
>
> **Slug:** `VOICEFLOW_DELETE_VARIABLE`
>
> Permanently delete one user-defined variable by ID. Use only after confirming it is not a system variable or referenced by the agent.
>
> #### Input Parameters
>
> **project\_id** `string` *required*
>
> Project that owns the variable.
>
> **variable\_id** `string` *required*
>
> User-defined variable ID to permanently delete.
>
> **environment\_alias** `string` *required*
>
> Environment alias that owns the variable, such as main.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Export Environment
>
> **Slug:** `VOICEFLOW_EXPORT_ENVIRONMENT`
>
> Return a complete JSON snapshot of one Voiceflow environment, including agent, workflows, tools, functions, variables, and knowledge-base records.
>
> #### Input Parameters
>
> **project\_id** `string` *required*
>
> Project that owns the environment.
>
> **environment\_alias** `string` *required*
>
> Alias of the environment to export.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Agent Configuration
>
> **Slug:** `VOICEFLOW_GET_AGENT_CONFIG`
>
> Return one project environment's agent configuration; optionally include its large global prompt and instructions.
>
> #### Input Parameters
>
> **project\_id** `string` *required*
>
> Project whose agent configuration to read.
>
> **include\_prompt** `boolean`
>
> Set true to include the global prompt, which can be very large; omitted defaults to false.
>
> **environment\_alias** `string` *required*
>
> Environment alias to read, such as main.
>
> **include\_instructions** `boolean`
>
> Set true to include the agent instructions, which can be very large; omitted defaults to false.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Conversation State
>
> **Slug:** `VOICEFLOW_GET_CONVERSATION_STATE`
>
> Read a user's Voiceflow conversation variables, storage, and execution stack for a draft or published environment.
>
> #### Input Parameters
>
> **user\_id** `string` *required*
>
> Stable conversation user ID.
>
> **version** `string ("draft" | "published")`
>
> Environment version whose state to read.
>
> **project\_id** `string` *required*
>
> Project that owns the conversation.
>
> **environment\_alias** `string` *required*
>
> Environment alias that owns the conversation, such as main.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Transcript
>
> **Slug:** `VOICEFLOW_GET_TRANSCRIPT`
>
> Return one transcript with its full conversation logs, properties, evaluations, and recording URL.
>
> #### Input Parameters
>
> **project\_id** `string` *required*
>
> Project that owns the transcript.
>
> **transcript\_id** `string` *required*
>
> Transcript ID returned by Search Transcripts.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Import Knowledge Document from URL
>
> **Slug:** `VOICEFLOW_IMPORT_KNOWLEDGE_DOCUMENT_FROM_URL`
>
> Crawl 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
>
> **url** `string` *required*
>
> Public HTTP or HTTPS web page URL to crawl and ingest.
>
> **metadata** `array`
>
> Metadata fields used to filter this document during retrieval.
>
> **project\_id** `string` *required*
>
> Project whose knowledge base should receive the document.
>
> **refresh\_rate** `string ("daily" | "weekly" | "monthly" | "never")`
>
> How often Voiceflow should recrawl the URL.
>
> **max\_chunk\_size** `integer`
>
> Maximum tokens per generated chunk, from 500 through 1500.
>
> **environment\_alias** `string` *required*
>
> Environment alias whose knowledge base should receive the document.
>
> **markdown\_conversion** `boolean`
>
> Whether Voiceflow converts HTML to Markdown before chunking.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Agent Components
>
> **Slug:** `VOICEFLOW_LIST_AGENT_COMPONENTS`
>
> List 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
>
> **tool\_type** `string ("api" | "mcp" | "function" | "integration")`
>
> For attached\_tool only, optionally filter by underlying api, mcp, function, or integration tool type.
>
> **project\_id** `string` *required*
>
> Project whose components to list.
>
> **playbook\_id** `string`
>
> For attached\_tool with attachment\_target=playbook, the target playbook ID.
>
> **mcp\_server\_id** `string`
>
> For mcp\_tool only, optionally restrict results to one MCP server ID.
>
> **component\_type** `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.
>
> **attachment\_target** `string ("agent" | "playbook")`
>
> For attached\_tool only, choose agent for agent-level attachments or playbook for one playbook's attachments.
>
> **environment\_alias** `string`
>
> Environment alias, such as main. Required for every component type except project-level evaluations.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Environments
>
> **Slug:** `VOICEFLOW_LIST_ENVIRONMENTS`
>
> Return a project's environments, aliases, release history, and live traffic percentages.
>
> #### Input Parameters
>
> **project\_id** `string` *required*
>
> Project ID returned by List Projects.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Knowledge Documents
>
> **Slug:** `VOICEFLOW_LIST_KNOWLEDGE_DOCUMENTS`
>
> Return all knowledge-base documents in one project environment with their IDs, sources, ingestion status, and chunking settings.
>
> #### Input Parameters
>
> **project\_id** `string` *required*
>
> Project whose knowledge-base documents to list.
>
> **environment\_alias** `string` *required*
>
> Environment alias whose documents to list.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Projects
>
> **Slug:** `VOICEFLOW_LIST_PROJECTS`
>
> Return every Voiceflow project in one workspace, including project IDs used by agent, runtime, and authoring tools.
>
> #### Input Parameters
>
> **workspace\_id** `string` *required*
>
> Workspace ID returned by List Workspaces.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Variables
>
> **Slug:** `VOICEFLOW_LIST_VARIABLES`
>
> Return system and user-defined variables in one project environment with IDs, defaults, descriptions, and ownership flags.
>
> #### Input Parameters
>
> **project\_id** `string` *required*
>
> Project whose variables to list.
>
> **environment\_alias** `string` *required*
>
> Environment alias whose variables to list.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Workspaces
>
> **Slug:** `VOICEFLOW_LIST_WORKSPACES`
>
> Return every Voiceflow workspace accessible to the connected account, including IDs needed to list projects.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Publish Environment
>
> **Slug:** `VOICEFLOW_PUBLISH_ENVIRONMENT`
>
> Publish 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
>
> **project\_id** `string` *required*
>
> Project that owns the environment.
>
> **description** `string`
>
> Optional description of the changes in this release.
>
> **release\_name** `string` *required*
>
> Name for the release created by publishing.
>
> **confirm\_publish** `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.
>
> **environment\_alias** `string` *required*
>
> Alias of the environment to publish, such as main.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Query Knowledge Base
>
> **Slug:** `VOICEFLOW_QUERY_KNOWLEDGE_BASE`
>
> Retrieve 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
>
> **filters** `object`
>
> Optional metadata filters restricting which document chunks are eligible.
>
> **version** `string ("draft" | "published")`
>
> Knowledge-base version to query.
>
> **question** `string` *required*
>
> Natural-language question to answer from the knowledge base.
>
> **synthesis** `boolean`
>
> Whether to synthesize an answer instead of returning retrieval chunks only.
>
> **project\_id** `string` *required*
>
> Project whose knowledge base to query.
>
> **chunk\_limit** `integer`
>
> Maximum number of document chunks to retrieve, from 1 through 30.
>
> **instruction** `string`
>
> Additional instruction applied when synthesizing the answer.
>
> **environment\_alias** `string` *required*
>
> Environment alias whose knowledge base to query, such as main.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Query Project Analytics
>
> **Slug:** `VOICEFLOW_QUERY_PROJECT_ANALYTICS`
>
> Return one Voiceflow project-level analytics metric as a time series for a requested date range and interval.
>
> #### Input Parameters
>
> **metric** `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.
>
> **version** `string ("draft" | "published")`
>
> Optional environment-version filter; omit to include both versions.
>
> **end\_date** `string` *required*
>
> Inclusive UTC end timestamp in ISO 8601 format.
>
> **interval** `string ("hour" | "day" | "week" | "month")` *required*
>
> Time bucket size for returned rows.
>
> **timezone** `string`
>
> Optional IANA timezone used to bucket intervals.
>
> **project\_id** `string` *required*
>
> Project whose analytics metric to query.
>
> **start\_date** `string` *required*
>
> Inclusive UTC start timestamp in ISO 8601 format.
>
> **usage\_class** `string ("Host" | "Build" | "Test" | "Monitor")`
>
> For transcript\_cost only, optionally filter by Voiceflow usage class.
>
> **environment\_alias** `string`
>
> Optional environment alias filter; omit to aggregate all environments.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Transcripts
>
> **Slug:** `VOICEFLOW_SEARCH_TRANSCRIPTS`
>
> Search a project's conversation transcripts by time, environment, version, session, and transcript-property filters, returning one bounded page.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum transcripts in this page (1-100).
>
> **offset** `integer`
>
> Number of matching transcripts to skip; pass next\_offset from the previous response.
>
> **filters** `array`
>
> Optional Voiceflow transcript-property filters.
>
> **version** `string ("draft" | "published")`
>
> Optional environment-version filter.
>
> **end\_date** `string`
>
> Inclusive UTC end timestamp in ISO 8601 format.
>
> **project\_id** `string` *required*
>
> Project whose transcripts to search.
>
> **session\_id** `string`
>
> Optional conversation session ID filter.
>
> **start\_date** `string`
>
> Inclusive UTC start timestamp in ISO 8601 format.
>
> **environment\_alias** `string`
>
> Optional environment alias filter.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Send Conversation Message
>
> **Slug:** `VOICEFLOW_SEND_CONVERSATION_MESSAGE`
>
> Send one text turn to a Voiceflow agent and return its typed response traces; this invokes the agent and may consume model usage.
>
> #### Input Parameters
>
> **message** `string` *required*
>
> User text to send to the agent.
>
> **user\_id** `string` *required*
>
> Stable caller-chosen conversation ID; reuse it to continue the same user's state.
>
> **version** `string ("draft" | "published")`
>
> Environment version to run.
>
> **project\_id** `string` *required*
>
> Project whose agent should handle the turn.
>
> **session\_id** `string`
>
> Existing session ID to continue when one is known.
>
> **environment\_alias** `string` *required*
>
> Environment alias whose agent should handle the turn.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Conversation Variables
>
> **Slug:** `VOICEFLOW_UPDATE_CONVERSATION_VARIABLES`
>
> Merge named variable values into one user's existing conversation state without replacing storage or the execution stack.
>
> #### Input Parameters
>
> **user\_id** `string` *required*
>
> Stable conversation user ID whose variables should be updated.
>
> **version** `string ("draft" | "published")`
>
> Environment version whose session variables to update.
>
> **variables** `object` *required*
>
> Non-empty mapping of existing Voiceflow variable names to JSON-compatible values. Supplied values are merged into the conversation's variables.
>
> **project\_id** `string` *required*
>
> Project that owns the conversation.
>
> **environment\_alias** `string` *required*
>
> Environment alias that owns the conversation, such as main.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Variable
>
> **Slug:** `VOICEFLOW_UPDATE_VARIABLE`
>
> Update selected editable fields of one user-defined variable; omitted fields remain unchanged.
>
> #### Input Parameters
>
> **name** `string`
>
> New variable name, or omit to keep the current name. Null is not accepted.
>
> **color** `string`
>
> New editor display color as a six-digit hex string, or omit to keep the current color. Null is not accepted.
>
> **project\_id** `string` *required*
>
> Project that owns the variable.
>
> **description** `string`
>
> New description; pass null to clear it, or omit to keep it unchanged.
>
> **variable\_id** `string` *required*
>
> User-defined variable ID returned by List Variables or Create Variable.
>
> **default\_value** `string`
>
> New conversation default value; pass null to clear it, or omit to keep it unchanged.
>
> **environment\_alias** `string` *required*
>
> Environment alias that owns the variable.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
