---
canonical_url: "https://docs.composio.dev/toolkits/voiceflow"
markdown_url: "https://docs.composio.dev/toolkits/voiceflow.md"
product: "platform"
version: null
last_updated: null
---

# Voiceflow

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

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

## Tools

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Unique variable name used by the agent. |
| `color` | string | No | Editor display color as a six-digit hex color string. |
| `project_id` | string | Yes | Project in which to create the variable. |
| `description` | string | No | Short explanation of what the variable stores. |
| `default_value` | string | No | Initial value at the start of a conversation. |
| `environment_alias` | string | Yes | Environment alias in which to create the variable, such as main. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project that owns the variable. |
| `variable_id` | string | Yes | User-defined variable ID to permanently delete. |
| `environment_alias` | string | Yes | Environment alias that owns the variable, such as main. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project that owns the environment. |
| `environment_alias` | string | Yes | Alias of the environment to export. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project whose agent configuration to read. |
| `include_prompt` | boolean | No | Set true to include the global prompt, which can be very large; omitted defaults to false. |
| `environment_alias` | string | Yes | Environment alias to read, such as main. |
| `include_instructions` | boolean | No | Set true to include the agent instructions, which can be very large; omitted defaults to false. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_id` | string | Yes | Stable conversation user ID. |
| `version` | string ("draft" | "published") | No | Environment version whose state to read. |
| `project_id` | string | Yes | Project that owns the conversation. |
| `environment_alias` | string | Yes | Environment alias that owns the conversation, such as main. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Transcript

**Slug:** `VOICEFLOW_GET_TRANSCRIPT`

Return one transcript with its full conversation logs, properties, evaluations, and recording URL.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project that owns the transcript. |
| `transcript_id` | string | Yes | Transcript ID returned by Search Transcripts. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | Public HTTP or HTTPS web page URL to crawl and ingest. |
| `metadata` | array | No | Metadata fields used to filter this document during retrieval. |
| `project_id` | string | Yes | Project whose knowledge base should receive the document. |
| `refresh_rate` | string ("daily" | "weekly" | "monthly" | "never") | No | How often Voiceflow should recrawl the URL. |
| `max_chunk_size` | integer | No | Maximum tokens per generated chunk, from 500 through 1500. |
| `environment_alias` | string | Yes | Environment alias whose knowledge base should receive the document. |
| `markdown_conversion` | boolean | No | Whether Voiceflow converts HTML to Markdown before chunking. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tool_type` | string ("api" | "mcp" | "function" | "integration") | No | For attached_tool only, optionally filter by underlying api, mcp, function, or integration tool type. |
| `project_id` | string | Yes | Project whose components to list. |
| `playbook_id` | string | No | For attached_tool with attachment_target=playbook, the target playbook ID. |
| `mcp_server_id` | string | No | 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") | Yes | Kind of component to return: playbook, api_tool, function, evaluation, mcp_server, mcp_tool, attached_tool, or test. |
| `attachment_target` | string ("agent" | "playbook") | No | For attached_tool only, choose agent for agent-level attachments or playbook for one playbook's attachments. |
| `environment_alias` | string | No | Environment alias, such as main. Required for every component type except project-level evaluations. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Environments

**Slug:** `VOICEFLOW_LIST_ENVIRONMENTS`

Return a project's environments, aliases, release history, and live traffic percentages.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project ID returned by List Projects. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project whose knowledge-base documents to list. |
| `environment_alias` | string | Yes | Environment alias whose documents to list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `workspace_id` | string | Yes | Workspace ID returned by List Workspaces. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project whose variables to list. |
| `environment_alias` | string | Yes | Environment alias whose variables to list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Workspaces

**Slug:** `VOICEFLOW_LIST_WORKSPACES`

Return every Voiceflow workspace accessible to the connected account, including IDs needed to list projects.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project that owns the environment. |
| `description` | string | No | Optional description of the changes in this release. |
| `release_name` | string | Yes | Name for the release created by publishing. |
| `confirm_publish` | boolean | Yes | 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 | Yes | Alias of the environment to publish, such as main. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum transcripts in this page (1-100). |
| `offset` | integer | No | Number of matching transcripts to skip; pass next_offset from the previous response. |
| `filters` | array | No | Optional Voiceflow transcript-property filters. |
| `version` | string ("draft" | "published") | No | Optional environment-version filter. |
| `end_date` | string | No | Inclusive UTC end timestamp in ISO 8601 format. |
| `project_id` | string | Yes | Project whose transcripts to search. |
| `session_id` | string | No | Optional conversation session ID filter. |
| `start_date` | string | No | Inclusive UTC start timestamp in ISO 8601 format. |
| `environment_alias` | string | No | Optional environment alias filter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `message` | string | Yes | User text to send to the agent. |
| `user_id` | string | Yes | Stable caller-chosen conversation ID; reuse it to continue the same user's state. |
| `version` | string ("draft" | "published") | No | Environment version to run. |
| `project_id` | string | Yes | Project whose agent should handle the turn. |
| `session_id` | string | No | Existing session ID to continue when one is known. |
| `environment_alias` | string | Yes | Environment alias whose agent should handle the turn. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_id` | string | Yes | Stable conversation user ID whose variables should be updated. |
| `version` | string ("draft" | "published") | No | Environment version whose session variables to update. |
| `variables` | object | Yes | Non-empty mapping of existing Voiceflow variable names to JSON-compatible values. Supplied values are merged into the conversation's variables. |
| `project_id` | string | Yes | Project that owns the conversation. |
| `environment_alias` | string | Yes | Environment alias that owns the conversation, such as main. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Variable

**Slug:** `VOICEFLOW_UPDATE_VARIABLE`

Update selected editable fields of one user-defined variable; omitted fields remain unchanged.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | New variable name, or omit to keep the current name. Null is not accepted. |
| `color` | string | No | New editor display color as a six-digit hex string, or omit to keep the current color. Null is not accepted. |
| `project_id` | string | Yes | Project that owns the variable. |
| `description` | string | No | New description; pass null to clear it, or omit to keep it unchanged. |
| `variable_id` | string | Yes | User-defined variable ID returned by List Variables or Create Variable. |
| `default_value` | string | No | New conversation default value; pass null to clear it, or omit to keep it unchanged. |
| `environment_alias` | string | Yes | Environment alias that owns the variable. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |