# Voiceflow Documentation

> Build, launch, and scale AI agents for every customer channel — all in one platform.

## Docs

- [Build AI agents with Voiceflow](https://www.voiceflow.com/docs/documentation/introduction.md): Build, test, deploy, and monitor AI agents for customer experience.
- [Building an agent](https://www.voiceflow.com/docs/documentation/build/overview.md): Build AI agents with playbooks, workflows, and powerful customization options.
- [Global prompt](https://www.voiceflow.com/docs/documentation/build/global-prompt.md): The always-on layer that shapes how your agent behaves across every conversation turn.
- [Instructions](https://www.voiceflow.com/docs/documentation/build/instructions.md): Defines how the agent routes requests and decides which tools to use
- [Playbooks](https://www.voiceflow.com/docs/documentation/build/playbooks.md): Goal-based AI that navigates conversations toward an outcome.
- [Workflows](https://www.voiceflow.com/docs/documentation/build/workflows.md): Deterministic control with AI reasoning baked in wherever you need it.
- [The agent instructions editor](https://www.voiceflow.com/docs/documentation/build/editor/overview.md): Add headings, lists, and callouts, reorder blocks by dragging, and reference your tools directly while writing agent and playbook instructions.
- [Referencing tools in prompts](https://www.voiceflow.com/docs/documentation/build/editor/references.md): Insert tools, system tools, playbooks, and workflows directly into your instructions so the agent knows exactly which one to use and when.
- [Markdown shortcuts for instructions](https://www.voiceflow.com/docs/documentation/build/editor/markdown.md): Type markdown shortcuts to create headings, lists, callouts, and bold or italic text as you write, and paste formatted markdown from anywhere.
- [Keyboard shortcuts for the editor](https://www.voiceflow.com/docs/documentation/build/editor/keyboard-shortcuts.md): Every keyboard shortcut in the instructions editor, covering text formatting, duplicating and deleting blocks, menus, and moving around a document.
- [Message](https://www.voiceflow.com/docs/documentation/build/steps/message.md): Send a message to the user.
- [Card](https://www.voiceflow.com/docs/documentation/build/steps/card.md): Display a card with an image, text, and buttons.
- [Carousel](https://www.voiceflow.com/docs/documentation/build/steps/carousel.md): Display multiple cards in a scrollable carousel.
- [Buttons](https://www.voiceflow.com/docs/documentation/build/steps/buttons.md): Display clickable buttons for users to interact with.
- [Listen](https://www.voiceflow.com/docs/documentation/build/steps/listen.md): Capture the user's response and save it to a variable.
- [Playbook](https://www.voiceflow.com/docs/documentation/build/steps/playbook.md): Add agentic playbooks to your deterministic workflows.
- [Crew](https://www.voiceflow.com/docs/documentation/build/steps/crew.md): Coordinate multiple playbooks to work together seamlessly.
- [Integration](https://www.voiceflow.com/docs/documentation/build/steps/integration.md): Use a third-party integration tool in your workflow.
- [MCP](https://www.voiceflow.com/docs/documentation/build/steps/mcp.md): Use an MCP tool at a specific point in your workflow.
- [API step](https://www.voiceflow.com/docs/documentation/build/steps/api.md): Make HTTP requests to external APIs at a specific point in your workflow.
- [Function](https://www.voiceflow.com/docs/documentation/build/steps/function.md): Run custom code as a function tool in your workflow.
- [Call forward](https://www.voiceflow.com/docs/documentation/build/steps/call-forward.md): Transfer calls from your agent to a live representative or another phone number.
- [Live agent handoff](https://www.voiceflow.com/docs/documentation/build/steps/handoff.md): Hand off conversations to a human agent in your contact center, relaying messages and files in both directions and logging them to your transcripts.
- [Code](https://www.voiceflow.com/docs/documentation/build/steps/code.md): Run JavaScript code in your workflow.
- [Condition](https://www.voiceflow.com/docs/documentation/build/steps/condition.md): Route your workflow based on variable values or logic.
- [End](https://www.voiceflow.com/docs/documentation/build/steps/end.md): End your agent's conversation and optionally send a closing message.
- [Operator](https://www.voiceflow.com/docs/documentation/build/steps/operator.md): Route your workflow with LLM-powered conditional logic, no code required.
- [Set](https://www.voiceflow.com/docs/documentation/build/steps/set.md): Set or update variable values in your workflow.
- [Workflow](https://www.voiceflow.com/docs/documentation/build/steps/workflow.md): Call another workflow from your current workflow.
- [Importing data sources](https://www.voiceflow.com/docs/documentation/build/importing-data-sources.md): Ground your agent's responses in your own content.
- [Querying the knowledge base](https://www.voiceflow.com/docs/documentation/build/querying-the-knowledge-base.md): Turn on the knowledge base system tool so your agent can search your documents, then tune how it retrieves and cites what it finds.
- [API tool](https://www.voiceflow.com/docs/documentation/build/tools/api-tool.md): Make HTTP requests to external APIs.
- [Function tool](https://www.voiceflow.com/docs/documentation/build/tools/function-tool.md): Run custom JavaScript during a conversation.
- [MCP tool](https://www.voiceflow.com/docs/documentation/build/tools/mcp-tool.md): Connect your agent to MCP servers and use their tools.
- [Agent tools](https://www.voiceflow.com/docs/documentation/build/tools/overview.md): Pre-built integrations to the platforms you already use.
- [Zendesk tool](https://www.voiceflow.com/docs/documentation/build/tools/zendesk-tool.md): Manage support tickets, users, and organizations in Zendesk.
- [Salesforce tool](https://www.voiceflow.com/docs/documentation/build/tools/salesforce-tool.md): Manage leads, contacts, and cases in your Salesforce CRM.
- [Hubspot tool](https://www.voiceflow.com/docs/documentation/build/tools/hubspot-tool.md): Create contacts, leads, and tickets in your HubSpot CRM.
- [Shopify tool](https://www.voiceflow.com/docs/documentation/build/tools/shopify.md): Manage customers, orders, and products in your Shopify store.
- [Twilio tool](https://www.voiceflow.com/docs/documentation/build/tools/twilio-tool.md): Send SMS messages from your agent using your Twilio account.
- [Airtable tool](https://www.voiceflow.com/docs/documentation/build/tools/airtable-tool.md): Create, read, update, and delete records in your Airtable bases.
- [Make tool](https://www.voiceflow.com/docs/documentation/build/tools/make-tool.md): Connect your agent to hundreds of apps through Make scenarios.
- [Gmail tool](https://www.voiceflow.com/docs/documentation/build/tools/gmail-tool.md): Send emails from your agent using your connected Gmail account.
- [Google Sheets tool](https://www.voiceflow.com/docs/documentation/build/tools/google-sheets-tool.md): Read data from and write data to a Google Sheet.
- [Global tools](https://www.voiceflow.com/docs/documentation/build/tools/global-tools.md): Give your agent tools that are available everywhere, across all playbooks and workflows.
- [System tools](https://www.voiceflow.com/docs/documentation/build/tools/system-tools.md): Built-in tools your agent can use automatically.
- [Behaviour](https://www.voiceflow.com/docs/documentation/build/behaviour.md): Fine tune your agent for optimal performance.
- [Variables](https://www.voiceflow.com/docs/documentation/build/data/variables.md): Store and reuse context throughout a conversation.
- [Secrets](https://www.voiceflow.com/docs/documentation/build/data/secrets.md): Securely store sensitive information.
- [PII redaction](https://www.voiceflow.com/docs/documentation/build/data/pii-redaction.md): Automatically redact personally identifiable information from transcripts.
- [Personas](https://www.voiceflow.com/docs/documentation/build/data/personas.md): Test your agent as a specific kind of user.
- [Choosing a framework](https://www.voiceflow.com/docs/documentation/build/framework/choosing-a-framework.md): Choose the agent framework that's best for your use case.
- [Initialization workflow](https://www.voiceflow.com/docs/documentation/build/framework/initialization-workflow.md): Run a workflow before your agent takes control of the conversation.
- [Environments](https://www.voiceflow.com/docs/documentation/deploy/environments/overview.md): Work on multiple versions of your agent in parallel, conduct A/B tests with traffic splits, and roll changes back with confidence.
- [Publishing](https://www.voiceflow.com/docs/documentation/deploy/environments/publishing.md): Preview your changes before publishing, see every version, and roll back when you need to.
- [A/B testing](https://www.voiceflow.com/docs/documentation/deploy/environments/traffic-split.md): Split traffic across multiple environments at once for A/B testing and gradual rollouts.
- [Merging](https://www.voiceflow.com/docs/documentation/deploy/environments/merging.md): Bring another environment's changes into Main once you're ready to make them the default.
- [Version history](https://www.voiceflow.com/docs/documentation/deploy/environments/version-history.md): Every publish records a version you can review and restore, so a change that goes wrong is a rollback rather than a rebuild from memory.
- [Install widget](https://www.voiceflow.com/docs/documentation/deploy/widget/embedding-the-chat-widget.md): Add your agent to your website in minutes.
- [Customize widget](https://www.voiceflow.com/docs/documentation/deploy/widget/custom-web-chat-styling.md): Customize the Voiceflow web chat widget's styling, modality, and file upload settings to match your brand and product requirements.
- [Chat widget API](https://www.voiceflow.com/docs/documentation/deploy/widget/web-chat-api.md): Control the chat widget from your own code: choose its environment, persist conversations, pass a user ID and variables, trigger intents, and listen for events.
- [Chat widget extensions](https://www.voiceflow.com/docs/documentation/deploy/widget/web-chat-extensions.md): Render your own interactive elements inside the chat window, such as file uploads or date pickers, or trigger effects elsewhere on the page from a function.
- [Connecting a phone number](https://www.voiceflow.com/docs/documentation/deploy/phone/connect-a-phone-number.md): Connect a phone number to your agent to enable voice calls over the phone.
- [Inbound calling](https://www.voiceflow.com/docs/documentation/deploy/phone/inbound-calling.md): Receive phone calls and route them to your agent automatically.
- [Outbound calling](https://www.voiceflow.com/docs/documentation/deploy/phone/outbound-calling.md): Programmatically trigger your agent to call any phone number.
- [Transcripts](https://www.voiceflow.com/docs/documentation/measure/transcripts.md): Review and analyze every conversation your agent has with users.
- [Evaluations](https://www.voiceflow.com/docs/documentation/measure/evaluations.md): Automatically score Voiceflow agent transcripts with custom LLM evaluations to measure resolution, satisfaction, and conversation quality at scale.
- [Tests](https://www.voiceflow.com/docs/documentation/measure/tests.md): Run conversations against your agent and check that it behaves the way you expect.
- [Analytics](https://www.voiceflow.com/docs/documentation/measure/analytics.md): Track your Voiceflow agent's performance, usage, costs, and evaluation results with a customizable analytics dashboard and drill-down views.
- [Workspaces](https://www.voiceflow.com/docs/documentation/account-management/collaboration.md): Organize projects and collaborate with your team.
- [Billing overview](https://www.voiceflow.com/docs/documentation/account-management/billing.md): Find your plan, seats, and usage, understand what each charge covers, and see who to contact when a billing question needs a human answer.
- [Managing your subscription](https://www.voiceflow.com/docs/documentation/account-management/billing/managing-your-subscription.md): How to manage your Voiceflow plan, add-ons, payment method, invoices, and other billing settings.
- [Credits pricing table](https://www.voiceflow.com/docs/documentation/account-management/billing/credits-pricing-table.md): How credits are consumed across your agent's LLM, voice, and orchestration usage.
- [Tutorials](https://www.voiceflow.com/docs/courses/home.md): Learn how to build powerful, production-ready AI agents using Voiceflow.
- [Chat agent quick start guide](https://www.voiceflow.com/docs/courses/chat-agent-quick-start.md): Build and launch your first chat agent in 3 minutes or less.
- [Voice agent quick start guide](https://www.voiceflow.com/docs/courses/phone-agent-quick-start.md): Build and launch your first voice agent in 3 minutes or less.
- [Build your first workflow](https://www.voiceflow.com/docs/courses/build-your-first-workflow.md): Create a deterministic flow with a financial disclaimer, buttons, and an embedded playbook for guided conversations.
- [Build a simple FAQ agent](https://www.voiceflow.com/docs/courses/simple-knowledge-base.md): Create a support agent grounded in FAQ data from your knowledge base.
- [Build an advanced FAQ agent](https://www.voiceflow.com/docs/courses/advanced-knowledge-base.md): Create a support agent for different user types using metadata filtering to serve the right content.
- [Integrate with third-party tools](https://www.voiceflow.com/docs/courses/integrate-with-third-party-tools.md): Connect your agent with the outside world in 5 minutes.
- [Build an authentication workflow](https://www.voiceflow.com/docs/courses/initialization-workflow.md): Gate your agent behind identity verification using an initialization workflow, playbooks, and API calls.
- [Migrate to environments](https://www.voiceflow.com/docs/courses/migrate-to-environments.md): Switch from our legacy environments system to our new, more powerful version.
- [What the REST API covers](https://www.voiceflow.com/docs/api-reference/api-overview.md): Everything the Voiceflow REST API can do, grouped by the job you came to do: build an agent, run a conversation, publish it, and measure it.
- [Your first API request](https://www.voiceflow.com/docs/api-reference/quickstart.md): Run a real conversation turn against your agent in three curl calls: start a session, launch the conversation, and send a message.
- [Personal access tokens](https://www.voiceflow.com/docs/api-reference/authentication.md): Create a personal access token in Settings, send it as a Bearer token, and pass the project and environment your request should run against.
- [Runnable API recipes](https://www.voiceflow.com/docs/cookbook/overview.md): Task-oriented recipes for the Voiceflow APIs, each an executable script that asserts its own behaviour, with a verification date on every page.
- [Running agents overview](https://www.voiceflow.com/docs/api-reference/sections/running-agents.md): Run conversations against an agent over HTTP. Send what a user would say, read the traces that come back, and inspect or reset the state between turns.
- [Traces](https://www.voiceflow.com/docs/api-reference/trace-types.md): Reference for every trace type returned by the Conversations API.
- [Run your first conversation turn](https://www.voiceflow.com/docs/cookbook/first-conversation-turn.md): Start a session, launch the conversation, and send a user message with three curl calls, reading the traces the agent returns at each step.
- [Stream a response token by token](https://www.voiceflow.com/docs/cookbook/stream-a-response.md): Consume the server-sent event stream from POST /v4/interact/stream with curl, reassemble the reply from completion deltas, and verify it arrives incrementally.
- [WebSocket](https://www.voiceflow.com/docs/api-reference/conversations-api/interact-socket.md): Hold a persistent socket.io connection to the Voiceflow runtime for real-time conversations, and read the events it emits over that channel.
- [Send](https://www.voiceflow.com/docs/api-reference/conversation/send.md): Advances a conversation by one turn: the body carries the action to apply, and the response carries the traces the agent produced in reply.
- [Get state](https://www.voiceflow.com/docs/api-reference/conversation-state/get-state.md): Returns the stored state for one conversation - where it stands and what its variables hold - addressed by the same `userID` used to run it.
- [Update state](https://www.voiceflow.com/docs/api-reference/conversation-state/update-state.md): Changes the stored state of a live conversation, which is how a caller seeds or corrects variables between turns without replaying the conversation.
- [Delete state](https://www.voiceflow.com/docs/api-reference/conversation-state/delete-state.md): Discards the stored state for one conversation, so the next turn on that `userID` begins from the start. The response carries only a confirmation message.
- [Update variables](https://www.voiceflow.com/docs/api-reference/conversation-state/update-variables.md): Updates variables in the conversation state by merging with the properties in the request body.
- [Query knowledge base](https://www.voiceflow.com/docs/api-reference/knowledge-base/query-knowledge-base.md): Searches the knowledge base and returns the passages a retrieval would surface, which is how to see what an agent will be grounded on before it answers.
- [Build overview](https://www.voiceflow.com/docs/api-reference/sections/build.md): Create and manage the pieces an agent is built from: playbooks, functions, tools, API tools, MCP servers, variables and knowledge base documents.
- [Create and edit a playbook](https://www.voiceflow.com/docs/cookbook/create-a-playbook.md): Create a playbook over HTTP, read it back, patch its instructions, and delete it: the full lifecycle every Build resource follows.
- [Get agent](https://www.voiceflow.com/docs/api-reference/agent/get-agent.md): Returns the environment’s agent: the global prompt, the instructions that route a turn, and the settings wrapping both.
- [Update agent](https://www.voiceflow.com/docs/api-reference/agent/update-agent.md): Changes the agent that shapes every turn - its global prompt, its routing instructions, or its settings - in the environment named by the request.
- [List playbooks](https://www.voiceflow.com/docs/api-reference/playbook/list-playbooks.md): Returns every playbook in the environment. A playbook is a set of instructions that drives an agent toward a goal, calling tools as it needs them. The call takes no paging parameters, so one request yields the whole set.
- [Create playbook](https://www.voiceflow.com/docs/api-reference/playbook/create-playbook.md): Adds a playbook to the environment, a set of instructions that drives an agent toward a goal, calling tools as it needs them. The response carries the ID that later calls address it by.
- [Create many playbooks](https://www.voiceflow.com/docs/api-reference/playbook/create-many-playbooks.md): Adds several playbooks to the environment in one request, each taking the fields the single-create call takes. The response carries the created playbooks in the same shape the list call returns.
- [Get playbook](https://www.voiceflow.com/docs/api-reference/playbook/get-playbook.md): Returns a single playbook by ID, with the fields that define it. A playbook is a set of instructions that drives an agent toward a goal, calling tools as it needs them.
- [Update playbook](https://www.voiceflow.com/docs/api-reference/playbook/update-playbook.md): Changes an existing playbook in place. The response carries only a confirmation message, so refetch the playbook to read its new values.
- [Delete playbook](https://www.voiceflow.com/docs/api-reference/playbook/delete-playbook.md): Deletes a single playbook by ID. A playbook is a set of instructions that drives an agent toward a goal, calling tools as it needs them. The response carries only a confirmation message, so refetch the playbooks to see what is left.
- [List functions](https://www.voiceflow.com/docs/api-reference/function/list-functions.md): Returns every function in the environment. A function is custom JavaScript that runs in Voiceflow’s sandbox and returns through a named path. The call takes no paging parameters, so one request yields the whole set.
- [Create function](https://www.voiceflow.com/docs/api-reference/function/create-function.md): Adds a function to the environment, custom JavaScript that runs in Voiceflow’s sandbox and returns through a named path. The response carries the ID that later calls address it by.
- [Create many functions](https://www.voiceflow.com/docs/api-reference/function/create-many-functions.md): Adds several functions to the environment in one request, each taking the fields the single-create call takes. The response carries the created functions in the same shape the list call returns.
- [Get function](https://www.voiceflow.com/docs/api-reference/function/get-function.md): Returns a single function by ID, with the fields that define it. A function is custom JavaScript that runs in Voiceflow’s sandbox and returns through a named path.
- [Update function](https://www.voiceflow.com/docs/api-reference/function/update-function.md): Changes an existing function in place. The response carries only a confirmation message, so refetch the function to read its new values.
- [Delete function](https://www.voiceflow.com/docs/api-reference/function/delete-function.md): Deletes a single function by ID. A function is custom JavaScript that runs in Voiceflow’s sandbox and returns through a named path. The response carries only a confirmation message, so refetch the functions to see what is left.
- [List paths](https://www.voiceflow.com/docs/api-reference/function-path/list-paths.md): Returns every function path in its function. A function path is one of the named exits a function can return through. The call takes no paging parameters, so one request yields the whole set.
- [Create path](https://www.voiceflow.com/docs/api-reference/function-path/create-path.md): Adds a function path to its function, one of the named exits a function can return through. The response carries the ID that later calls address it by.
- [Create many paths](https://www.voiceflow.com/docs/api-reference/function-path/create-many-paths.md): Adds several function paths to its function in one request, each taking the fields the single-create call takes. The response carries the created function paths in the same shape the list call returns.
- [Get path](https://www.voiceflow.com/docs/api-reference/function-path/get-path.md): Returns a single function path by ID, with the fields that define it. A function path is one of the named exits a function can return through.
- [Update path](https://www.voiceflow.com/docs/api-reference/function-path/update-path.md): Changes an existing function path in place. The response carries only a confirmation message, so refetch the function path to read its new values.
- [Delete path](https://www.voiceflow.com/docs/api-reference/function-path/delete-path.md): Deletes a single function path by ID. A function path is one of the named exits a function can return through. The response carries only a confirmation message, so refetch the function paths to see what is left.
- [List variables](https://www.voiceflow.com/docs/api-reference/function-variable/list-variables.md): Returns every function variable in its function. A function variable is an input or output a function declares. The call takes no paging parameters, so one request yields the whole set.
- [Create variable](https://www.voiceflow.com/docs/api-reference/function-variable/create-variable.md): Adds a function variable to its function, an input or output a function declares. The response carries the ID that later calls address it by.
- [Create many variables](https://www.voiceflow.com/docs/api-reference/function-variable/create-many-variables.md): Adds several function variables to its function in one request, each taking the fields the single-create call takes. The response carries the created function variables in the same shape the list call returns.
- [Get variable](https://www.voiceflow.com/docs/api-reference/function-variable/get-variable.md): Returns a single function variable by ID, with the fields that define it. A function variable is an input or output a function declares.
- [Update variable](https://www.voiceflow.com/docs/api-reference/function-variable/update-variable.md): Changes an existing function variable in place. The response carries only a confirmation message, so refetch the function variable to read its new values.
- [Delete variable](https://www.voiceflow.com/docs/api-reference/function-variable/delete-variable.md): Deletes a single function variable by ID. A function variable is an input or output a function declares. The response carries only a confirmation message, so refetch the function variables to see what is left.
- [List tools](https://www.voiceflow.com/docs/api-reference/tool/list-tools.md): Returns every tool in the environment. A tool is something a playbook can call during a conversation. The call takes no paging parameters, so one request yields the whole set.
- [Create tool](https://www.voiceflow.com/docs/api-reference/tool/create-tool.md): Adds a tool to the environment, something a playbook can call during a conversation. The response carries the ID that later calls address it by.
- [Create many tools](https://www.voiceflow.com/docs/api-reference/tool/create-many-tools.md): Adds several tools to the environment in one request, each taking the fields the single-create call takes. The response carries the created tools in the same shape the list call returns.
- [Get tool](https://www.voiceflow.com/docs/api-reference/tool/get-tool.md): Returns a single tool by ID, with the fields that define it. A tool is something a playbook can call during a conversation.
- [Update tool](https://www.voiceflow.com/docs/api-reference/tool/update-tool.md): Changes an existing tool in place. The response carries only a confirmation message, so refetch the tool to read its new values.
- [Delete tool](https://www.voiceflow.com/docs/api-reference/tool/delete-tool.md): Deletes a single tool by ID. A tool is something a playbook can call during a conversation. The response carries only a confirmation message, so refetch the tools to see what is left.
- [List API tools](https://www.voiceflow.com/docs/api-reference/api-tool/list-api-tools.md): Returns every API tool in the environment. An API tool is a saved HTTP request an agent can make. The call takes no paging parameters, so one request yields the whole set.
- [Create API tool](https://www.voiceflow.com/docs/api-reference/api-tool/create-api-tool.md): Adds a API tool to the environment, a saved HTTP request an agent can make. The response carries the ID that later calls address it by.
- [Create many API tools](https://www.voiceflow.com/docs/api-reference/api-tool/create-many-api-tools.md): Adds several API tools to the environment in one request, each taking the fields the single-create call takes. The response carries the created API tools in the same shape the list call returns.
- [Get API tool](https://www.voiceflow.com/docs/api-reference/api-tool/get-api-tool.md): Returns a single API tool by ID, with the fields that define it. An API tool is a saved HTTP request an agent can make.
- [Update API tool](https://www.voiceflow.com/docs/api-reference/api-tool/update-api-tool.md): Changes an existing API tool in place. The response carries only a confirmation message, so refetch the API tool to read its new values.
- [Delete API tool](https://www.voiceflow.com/docs/api-reference/api-tool/delete-api-tool.md): Deletes a single API tool by ID. An API tool is a saved HTTP request an agent can make. The response carries only a confirmation message, so refetch the API tools to see what is left.
- [List variables](https://www.voiceflow.com/docs/api-reference/api-tool-variable/list-variables.md): Returns every API tool variable in its API tool. An API tool variable is an input an API tool substitutes into its request. The call takes no paging parameters, so one request yields the whole set.
- [Create variable](https://www.voiceflow.com/docs/api-reference/api-tool-variable/create-variable.md): Adds a API tool variable to its API tool, an input an API tool substitutes into its request. The response carries the ID that later calls address it by.
- [Create many variables](https://www.voiceflow.com/docs/api-reference/api-tool-variable/create-many-variables.md): Adds several API tool variables to its API tool in one request, each taking the fields the single-create call takes. The response carries the created API tool variables in the same shape the list call returns.
- [Get variable](https://www.voiceflow.com/docs/api-reference/api-tool-variable/get-variable.md): Returns a single API tool variable by ID, with the fields that define it. An API tool variable is an input an API tool substitutes into its request.
- [Update variable](https://www.voiceflow.com/docs/api-reference/api-tool-variable/update-variable.md): Changes an existing API tool variable in place. The response carries only a confirmation message, so refetch the API tool variable to read its new values.
- [Delete variable](https://www.voiceflow.com/docs/api-reference/api-tool-variable/delete-variable.md): Deletes a single API tool variable by ID. An API tool variable is an input an API tool substitutes into its request. The response carries only a confirmation message, so refetch the API tool variables to see what is left.
- [List variables](https://www.voiceflow.com/docs/api-reference/variable/list-variables.md): Returns every variable in the project. A variable is a named slot of project state an agent can read and write. The call takes no paging parameters, so one request yields the whole set.
- [Create variable](https://www.voiceflow.com/docs/api-reference/variable/create-variable.md): Adds a variable to the project, a named slot of project state an agent can read and write. The response carries the ID that later calls address it by.
- [Create many variables](https://www.voiceflow.com/docs/api-reference/variable/create-many-variables.md): Adds several variables to the project in one request, each taking the fields the single-create call takes. The response carries the created variables in the same shape the list call returns.
- [Get variable](https://www.voiceflow.com/docs/api-reference/variable/get-variable.md): Returns a single variable by ID, with the fields that define it. A variable is a named slot of project state an agent can read and write.
- [Update variable](https://www.voiceflow.com/docs/api-reference/variable/update-variable.md): Changes an existing variable in place. The response carries only a confirmation message, so refetch the variable to read its new values.
- [Delete variable](https://www.voiceflow.com/docs/api-reference/variable/delete-variable.md): Deletes a single variable by ID. A variable is a named slot of project state an agent can read and write. The response carries only a confirmation message, so refetch the variables to see what is left.
- [List MCP servers](https://www.voiceflow.com/docs/api-reference/mcp-server/list-mcp-servers.md): Returns every MCP server in the environment. A MCP server is a registered Model Context Protocol server whose tools an agent can call. The call takes no paging parameters, so one request yields the whole set.
- [Create MCP server](https://www.voiceflow.com/docs/api-reference/mcp-server/create-mcp-server.md): Adds a MCP server to the environment, a registered Model Context Protocol server whose tools an agent can call. The response carries the ID that later calls address it by.
- [Get MCP server](https://www.voiceflow.com/docs/api-reference/mcp-server/get-mcp-server.md): Returns a single MCP server by ID, with the fields that define it. A MCP server is a registered Model Context Protocol server whose tools an agent can call.
- [Update MCP server](https://www.voiceflow.com/docs/api-reference/mcp-server/update-mcp-server.md): Changes an existing MCP server in place. The response carries only a confirmation message, so refetch the MCP server to read its new values.
- [Delete MCP server](https://www.voiceflow.com/docs/api-reference/mcp-server/delete-mcp-server.md): Deletes a single MCP server by ID. A MCP server is a registered Model Context Protocol server whose tools an agent can call. The response carries only a confirmation message, so refetch the MCP servers to see what is left.
- [Sync MCP server](https://www.voiceflow.com/docs/api-reference/mcp-server/sync-mcp-server.md): Refreshes the stored list of tools an MCP server advertises, which is how MCP tools come to exist rather than being created by hand.
- [List MCP tools](https://www.voiceflow.com/docs/api-reference/mcp-tool/list-mcp-tools.md): Returns every MCP tool in its server. A MCP tool is a tool an MCP server advertises, populated by syncing the server rather than by hand. The call takes no paging parameters, so one request yields the whole set.
- [Get MCP tool](https://www.voiceflow.com/docs/api-reference/mcp-tool/get-mcp-tool.md): Returns a single MCP tool by ID, with the fields that define it. A MCP tool is a tool an MCP server advertises, populated by syncing the server rather than by hand.
- [List documents](https://www.voiceflow.com/docs/api-reference/document/list-documents.md): Returns every document in the knowledge base. A document is a source the knowledge base retrieves from. The call takes no paging parameters, so one request yields the whole set.
- [Create URL document](https://www.voiceflow.com/docs/api-reference/document/create-url-document.md): Adds a document to the knowledge base, a source the knowledge base retrieves from. The response carries the ID that later calls address it by.
- [Create text document](https://www.voiceflow.com/docs/api-reference/document/create-text-document.md): Adds a document to the knowledge base, a source the knowledge base retrieves from. The response carries the ID that later calls address it by.
- [Create table document](https://www.voiceflow.com/docs/api-reference/document/create-table-document.md): Adds a document to the knowledge base, a source the knowledge base retrieves from. The response carries the ID that later calls address it by.
- [Get document](https://www.voiceflow.com/docs/api-reference/document/get-document.md): Returns a single document by ID, with the fields that define it. A document is a source the knowledge base retrieves from.
- [Update document](https://www.voiceflow.com/docs/api-reference/document/update-document.md): Changes an existing document in place. The response carries only a confirmation message, so refetch the document to read its new values.
- [Delete document](https://www.voiceflow.com/docs/api-reference/document/delete-document.md): Deletes a single document by ID. A document is a source the knowledge base retrieves from. The response carries only a confirmation message, so refetch the documents to see what is left.
- [Manage overview](https://www.voiceflow.com/docs/api-reference/sections/manage.md): Create and administer the containers your agents live in: workspaces that group projects and people, and projects that each own a single agent.
- [Find your project and environment](https://www.voiceflow.com/docs/cookbook/find-your-project.md): Resolve a project ID upward to the workspace that owns it and the environments inside it, and identify which environment is currently live.
- [List projects](https://www.voiceflow.com/docs/api-reference/project/list-projects.md): Returns every project in the workspace. A project is the container that owns exactly one agent. The call takes no paging parameters, so one request yields the whole set.
- [Create project](https://www.voiceflow.com/docs/api-reference/project/create-project.md): Adds a project to the workspace, the container that owns exactly one agent. The response carries the ID that later calls address it by.
- [Get project](https://www.voiceflow.com/docs/api-reference/project/get-project.md): Returns a single project by ID, with the fields that define it. A project is the container that owns exactly one agent.
- [Update project](https://www.voiceflow.com/docs/api-reference/project/update-project.md): Changes an existing project in place. The response carries only a confirmation message, so refetch the project to read its new values.
- [Delete project](https://www.voiceflow.com/docs/api-reference/project/delete-project.md): Deletes a single project by ID. A project is the container that owns exactly one agent. The response carries only a confirmation message, so refetch the projects to see what is left.
- [List workspaces](https://www.voiceflow.com/docs/api-reference/workspace/list-workspaces.md): Returns every workspace in the account. A workspace is the container that groups projects and the people who work on them. The call takes no paging parameters, so one request yields the whole set.
- [Create workspace](https://www.voiceflow.com/docs/api-reference/workspace/create-workspace.md): Adds a workspace to the account, the container that groups projects and the people who work on them. The response carries the ID that later calls address it by.
- [Get workspace](https://www.voiceflow.com/docs/api-reference/workspace/get-workspace.md): Returns a single workspace by ID, with the fields that define it. A workspace is the container that groups projects and the people who work on them.
- [Update workspace](https://www.voiceflow.com/docs/api-reference/workspace/update-workspace.md): Changes an existing workspace in place. The response carries only a confirmation message, so refetch the workspace to read its new values.
- [Delete workspace](https://www.voiceflow.com/docs/api-reference/workspace/delete-workspace.md): Deletes a single workspace by ID. A workspace is the container that groups projects and the people who work on them. The response carries only a confirmation message, so refetch the workspaces to see what is left.
- [Publishing overview](https://www.voiceflow.com/docs/api-reference/sections/publishing.md): Ship changes with environments. Edit a draft, publish it live, clone one to work in isolation, merge it back, and split traffic between versions.
- [Clone an environment and publish](https://www.voiceflow.com/docs/cookbook/clone-and-publish.md): Clone the live environment, publish a release inside the copy, verify it landed, then delete the clone, all without touching production.
- [List environments](https://www.voiceflow.com/docs/api-reference/environment/list-environments.md): Returns every environment in the project. An environment is one draft-and-published copy of the agent. The call takes no paging parameters, so one request yields the whole set.
- [Merge environments](https://www.voiceflow.com/docs/api-reference/environment/merge-environments.md): Folds the contents of one environment into another, so work done in a clone can be brought back to the environment it was cloned from.
- [Update traffic split](https://www.voiceflow.com/docs/api-reference/environment/update-traffic-split.md): Changes an existing environment in place. The response carries only a confirmation message, so refetch the environment to read its new values.
- [Get environment](https://www.voiceflow.com/docs/api-reference/environment/get-environment.md): Returns a single environment by ID, with the fields that define it. An environment is one draft-and-published copy of the agent.
- [Update environment](https://www.voiceflow.com/docs/api-reference/environment/update-environment.md): Changes an existing environment in place. The response carries only a confirmation message, so refetch the environment to read its new values.
- [Delete environment](https://www.voiceflow.com/docs/api-reference/environment/delete-environment.md): Deletes a single environment by ID. An environment is one draft-and-published copy of the agent. The response carries only a confirmation message, so refetch the environments to see what is left.
- [Export environment](https://www.voiceflow.com/docs/api-reference/environment/export-environment.md): Serialises the whole environment - its agent, playbooks, tools and knowledge base - into a single document you can archive or move to another project.
- [Compile environment](https://www.voiceflow.com/docs/api-reference/environment/compile-environment.md): Rebuilds the environment’s runtime form from its current definition, which is what a conversation actually executes against.
- [Clone environment](https://www.voiceflow.com/docs/api-reference/environment/clone-environment.md): Copies an environment into a new one under an alias you choose, giving somewhere to change the agent without touching the environment being cloned.
- [Publish environment](https://www.voiceflow.com/docs/api-reference/environment/publish-environment.md): Promotes the environment’s draft to its published version, which is the copy real traffic reaches. The request names the release so it can be told apart in the history.
- [Observe overview](https://www.voiceflow.com/docs/api-reference/sections/observe.md): Read the conversations your agent actually had. Search transcripts, fetch a single one, and attach your own properties to record what happened.
- [Find and label a transcript](https://www.voiceflow.com/docs/cookbook/find-a-conversation.md): Run a conversation, poll for the transcript it writes, fetch the turns, and attach a custom property so you can label it with your own data.
- [Search transcripts](https://www.voiceflow.com/docs/api-reference/transcript/search-transcripts.md): Finds recorded conversations matching a filter. Unlike the list calls elsewhere in this API, the body takes `take` and `skip`, so results arrive a page at a time.
- [Get transcript](https://www.voiceflow.com/docs/api-reference/transcript/get-transcript.md): Returns one recorded conversation in full, including the turns exchanged and the traces behind them, which is the payload a review tool renders.
- [List properties](https://www.voiceflow.com/docs/api-reference/transcript-property/list-properties.md): Returns every transcript property in the project. A transcript property is a label you define once and then set on individual conversations. The call takes no paging parameters, so one request yields the whole set.
- [Create property](https://www.voiceflow.com/docs/api-reference/transcript-property/create-property.md): Adds a transcript property to the project, a label you define once and then set on individual conversations. The response carries the ID that later calls address it by.
- [Get property](https://www.voiceflow.com/docs/api-reference/transcript-property/get-property.md): Returns a single transcript property by ID, with the fields that define it. A transcript property is a label you define once and then set on individual conversations.
- [Update property](https://www.voiceflow.com/docs/api-reference/transcript-property/update-property.md): Changes an existing transcript property in place. The response carries only a confirmation message, so refetch the transcript property to read its new values.
- [Delete property](https://www.voiceflow.com/docs/api-reference/transcript-property/delete-property.md): Deletes a single transcript property by ID. A transcript property is a label you define once and then set on individual conversations. The response carries only a confirmation message, so refetch the transcript properties to see what is left.
- [Set property value](https://www.voiceflow.com/docs/api-reference/transcript-property/set-property-value.md): Sets a property’s value on one conversation. Defining the property and setting it are separate calls, so the definition is reused across every transcript that carries it.
- [Insights overview](https://www.voiceflow.com/docs/api-reference/sections/insights.md): Score conversations against criteria you define, so agent quality becomes a number you can track over time instead of a sample you skim.
- [Score a conversation](https://www.voiceflow.com/docs/cookbook/score-a-conversation.md): End a conversation, define a boolean evaluation, and score the transcript, reading back both the verdict and the reasoning behind it.
- [List evaluations](https://www.voiceflow.com/docs/api-reference/evaluation/list-evaluations.md): Returns every evaluation in the project. An evaluation is a criterion a model scores past conversations against. The call takes no paging parameters, so one request yields the whole set.
- [Create evaluation](https://www.voiceflow.com/docs/api-reference/evaluation/create-evaluation.md): Adds a evaluation to the project, a criterion a model scores past conversations against. The response carries the ID that later calls address it by.
- [Get evaluation](https://www.voiceflow.com/docs/api-reference/evaluation/get-evaluation.md): Returns a single evaluation by ID, with the fields that define it. An evaluation is a criterion a model scores past conversations against.
- [Update evaluation](https://www.voiceflow.com/docs/api-reference/evaluation/update-evaluation.md): Changes an existing evaluation in place. The response carries only a confirmation message, so refetch the evaluation to read its new values.
- [Delete evaluation](https://www.voiceflow.com/docs/api-reference/evaluation/delete-evaluation.md): Deletes a single evaluation by ID. An evaluation is a criterion a model scores past conversations against. The response carries only a confirmation message, so refetch the evaluations to see what is left.
- [Run evaluation](https://www.voiceflow.com/docs/api-reference/evaluation/run-evaluation.md): Scores one finished conversation against an evaluation. The response carries the verdict together with the reasoning behind it, so a low score says why.
- [QA overview](https://www.voiceflow.com/docs/api-reference/sections/qa.md): Replay scripted conversations against your agent and assert what it does, so a change that breaks a scenario fails loudly instead of silently.
- [Build a regression test](https://www.voiceflow.com/docs/cookbook/test-a-conversation-flow.md): Build a regression test from a user turn, an agent turn, and two kinds of check, then run it and poll for the number of checks that passed.
- [List tests](https://www.voiceflow.com/docs/api-reference/test/list-tests.md): Returns every test in the environment. A test is a scripted conversation replayed against the agent. The call takes no paging parameters, so one request yields the whole set.
- [Create test](https://www.voiceflow.com/docs/api-reference/test/create-test.md): Adds a test to the environment, a scripted conversation replayed against the agent. The response carries the ID that later calls address it by.
- [Create many tests](https://www.voiceflow.com/docs/api-reference/test/create-many-tests.md): Adds several tests to the environment in one request, each taking the fields the single-create call takes. The response carries the created tests in the same shape the list call returns.
- [Get test](https://www.voiceflow.com/docs/api-reference/test/get-test.md): Returns a single test by ID, with the fields that define it. A test is a scripted conversation replayed against the agent.
- [Update test](https://www.voiceflow.com/docs/api-reference/test/update-test.md): Changes an existing test in place. The response carries only a confirmation message, so refetch the test to read its new values.
- [Delete test](https://www.voiceflow.com/docs/api-reference/test/delete-test.md): Deletes a single test by ID. A test is a scripted conversation replayed against the agent. The response carries only a confirmation message, so refetch the tests to see what is left.
- [List turns](https://www.voiceflow.com/docs/api-reference/test-turn/list-turns.md): Returns every test turn in its test. A test turn is one side of a scripted conversation, either what the user says or the agent reply the checks assert on. The call takes no paging parameters, so one request yields the whole set.
- [Create turn](https://www.voiceflow.com/docs/api-reference/test-turn/create-turn.md): Adds a test turn to its test, one side of a scripted conversation, either what the user says or the agent reply the checks assert on. The response carries the ID that later calls address it by.
- [Create many turns](https://www.voiceflow.com/docs/api-reference/test-turn/create-many-turns.md): Adds several test turns to its test in one request, each taking the fields the single-create call takes. The response carries the created test turns in the same shape the list call returns.
- [Get turn](https://www.voiceflow.com/docs/api-reference/test-turn/get-turn.md): Returns a single test turn by ID, with the fields that define it. A test turn is one side of a scripted conversation, either what the user says or the agent reply the checks assert on.
- [Update turn](https://www.voiceflow.com/docs/api-reference/test-turn/update-turn.md): Changes an existing test turn in place. The response carries only a confirmation message, so refetch the test turn to read its new values.
- [Delete turn](https://www.voiceflow.com/docs/api-reference/test-turn/delete-turn.md): Deletes a single test turn by ID. A test turn is one side of a scripted conversation, either what the user says or the agent reply the checks assert on. The response carries only a confirmation message, so refetch the test turns to see what is left.
- [List checks](https://www.voiceflow.com/docs/api-reference/test-check/list-checks.md): Returns every test check in its turn. A test check is one assertion about an agent turn, comparing the reply or the behaviour behind it. The call takes no paging parameters, so one request yields the whole set.
- [Create check](https://www.voiceflow.com/docs/api-reference/test-check/create-check.md): Adds a test check to its turn, one assertion about an agent turn, comparing the reply or the behaviour behind it. The response carries the ID that later calls address it by.
- [Create many checks](https://www.voiceflow.com/docs/api-reference/test-check/create-many-checks.md): Adds several test checks to its turn in one request, each taking the fields the single-create call takes. The response carries the created test checks in the same shape the list call returns.
- [Get check](https://www.voiceflow.com/docs/api-reference/test-check/get-check.md): Returns a single test check by ID, with the fields that define it. A test check is one assertion about an agent turn, comparing the reply or the behaviour behind it.
- [Update check](https://www.voiceflow.com/docs/api-reference/test-check/update-check.md): Changes an existing test check in place. The response carries only a confirmation message, so refetch the test check to read its new values.
- [Delete check](https://www.voiceflow.com/docs/api-reference/test-check/delete-check.md): Deletes a single test check by ID. A test check is one assertion about an agent turn, comparing the reply or the behaviour behind it. The response carries only a confirmation message, so refetch the test checks to see what is left.
- [Search runs](https://www.voiceflow.com/docs/api-reference/test-run/search-runs.md): Finds past runs of a test, each carrying how many of its checks passed. The body takes `take` and `skip`, so results arrive a page at a time rather than all at once.
- [Create run](https://www.voiceflow.com/docs/api-reference/test-run/create-run.md): Adds a test run to the environment, one execution of a test, carrying how many of its checks passed. The response carries the ID that later calls address it by.
- [Create many runs](https://www.voiceflow.com/docs/api-reference/test-run/create-many-runs.md): Adds several test runs to the environment in one request, each taking the fields the single-create call takes. The response carries the created test runs in the same shape the list call returns.
- [Get run](https://www.voiceflow.com/docs/api-reference/test-run/get-run.md): Returns a single test run by ID, with the fields that define it. A test run is one execution of a test, carrying how many of its checks passed.
- [Analytics overview](https://www.voiceflow.com/docs/api-reference/sections/analytics.md): Query usage and cost: tokens, calls, conversations and unique users, plus the spend attributed to individual functions, playbooks and tools.
- [Query token usage and calls](https://www.voiceflow.com/docs/cookbook/query-token-usage.md): Query token usage, call count, and unique users for a project over a date range, using the one request body every analytics measure shares.
- [Query call count](https://www.voiceflow.com/docs/api-reference/analytics/query-call-count.md): Reports how many voice calls were placed, for one project over a date range. The request body takes `startDate`, `endDate` and an `interval`, the same shape the other analytics measures take.
- [Query call duration](https://www.voiceflow.com/docs/api-reference/analytics/query-call-duration.md): Reports how much time was spent on voice calls, for one project over a date range. The request body takes `startDate`, `endDate` and an `interval`, the same shape the other analytics measures take.
- [Query workspace transcript count](https://www.voiceflow.com/docs/api-reference/analytics/query-workspace-transcript-count.md): Reports how many conversations were recorded, for one workspace over a date range. The request body takes `startDate`, `endDate` and an `interval`, the same shape the other analytics measures take.
- [Query project transcript count](https://www.voiceflow.com/docs/api-reference/analytics/query-project-transcript-count.md): Reports how many conversations were recorded, for one project over a date range. The request body takes `startDate`, `endDate` and an `interval`, the same shape the other analytics measures take.
- [Query transcript cost](https://www.voiceflow.com/docs/api-reference/analytics/query-transcript-cost.md): Reports what those conversations cost in model spend, for one project over a date range. The request body takes `startDate`, `endDate` and an `interval`, the same shape the other analytics measures take.
- [Query workspace interaction count](https://www.voiceflow.com/docs/api-reference/analytics/query-workspace-interaction-count.md): Reports how many interactions were exchanged, for one workspace over a date range. The request body takes `startDate`, `endDate` and an `interval`, the same shape the other analytics measures take.
- [Query project interaction count](https://www.voiceflow.com/docs/api-reference/analytics/query-project-interaction-count.md): Reports how many interactions were exchanged, for one project over a date range. The request body takes `startDate`, `endDate` and an `interval`, the same shape the other analytics measures take.
- [Query organization token usage](https://www.voiceflow.com/docs/api-reference/analytics/query-organization-token-usage.md): Reports how many tokens were consumed, for one organization over a date range. The request body takes `startDate`, `endDate` and an `interval`, the same shape the other analytics measures take.
- [Query workspace token usage](https://www.voiceflow.com/docs/api-reference/analytics/query-workspace-token-usage.md): Reports how many tokens were consumed, for one workspace over a date range. The request body takes `startDate`, `endDate` and an `interval`, the same shape the other analytics measures take.
- [Query project token usage](https://www.voiceflow.com/docs/api-reference/analytics/query-project-token-usage.md): Reports how many tokens were consumed, for one project over a date range. The request body takes `startDate`, `endDate` and an `interval`, the same shape the other analytics measures take.
- [Query hourly organization token usage](https://www.voiceflow.com/docs/api-reference/analytics/query-hourly-organization-token-usage.md): Reports how many tokens were consumed, bucketed by hour, for one organization over a date range. The request body takes `startDate`, `endDate` and an `interval`, the same shape the other analytics measures take.
- [Query hourly project token usage](https://www.voiceflow.com/docs/api-reference/analytics/query-hourly-project-token-usage.md): Reports how many tokens were consumed, bucketed by hour, for one project over a date range. The request body takes `startDate`, `endDate` and an `interval`, the same shape the other analytics measures take.
- [Query daily token usage](https://www.voiceflow.com/docs/api-reference/analytics/query-daily-token-usage.md): Reports how many tokens were consumed, bucketed by day, for one organization over a date range. The request body takes `startDate`, `endDate` and an `interval`, the same shape the other analytics measures take.
- [Query entity token usage](https://www.voiceflow.com/docs/api-reference/analytics/query-entity-token-usage.md): Reports how many tokens each entity consumed, for one organization over a date range. The request body takes `startDate`, `endDate` and an `interval`, the same shape the other analytics measures take.
- [Query category token usage](https://www.voiceflow.com/docs/api-reference/analytics/query-category-token-usage.md): Reports how many tokens each category consumed, for one project over a date range. The request body takes `startDate`, `endDate` and an `interval`, the same shape the other analytics measures take.
- [Query playbook usage](https://www.voiceflow.com/docs/api-reference/analytics/query-playbook-usage.md): Reports how often each playbook ran, for one project over a date range. The request body takes `startDate`, `endDate` and an `interval`, the same shape the other analytics measures take.
- [Query workflow usage](https://www.voiceflow.com/docs/api-reference/analytics/query-workflow-usage.md): Reports how often each workflow ran, for one project over a date range. The request body takes `startDate`, `endDate` and an `interval`, the same shape the other analytics measures take.
- [Query prompt usage](https://www.voiceflow.com/docs/api-reference/analytics/query-prompt-usage.md): Reports how often each prompt was used, for one project over a date range. The request body takes `startDate`, `endDate` and an `interval`, the same shape the other analytics measures take.
- [Query intent usage](https://www.voiceflow.com/docs/api-reference/analytics/query-intent-usage.md): Reports how often each intent matched, for one project over a date range. The request body takes `startDate`, `endDate` and an `interval`, the same shape the other analytics measures take.
- [Query function usage](https://www.voiceflow.com/docs/api-reference/analytics/query-function-usage.md): Reports how often each function ran, for one project over a date range. The request body takes `startDate`, `endDate` and an `interval`, the same shape the other analytics measures take.
- [Query API tool usage](https://www.voiceflow.com/docs/api-reference/analytics/query-api-tool-usage.md): Reports how often each API tool was called, for one project over a date range. The request body takes `startDate`, `endDate` and an `interval`, the same shape the other analytics measures take.
- [Query MCP tool usage](https://www.voiceflow.com/docs/api-reference/analytics/query-mcp-tool-usage.md): Reports how often each MCP tool was called, for one project over a date range. The request body takes `startDate`, `endDate` and an `interval`, the same shape the other analytics measures take.
- [Query knowledge base document usage](https://www.voiceflow.com/docs/api-reference/analytics/query-knowledge-base-document-usage.md): Reports how often each knowledge base document was retrieved, for one project over a date range. The request body takes `startDate`, `endDate` and an `interval`, the same shape the other analytics measures take.
- [Query integration usage](https://www.voiceflow.com/docs/api-reference/analytics/query-integration-usage.md): Reports how often each integration ran, for one project over a date range. The request body takes `startDate`, `endDate` and an `interval`, the same shape the other analytics measures take.
- [Query unique user count](https://www.voiceflow.com/docs/api-reference/analytics/query-unique-user-count.md): Reports how many distinct users held a conversation, for one project over a date range. The request body takes `startDate`, `endDate` and an `interval`, the same shape the other analytics measures take.
- [Session lifecycle webhook](https://www.voiceflow.com/docs/api-reference/webhooks/session-lifecycle.md): Subscribe to session and call lifecycle webhook events so external systems get notified when Voiceflow conversations start and end.
- [Organization events webhooks](https://www.voiceflow.com/docs/api-reference/webhooks/org-events.md): Receive organization level events to your webhooks.
- [Voiceflow MCP overview](https://www.voiceflow.com/docs/mcp/overview.md): Connect Claude and other AI clients to your Voiceflow account through the Model Context Protocol.
- [Set up the Voiceflow MCP server](https://www.voiceflow.com/docs/mcp/setup.md): One hosted URL, one OAuth sign-in, and a client that speaks streamable HTTP. What to point your client at, and how to tell it worked.
- [How MCP authentication works](https://www.voiceflow.com/docs/mcp/authentication.md): The Voiceflow MCP server signs you in with OAuth rather than an API key. What the two scopes cover, and what a client has to support.
- [Set up Voiceflow in Claude Code](https://www.voiceflow.com/docs/mcp/claude-code.md): Connect Claude Code to your Voiceflow account so it can read and manage your projects directly.
- [Set up Voiceflow in Cursor](https://www.voiceflow.com/docs/mcp/cursor.md): Add the Voiceflow MCP server to Cursor by editing mcp.json, then sign in through the browser when Cursor prompts you.
- [Set up Voiceflow in VS Code](https://www.voiceflow.com/docs/mcp/vscode.md): Add the Voiceflow MCP server to VS Code by creating mcp.json with an http server entry, then sign in when prompted.
- [Set up Voiceflow in Codex](https://www.voiceflow.com/docs/mcp/codex.md): Add the Voiceflow MCP server to the Codex CLI by editing config.toml, then approve the browser sign-in when Codex connects.
- [The vf command line interface](https://www.voiceflow.com/docs/cli/overview.md): Manage Voiceflow agents, knowledge bases, transcripts, analytics, and environments from your terminal or CI with the official vf CLI.
- [Install the vf CLI](https://www.voiceflow.com/docs/cli/install.md): Install the official Voiceflow CLI with the install script, a manual download from GitHub releases, or go install. Verify with vf version.
- [Authenticate the vf CLI](https://www.voiceflow.com/docs/cli/authentication.md): Sign the vf CLI in interactively with vf auth login, check status with vf auth whoami, and pass a token directly for CI with the token flag.
- [vf](https://www.voiceflow.com/docs/cli/commands/overview.md): vf - Realtime: Realtime gateway API service. Groups 22 subcommands, including agent, analytics, api-tool, auth, configure, conversation, document, environment.
- [vf agent - Operations for agent](https://www.voiceflow.com/docs/cli/commands/agent.md): vf agent: operations for agent. Groups 2 subcommands: get, update.
- [vf agent get - Get agent](https://www.voiceflow.com/docs/cli/commands/agent/get.md): vf agent get: get agent. Requires --environment-alias and --project-id, with a worked example.
- [vf agent update - Update agent](https://www.voiceflow.com/docs/cli/commands/agent/update.md): vf agent update: update agent. Requires --environment-alias and --project-id, with a worked example.
- [vf analytics - Operations for analytics](https://www.voiceflow.com/docs/cli/commands/analytics.md): vf analytics: operations for analytics. Groups 1 subcommand: query.
- [vf analytics query](https://www.voiceflow.com/docs/cli/commands/analytics/query.md): vf analytics query: operations for query. Groups 25 subcommands, including api-tool-usage, call-count, call-duration, category-token-usage, daily-token-usage.
- [vf analytics query api-tool-usage](https://www.voiceflow.com/docs/cli/commands/analytics/query/api-tool-usage.md): vf analytics query api-tool-usage: query API tool usage. Requires --end-date, --project-id and --start-date, with a worked example.
- [vf analytics query call-count](https://www.voiceflow.com/docs/cli/commands/analytics/query/call-count.md): vf analytics query call-count: query call count. Requires --end-date, --interval, --project-id and --start-date, with a worked example.
- [vf analytics query call-duration](https://www.voiceflow.com/docs/cli/commands/analytics/query/call-duration.md): vf analytics query call-duration: query call duration. Requires --end-date, --interval, --project-id and --start-date, with a worked example.
- [vf analytics query category-token-usage](https://www.voiceflow.com/docs/cli/commands/analytics/query/category-token-usage.md): vf analytics query category-token-usage: query category token usage. Requires --end-date, --interval, --project-id and --start-date, with a worked example.
- [vf analytics query daily-token-usage](https://www.voiceflow.com/docs/cli/commands/analytics/query/daily-token-usage.md): vf analytics query daily-token-usage: query daily token usage. Requires --end-date, --organization-id and --start-date, with a worked example.
- [vf analytics query entity-token-usage](https://www.voiceflow.com/docs/cli/commands/analytics/query/entity-token-usage.md): vf analytics query entity-token-usage: query entity token usage. Requires --end-date, --organization-id and --start-date, with a worked example.
- [vf analytics query function-usage](https://www.voiceflow.com/docs/cli/commands/analytics/query/function-usage.md): vf analytics query function-usage: query function usage. Requires --end-date, --project-id and --start-date, with a worked example.
- [vf analytics query hourly-organization-token-usage](https://www.voiceflow.com/docs/cli/commands/analytics/query/hourly-organization-token-usage.md): vf analytics query hourly-organization-token-usage: query hourly organization token usage. Requires --end-date, --organization-id and --start-date.
- [vf analytics query hourly-project-token-usage](https://www.voiceflow.com/docs/cli/commands/analytics/query/hourly-project-token-usage.md): vf analytics query hourly-project-token-usage: query hourly project token usage. Requires --end-date, --interval, --project-id and --start-date.
- [vf analytics query integration-usage](https://www.voiceflow.com/docs/cli/commands/analytics/query/integration-usage.md): vf analytics query integration-usage: query integration usage. Requires --end-date, --project-id and --start-date, with a worked example.
- [vf analytics query intent-usage](https://www.voiceflow.com/docs/cli/commands/analytics/query/intent-usage.md): vf analytics query intent-usage: query intent usage. Requires --end-date, --project-id and --start-date, with a worked example.
- [vf analytics query knowledge-base-document-usage](https://www.voiceflow.com/docs/cli/commands/analytics/query/knowledge-base-document-usage.md): vf analytics query knowledge-base-document-usage: query knowledge base document usage. Requires --end-date, --project-id and --start-date.
- [vf analytics query mcp-tool-usage](https://www.voiceflow.com/docs/cli/commands/analytics/query/mcp-tool-usage.md): vf analytics query mcp-tool-usage: query MCP tool usage. Requires --end-date, --project-id and --start-date, with a worked example.
- [vf analytics query organization-token-usage](https://www.voiceflow.com/docs/cli/commands/analytics/query/organization-token-usage.md): vf analytics query organization-token-usage: query organization token usage. Requires --end-date, --organization-id and --start-date, with a worked example.
- [vf analytics query playbook-usage](https://www.voiceflow.com/docs/cli/commands/analytics/query/playbook-usage.md): vf analytics query playbook-usage: query playbook usage. Requires --end-date, --project-id and --start-date, with a worked example.
- [vf analytics query project-interaction-count](https://www.voiceflow.com/docs/cli/commands/analytics/query/project-interaction-count.md): vf analytics query project-interaction-count: query project interaction count. Requires --end-date, --interval, --project-id and --start-date.
- [vf analytics query project-token-usage](https://www.voiceflow.com/docs/cli/commands/analytics/query/project-token-usage.md): vf analytics query project-token-usage: query project token usage. Requires --end-date, --interval, --project-id and --start-date, with a worked example.
- [vf analytics query project-transcript-cost](https://www.voiceflow.com/docs/cli/commands/analytics/query/project-transcript-cost.md): vf analytics query project-transcript-cost: query transcript cost. Requires --end-date, --interval, --project-id and --start-date, with a worked example.
- [vf analytics query project-transcript-count](https://www.voiceflow.com/docs/cli/commands/analytics/query/project-transcript-count.md): vf analytics query project-transcript-count: query project transcript count. Requires --end-date, --interval, --project-id and --start-date.
- [vf analytics query prompt-usage](https://www.voiceflow.com/docs/cli/commands/analytics/query/prompt-usage.md): vf analytics query prompt-usage: query prompt usage. Requires --end-date, --project-id and --start-date, with a worked example.
- [vf analytics query unique-user-count](https://www.voiceflow.com/docs/cli/commands/analytics/query/unique-user-count.md): vf analytics query unique-user-count: query unique user count. Requires --end-date, --interval, --project-id and --start-date, with a worked example.
- [vf analytics query workflow-usage](https://www.voiceflow.com/docs/cli/commands/analytics/query/workflow-usage.md): vf analytics query workflow-usage: query workflow usage. Requires --end-date, --project-id and --start-date, with a worked example.
- [vf analytics query workspace-interaction-count](https://www.voiceflow.com/docs/cli/commands/analytics/query/workspace-interaction-count.md): vf analytics query workspace-interaction-count: query workspace interaction count. Requires --end-date, --start-date and --workspace-id, with a worked example.
- [vf analytics query workspace-token-usage](https://www.voiceflow.com/docs/cli/commands/analytics/query/workspace-token-usage.md): vf analytics query workspace-token-usage: query workspace token usage. Requires --end-date, --start-date and --workspace-id, with a worked example.
- [vf analytics query workspace-transcript-count](https://www.voiceflow.com/docs/cli/commands/analytics/query/workspace-transcript-count.md): vf analytics query workspace-transcript-count: query workspace transcript count. Requires --end-date, --start-date and --workspace-id, with a worked example.
- [vf api-tool - Operations for api-tool](https://www.voiceflow.com/docs/cli/commands/api-tool.md): vf api-tool: operations for api-tool. Groups 6 subcommands: create, delete, get, list, update, variable.
- [vf api-tool create - Create API tool](https://www.voiceflow.com/docs/cli/commands/api-tool/create.md): vf api-tool create: create API tool. Requires --environment-alias, --http-method, --name and --project-id, with a worked example.
- [vf api-tool delete - Delete API tool](https://www.voiceflow.com/docs/cli/commands/api-tool/delete.md): vf api-tool delete: delete API tool. Requires --environment-alias, --project-id and --tool-id, with a worked example.
- [vf api-tool get - Get API tool](https://www.voiceflow.com/docs/cli/commands/api-tool/get.md): vf api-tool get: get API tool. Requires --environment-alias, --project-id and --tool-id, with a worked example.
- [vf api-tool list - List API tools](https://www.voiceflow.com/docs/cli/commands/api-tool/list.md): vf api-tool list: list API tools. Requires --environment-alias and --project-id, with a worked example.
- [vf api-tool update - Update API tool](https://www.voiceflow.com/docs/cli/commands/api-tool/update.md): vf api-tool update: update API tool. Requires --environment-alias, --project-id and --tool-id, with a worked example.
- [vf api-tool variable](https://www.voiceflow.com/docs/cli/commands/api-tool/variable.md): vf api-tool variable: operations for api-tool-variable. Groups 5 subcommands: create, delete, get, list, update.
- [vf api-tool variable create](https://www.voiceflow.com/docs/cli/commands/api-tool/variable/create.md): vf api-tool variable create: create variable. Requires --api-tool-id, --environment-alias, --name and --project-id, with a worked example.
- [vf api-tool variable delete](https://www.voiceflow.com/docs/cli/commands/api-tool/variable/delete.md): vf api-tool variable delete: delete variable. Requires --environment-alias, --project-id and --variable-id, with a worked example.
- [vf api-tool variable get - Get variable](https://www.voiceflow.com/docs/cli/commands/api-tool/variable/get.md): vf api-tool variable get: get variable. Requires --environment-alias, --project-id and --variable-id, with a worked example.
- [vf api-tool variable list - List variables](https://www.voiceflow.com/docs/cli/commands/api-tool/variable/list.md): vf api-tool variable list: list variables. Requires --api-tool-id, --environment-alias and --project-id, with a worked example.
- [vf api-tool variable update](https://www.voiceflow.com/docs/cli/commands/api-tool/variable/update.md): vf api-tool variable update: update variable. Requires --environment-alias, --project-id and --variable-id, with a worked example.
- [vf auth](https://www.voiceflow.com/docs/cli/commands/auth.md): vf auth: manage authentication credentials. Groups 3 subcommands: login, logout, whoami.
- [vf auth login](https://www.voiceflow.com/docs/cli/commands/auth/login.md): vf auth login: interactively configure authentication credentials. Takes no required flags.
- [vf auth logout](https://www.voiceflow.com/docs/cli/commands/auth/logout.md): vf auth logout: clear all stored authentication credentials. Takes no required flags.
- [vf auth whoami](https://www.voiceflow.com/docs/cli/commands/auth/whoami.md): vf auth whoami: display current authentication configuration. Takes no required flags.
- [vf configure](https://www.voiceflow.com/docs/cli/commands/configure.md): vf configure: configure authentication credentials and preferences. Takes no required flags.
- [vf conversation](https://www.voiceflow.com/docs/cli/commands/conversation.md): vf conversation: operations for conversation. Groups 2 subcommands: send, state.
- [vf conversation send - Send](https://www.voiceflow.com/docs/cli/commands/conversation/send.md): vf conversation send: send. Requires --environment-alias, --project-id, --user-id and --version-param, with a worked example.
- [vf conversation state](https://www.voiceflow.com/docs/cli/commands/conversation/state.md): vf conversation state: operations for state. Groups 4 subcommands: delete, get, update, update-variables.
- [vf conversation state delete](https://www.voiceflow.com/docs/cli/commands/conversation/state/delete.md): vf conversation state delete: delete state. Requires --environment-alias, --project-id, --user-id and --version-param, with a worked example.
- [vf conversation state get - Get state](https://www.voiceflow.com/docs/cli/commands/conversation/state/get.md): vf conversation state get: get state. Requires --environment-alias, --project-id, --user-id and --version-param, with a worked example.
- [vf conversation state update](https://www.voiceflow.com/docs/cli/commands/conversation/state/update.md): vf conversation state update: update state. Requires --environment-alias, --project-id, --stack, --storage, --user-id, --variables and --version-param.
- [vf conversation state update-variables](https://www.voiceflow.com/docs/cli/commands/conversation/state/update-variables.md): vf conversation state update-variables: update variables. Requires --environment-alias, --project-id, --user-id, --variables and --version-param.
- [vf document](https://www.voiceflow.com/docs/cli/commands/document.md): vf document: operations for document. Groups 7 subcommands: create-table, create-text, create-url, delete, get, list, update.
- [vf document create-table](https://www.voiceflow.com/docs/cli/commands/document/create-table.md): vf document create-table: create table document. Requires --environment-alias, --items, --name, --project-id and --schema, with a worked example.
- [vf document create-text](https://www.voiceflow.com/docs/cli/commands/document/create-text.md): vf document create-text: create text document. Requires --environment-alias, --file and --project-id, with a worked example.
- [vf document create-url](https://www.voiceflow.com/docs/cli/commands/document/create-url.md): vf document create-url: create URL document. Requires --environment-alias, --project-id and --url, with a worked example.
- [vf document delete](https://www.voiceflow.com/docs/cli/commands/document/delete.md): vf document delete: delete document. Requires --document-id, --environment-alias and --project-id, with a worked example.
- [vf document get - Get document](https://www.voiceflow.com/docs/cli/commands/document/get.md): vf document get: get document. Requires --document-id, --environment-alias and --project-id, with a worked example.
- [vf document list - List documents](https://www.voiceflow.com/docs/cli/commands/document/list.md): vf document list: list documents. Requires --environment-alias and --project-id, with a worked example.
- [vf document update](https://www.voiceflow.com/docs/cli/commands/document/update.md): vf document update: update document. Requires --document-id, --environment-alias, --metadata and --project-id, with a worked example.
- [vf environment](https://www.voiceflow.com/docs/cli/commands/environment.md): vf environment: operations for environment. Groups 9 subcommands: clone, compile, delete, get, list, merge, publish, update, update-traffic-split.
- [vf environment clone](https://www.voiceflow.com/docs/cli/commands/environment/clone.md): vf environment clone: clone environment. Requires --alias, --environment-alias, --name and --project-id, with a worked example.
- [vf environment compile](https://www.voiceflow.com/docs/cli/commands/environment/compile.md): vf environment compile: compile environment. Requires --environment-alias and --project-id, with a worked example.
- [vf environment delete](https://www.voiceflow.com/docs/cli/commands/environment/delete.md): vf environment delete: delete environment. Requires --environment-alias and --project-id, with a worked example.
- [vf environment get - Get environment](https://www.voiceflow.com/docs/cli/commands/environment/get.md): vf environment get: get environment. Requires --environment-alias and --project-id, with a worked example.
- [vf environment list](https://www.voiceflow.com/docs/cli/commands/environment/list.md): vf environment list: list environments. Requires --project-id, with a worked example.
- [vf environment merge](https://www.voiceflow.com/docs/cli/commands/environment/merge.md): vf environment merge: merge environments. Requires --project-id, --source-environment-alias and --target-environment-alias, with a worked example.
- [vf environment publish](https://www.voiceflow.com/docs/cli/commands/environment/publish.md): vf environment publish: publish environment. Requires --environment-alias, --name and --project-id, with a worked example.
- [vf environment update](https://www.voiceflow.com/docs/cli/commands/environment/update.md): vf environment update: update environment. Requires --environment-alias and --project-id, with a worked example.
- [vf environment update-traffic-split](https://www.voiceflow.com/docs/cli/commands/environment/update-traffic-split.md): vf environment update-traffic-split: update traffic split. Requires --project-id and --traffic, with a worked example.
- [vf evaluation](https://www.voiceflow.com/docs/cli/commands/evaluation.md): vf evaluation: operations for evaluation. Groups 6 subcommands: create, delete, get, list, run, update.
- [vf evaluation create](https://www.voiceflow.com/docs/cli/commands/evaluation/create.md): vf evaluation create: create evaluation. Requires --body-param and --project-id, with a worked example.
- [vf evaluation delete](https://www.voiceflow.com/docs/cli/commands/evaluation/delete.md): vf evaluation delete: delete evaluation. Requires --evaluation-id and --project-id, with a worked example.
- [vf evaluation get - Get evaluation](https://www.voiceflow.com/docs/cli/commands/evaluation/get.md): vf evaluation get: get evaluation. Requires --evaluation-id and --project-id, with a worked example.
- [vf evaluation list - List evaluations](https://www.voiceflow.com/docs/cli/commands/evaluation/list.md): vf evaluation list: list evaluations. Requires --project-id, with a worked example.
- [vf evaluation run - Run evaluation](https://www.voiceflow.com/docs/cli/commands/evaluation/run.md): vf evaluation run: run evaluation. Requires --evaluation-id, --project-id and --transcript-id, with a worked example.
- [vf evaluation update](https://www.voiceflow.com/docs/cli/commands/evaluation/update.md): vf evaluation update: update evaluation. Requires --evaluation-id and --project-id, with a worked example.
- [vf explore](https://www.voiceflow.com/docs/cli/commands/explore.md): vf explore: interactively browse and run commands. Takes no required flags.
- [vf function - Operations for function](https://www.voiceflow.com/docs/cli/commands/function.md): vf function: operations for function. Groups 7 subcommands: create, delete, get, list, path, update, variable.
- [vf function create - Create function](https://www.voiceflow.com/docs/cli/commands/function/create.md): vf function create: create function. Requires --code, --environment-alias, --name and --project-id, with a worked example.
- [vf function delete - Delete function](https://www.voiceflow.com/docs/cli/commands/function/delete.md): vf function delete: delete function. Requires --environment-alias, --function-id and --project-id, with a worked example.
- [vf function get - Get function](https://www.voiceflow.com/docs/cli/commands/function/get.md): vf function get: get function. Requires --environment-alias, --function-id and --project-id, with a worked example.
- [vf function list - List functions](https://www.voiceflow.com/docs/cli/commands/function/list.md): vf function list: list functions. Requires --environment-alias and --project-id, with a worked example.
- [vf function path - Operations for path](https://www.voiceflow.com/docs/cli/commands/function/path.md): vf function path: operations for path. Groups 5 subcommands: create, delete, get, list, update.
- [vf function path create - Create path](https://www.voiceflow.com/docs/cli/commands/function/path/create.md): vf function path create: create path. Requires --environment-alias, --function-id, --name and --project-id, with a worked example.
- [vf function path delete - Delete path](https://www.voiceflow.com/docs/cli/commands/function/path/delete.md): vf function path delete: delete path. Requires --environment-alias, --path-id and --project-id, with a worked example.
- [vf function path get - Get path](https://www.voiceflow.com/docs/cli/commands/function/path/get.md): vf function path get: get path. Requires --environment-alias, --path-id and --project-id, with a worked example.
- [vf function path list - List paths](https://www.voiceflow.com/docs/cli/commands/function/path/list.md): vf function path list: list paths. Requires --environment-alias, --function-id and --project-id, with a worked example.
- [vf function path update - Update path](https://www.voiceflow.com/docs/cli/commands/function/path/update.md): vf function path update: update path. Requires --environment-alias, --path-id and --project-id, with a worked example.
- [vf function update - Update function](https://www.voiceflow.com/docs/cli/commands/function/update.md): vf function update: update function. Requires --environment-alias, --function-id and --project-id, with a worked example.
- [vf function variable](https://www.voiceflow.com/docs/cli/commands/function/variable.md): vf function variable: operations for function-variable. Groups 5 subcommands: create, delete, get, list, update.
- [vf function variable create](https://www.voiceflow.com/docs/cli/commands/function/variable/create.md): vf function variable create: create variable. Requires --environment-alias, --function-id, --name, --project-id and --type, with a worked example.
- [vf function variable delete](https://www.voiceflow.com/docs/cli/commands/function/variable/delete.md): vf function variable delete: delete variable. Requires --environment-alias, --project-id and --variable-id, with a worked example.
- [vf function variable get - Get variable](https://www.voiceflow.com/docs/cli/commands/function/variable/get.md): vf function variable get: get variable. Requires --environment-alias, --project-id and --variable-id, with a worked example.
- [vf function variable list - List variables](https://www.voiceflow.com/docs/cli/commands/function/variable/list.md): vf function variable list: list variables. Requires --environment-alias, --function-id and --project-id, with a worked example.
- [vf function variable update](https://www.voiceflow.com/docs/cli/commands/function/variable/update.md): vf function variable update: update variable. Requires --environment-alias, --project-id and --variable-id, with a worked example.
- [vf knowledge-base](https://www.voiceflow.com/docs/cli/commands/knowledge-base.md): vf knowledge-base: operations for knowledge-base. Groups 1 subcommand: query.
- [vf knowledge-base query](https://www.voiceflow.com/docs/cli/commands/knowledge-base/query.md): vf knowledge-base query: query knowledge base. Requires --environment-alias, --project-id, --question and --version-param, with a worked example.
- [vf mcp-server](https://www.voiceflow.com/docs/cli/commands/mcp-server.md): vf mcp-server: operations for mcp-server. Groups 6 subcommands: create, delete, get, list, sync, update.
- [vf mcp-server create](https://www.voiceflow.com/docs/cli/commands/mcp-server/create.md): vf mcp-server create: create MCP server. Requires --environment-alias, --name, --project-id and --url, with a worked example.
- [vf mcp-server delete](https://www.voiceflow.com/docs/cli/commands/mcp-server/delete.md): vf mcp-server delete: delete MCP server. Requires --environment-alias, --project-id and --server-id, with a worked example.
- [vf mcp-server get - Get MCP server](https://www.voiceflow.com/docs/cli/commands/mcp-server/get.md): vf mcp-server get: get MCP server. Requires --environment-alias, --project-id and --server-id, with a worked example.
- [vf mcp-server list - List MCP servers](https://www.voiceflow.com/docs/cli/commands/mcp-server/list.md): vf mcp-server list: list MCP servers. Requires --environment-alias and --project-id, with a worked example.
- [vf mcp-server sync](https://www.voiceflow.com/docs/cli/commands/mcp-server/sync.md): vf mcp-server sync: sync MCP server. Requires --environment-alias, --project-id and --server-id, with a worked example.
- [vf mcp-server update](https://www.voiceflow.com/docs/cli/commands/mcp-server/update.md): vf mcp-server update: update MCP server. Requires --environment-alias, --project-id and --server-id, with a worked example.
- [vf mcp-tool - Operations for mcp-tool](https://www.voiceflow.com/docs/cli/commands/mcp-tool.md): vf mcp-tool: operations for mcp-tool. Groups 2 subcommands: get, list.
- [vf mcp-tool get - Get MCP tool](https://www.voiceflow.com/docs/cli/commands/mcp-tool/get.md): vf mcp-tool get: get MCP tool. Requires --environment-alias, --project-id and --tool-id, with a worked example.
- [vf mcp-tool list - List MCP tools](https://www.voiceflow.com/docs/cli/commands/mcp-tool/list.md): vf mcp-tool list: list MCP tools. Requires --environment-alias and --project-id, with a worked example.
- [vf playbook - Operations for playbook](https://www.voiceflow.com/docs/cli/commands/playbook.md): vf playbook: operations for playbook. Groups 5 subcommands: create, delete, get, list, update.
- [vf playbook create - Create playbook](https://www.voiceflow.com/docs/cli/commands/playbook/create.md): vf playbook create: create playbook. Requires --environment-alias, --name and --project-id, with a worked example.
- [vf playbook delete - Delete playbook](https://www.voiceflow.com/docs/cli/commands/playbook/delete.md): vf playbook delete: delete playbook. Requires --environment-alias, --playbook-id and --project-id, with a worked example.
- [vf playbook get - Get playbook](https://www.voiceflow.com/docs/cli/commands/playbook/get.md): vf playbook get: get playbook. Requires --environment-alias, --playbook-id and --project-id, with a worked example.
- [vf playbook list - List playbooks](https://www.voiceflow.com/docs/cli/commands/playbook/list.md): vf playbook list: list playbooks. Requires --environment-alias and --project-id, with a worked example.
- [vf playbook update](https://www.voiceflow.com/docs/cli/commands/playbook/update.md): vf playbook update: update playbook. Requires --environment-alias, --playbook-id and --project-id, with a worked example.
- [vf project - Operations for project](https://www.voiceflow.com/docs/cli/commands/project.md): vf project: operations for project. Groups 5 subcommands: create, delete, get, list, update.
- [vf project create - Create project](https://www.voiceflow.com/docs/cli/commands/project/create.md): vf project create: create project. Requires --name, --type and --workspace-id, with a worked example.
- [vf project delete - Delete project](https://www.voiceflow.com/docs/cli/commands/project/delete.md): vf project delete: delete project. Requires --project-id, with a worked example.
- [vf project get - Get project](https://www.voiceflow.com/docs/cli/commands/project/get.md): vf project get: get project. Requires --project-id, with a worked example.
- [vf project list - List projects](https://www.voiceflow.com/docs/cli/commands/project/list.md): vf project list: list projects. Requires --workspace-id, with a worked example.
- [vf project update - Update project](https://www.voiceflow.com/docs/cli/commands/project/update.md): vf project update: update project. Requires --project-id, with a worked example.
- [vf tool - Operations for tool](https://www.voiceflow.com/docs/cli/commands/tool.md): vf tool: operations for tool. Groups 5 subcommands: create, delete, get, list, update.
- [vf tool create - Create tool](https://www.voiceflow.com/docs/cli/commands/tool/create.md): vf tool create: create tool. Requires --environment-alias and --project-id, with a worked example.
- [vf tool delete - Delete tool](https://www.voiceflow.com/docs/cli/commands/tool/delete.md): vf tool delete: delete tool. Requires --environment-alias, --project-id, --tool-id and --type, with a worked example.
- [vf tool get - Get tool](https://www.voiceflow.com/docs/cli/commands/tool/get.md): vf tool get: get tool. Requires --environment-alias, --project-id, --tool-id and --type, with a worked example.
- [vf tool list - List tools](https://www.voiceflow.com/docs/cli/commands/tool/list.md): vf tool list: list tools. Requires --environment-alias and --project-id, with a worked example.
- [vf tool update - Update tool](https://www.voiceflow.com/docs/cli/commands/tool/update.md): vf tool update: update tool. Requires --environment-alias, --project-id and --tool-id, with a worked example.
- [vf transcript](https://www.voiceflow.com/docs/cli/commands/transcript.md): vf transcript: operations for transcript. Groups 3 subcommands: get, property, search.
- [vf transcript get - Get transcript](https://www.voiceflow.com/docs/cli/commands/transcript/get.md): vf transcript get: get transcript. Requires --project-id and --transcript-id, with a worked example.
- [vf transcript property](https://www.voiceflow.com/docs/cli/commands/transcript/property.md): vf transcript property: operations for property. Groups 6 subcommands: create, delete, get, list, set-value, update.
- [vf transcript property create](https://www.voiceflow.com/docs/cli/commands/transcript/property/create.md): vf transcript property create: create property. Requires --name, --project-id and --type, with a worked example.
- [vf transcript property delete](https://www.voiceflow.com/docs/cli/commands/transcript/property/delete.md): vf transcript property delete: delete property. Requires --project-id and --property-id, with a worked example.
- [vf transcript property get](https://www.voiceflow.com/docs/cli/commands/transcript/property/get.md): vf transcript property get: get property. Requires --project-id and --property-id, with a worked example.
- [vf transcript property list](https://www.voiceflow.com/docs/cli/commands/transcript/property/list.md): vf transcript property list: list properties. Requires --project-id, with a worked example.
- [vf transcript property set-value](https://www.voiceflow.com/docs/cli/commands/transcript/property/set-value.md): vf transcript property set-value: set property value. Requires --project-id, --property-id, --transcript-id and --value, with a worked example.
- [vf transcript property update](https://www.voiceflow.com/docs/cli/commands/transcript/property/update.md): vf transcript property update: update property. Requires --project-id and --property-id, with a worked example.
- [vf transcript search](https://www.voiceflow.com/docs/cli/commands/transcript/search.md): vf transcript search: search transcripts. Requires --project-id, with a worked example.
- [vf variable - Operations for variable](https://www.voiceflow.com/docs/cli/commands/variable.md): vf variable: operations for variable. Groups 5 subcommands: create, delete, get, list, update.
- [vf variable create - Create variable](https://www.voiceflow.com/docs/cli/commands/variable/create.md): vf variable create: create variable. Requires --color-param, --environment-alias, --name and --project-id, with a worked example.
- [vf variable delete - Delete variable](https://www.voiceflow.com/docs/cli/commands/variable/delete.md): vf variable delete: delete variable. Requires --environment-alias, --project-id and --variable-id, with a worked example.
- [vf variable get - Get variable](https://www.voiceflow.com/docs/cli/commands/variable/get.md): vf variable get: get variable. Requires --environment-alias, --project-id and --variable-id, with a worked example.
- [vf variable list - List variables](https://www.voiceflow.com/docs/cli/commands/variable/list.md): vf variable list: list variables. Requires --environment-alias and --project-id, with a worked example.
- [vf variable update - Update variable](https://www.voiceflow.com/docs/cli/commands/variable/update.md): vf variable update: update variable. Requires --environment-alias, --project-id and --variable-id, with a worked example.
- [vf version - Print the CLI version](https://www.voiceflow.com/docs/cli/commands/version.md): vf version: print the CLI version. Takes no required flags.
- [vf whoami](https://www.voiceflow.com/docs/cli/commands/whoami.md): vf whoami: display current authentication configuration. Takes no required flags.
- [vf workspace](https://www.voiceflow.com/docs/cli/commands/workspace.md): vf workspace: operations for workspace. Groups 5 subcommands: create, delete, get, list, update.
- [vf workspace create](https://www.voiceflow.com/docs/cli/commands/workspace/create.md): vf workspace create: create workspace. Requires --name and --organization-id, with a worked example.
- [vf workspace delete](https://www.voiceflow.com/docs/cli/commands/workspace/delete.md): vf workspace delete: delete workspace. Requires --workspace-id, with a worked example.
- [vf workspace get - Get workspace](https://www.voiceflow.com/docs/cli/commands/workspace/get.md): vf workspace get: get workspace. Requires --workspace-id, with a worked example.
- [vf workspace list - List workspaces](https://www.voiceflow.com/docs/cli/commands/workspace/list.md): vf workspace list: list workspaces. Takes no required flags, and carries a worked example.
- [vf workspace update](https://www.voiceflow.com/docs/cli/commands/workspace/update.md): vf workspace update: update workspace. Requires --workspace-id, with a worked example.
- [Changelog](https://www.voiceflow.com/docs/changelog/changelog.md): Stay up to date with Voiceflow product updates, new features, bug fixes, and platform improvements shipped across the agent builder and APIs.
- [Voiceflow glossary](https://www.voiceflow.com/docs/resources/glossary.md): What each term in Voiceflow means, grouped the same way the documentation is, with every entry linking to the page that explains it in full.
- [Core objects](https://www.voiceflow.com/docs/resources/glossary/core-objects.md): Workspace, project and agent: the three containers everything else in Voiceflow sits inside, and the words most API calls are keyed by.
- [Build](https://www.voiceflow.com/docs/resources/glossary/build.md): Playbooks, workflows, steps, tools and the two prompt layers: every part an agent is assembled from, and when to reach for each one.
- [Knowledge and data](https://www.voiceflow.com/docs/resources/glossary/knowledge-and-data.md): The knowledge base, data sources, variables, secrets and redaction: what an agent reads, writes and protects while a conversation runs.
- [Deploy](https://www.voiceflow.com/docs/resources/glossary/deploy.md): Environments, publishing, merging and traffic splits: how a change reaches real users, and the chat widget it reaches them through.
- [Measure](https://www.voiceflow.com/docs/resources/glossary/measure.md): Transcripts, evaluations, tests, analytics and credits: the words for reading back what an agent actually did, and what it cost to do.
- [Developer surfaces](https://www.voiceflow.com/docs/resources/glossary/developer-surfaces.md): Tokens, traces, the CLI and MCP: the vocabulary for driving Voiceflow over HTTP, including the one credential that is not the others.
- [AI terms](https://www.voiceflow.com/docs/resources/glossary/ai-terms.md): Model, token, context window, RAG, embedding, grounding and hallucination: general industry terms, defined exactly as these docs use them.

## OpenAPI Specs

- [openapi.stable](https://www.voiceflow.com/docs/specs-prettified/realtime/openapi.stable.json)
- [openapi.public](https://www.voiceflow.com/docs/specs/realtime/openapi.public.json)

## Optional

- [Status](https://status.voiceflow.com)