# Tavus

- [Introduction](https://docs.tavus.io/sections/introduction.md): Use Tavus tools and guides to build PALs with real-time human-like perception and presence, bringing the human layer to AI.
- [Agents & Automation](https://docs.tavus.io/sections/agents-and-automation.md): How to access machine-readable docs and API artifacts for developers, IDEs, and automation - llms.txt, OpenAPI, Agent Skills, and MCP.
- [What Is a PAL?](https://docs.tavus.io/sections/conversational-video-interface/pal/what-is-a-pal.md): A short definition of PAL, how it relates to Face and Conversation, and where to configure one.
- [What Is CVI?](https://docs.tavus.io/sections/conversational-video-interface/overview-cvi.md): CVI enables real-time, human-like video interactions through configurable PALs.
- [Sales Development Representative](https://docs.tavus.io/sections/conversational-video-interface/conversation/usecases/sales-development-representative.md): Qualify leads on a live call and sync results to your CRM.
- [AI Interviewer](https://docs.tavus.io/sections/conversational-video-interface/conversation/usecases/ai-interviewer.md): Engage with the AI Interviewer PAL to run structured, conversational interview simulations.
- [Customer Service Agent](https://docs.tavus.io/sections/conversational-video-interface/conversation/usecases/customer-service.md): Engage in real-time customer support conversations that adapt to user emotions and behavior.
- [Medical Intake](https://docs.tavus.io/sections/conversational-video-interface/conversation/usecases/medical-intake.md): Pre-visit intake flow with structured data capture.
- [Models](https://docs.tavus.io/sections/models.md)
- [PAL Strategies](https://docs.tavus.io/sections/onboarding-guide/pal-strategies.md): Two approaches to using PALs at scale: reuse with conversational context vs. create-per-session. Choose based on whether you need different data or different behavior per conversation.
- [Tavus Tool Calling](https://docs.tavus.io/sections/onboarding-guide/tool-calling-examples.md): Key guidelines for implementing reliable tool calls in Tavus conversational agents
- [Reducing Join Latency](https://docs.tavus.io/sections/onboarding-guide/latency-optimization.md): Strategies to reduce perceived and actual latency when starting Tavus conversations
- [Prompting Guide](https://docs.tavus.io/sections/onboarding-guide/prompting-guide.md): The recommended structure for writing system prompts for Tavus CVI PALs - identity, style, behaviors, and guardrails that work in real-time video conversations.
- [Objectives Prompting Guide](https://docs.tavus.io/sections/onboarding-guide/objectives.md): Write clear, testable prompts for objectives with practical examples.
- [EU AI Act Compliance](https://docs.tavus.io/sections/onboarding-guide/eu-ai-act.md): Product controls for biometric emotion recognition and AI disclosure, relevant to EU AI Act configuration of PALs and conversations.
- [API Conversation Quickstart](https://docs.tavus.io/sections/conversational-video-interface/quickstart/cvi-quickstart.md): Create your first PAL using the full pipeline and start a conversation in seconds.
- [Overview](https://docs.tavus.io/sections/agent-tools/overview.md): Build a PAL, wire its tool calls into your own code, and test the integration from your editor with the MCP server or your terminal with the CLI.
- [MCP Server](https://docs.tavus.io/sections/agent-tools/mcp-server.md): Connect your coding agent to the hosted Tavus MCP server to build PALs, wire bidirectional tool calls into your own code, and test the integration end to end.
- [MCP Tools Reference](https://docs.tavus.io/sections/agent-tools/mcp-tools-reference.md): Complete reference for every tool exposed by the Tavus MCP server, grouped by category.
- [CLI](https://docs.tavus.io/sections/agent-tools/cli.md): Install, authenticate, and drive the Tavus CLI to manage PALs, faces, conversations, and the agentic resource library from your terminal.
- [Agentic PAL Building & Testing](https://docs.tavus.io/sections/agent-tools/pal-build-and-verify.md): Use the Tavus MCP server or CLI to build a new PAL in a loop: adjust configuration, run simulated CVI chat turns, judge the result, and refine until the PAL behaves as intended.
- [Pipeline Modes](https://docs.tavus.io/sections/conversational-video-interface/quickstart/pipeline-modes.md): Run CVI with the full Tavus pipeline, Echo mode, or integrate via LiveKit and Pipecat.
- [Overview](https://docs.tavus.io/sections/conversational-video-interface/pal/overview.md): Define how your PAL behaves, responds, and speaks by configuring layers and pipeline modes.
- [Stock PALs](https://docs.tavus.io/sections/conversational-video-interface/pal/stock-pals.md): Tavus offers pre-built PAL templates to help you get started quickly.
- [PAL Editing Lifecycle](https://docs.tavus.io/sections/conversational-video-interface/pal/editing-lifecycle.md): Once a PAL has a deployment, PAL Maker edits become drafts you push. API edits keep going straight to the live PAL.
- [Objectives](https://docs.tavus.io/sections/conversational-video-interface/pal/objectives.md): Objectives are goal-oriented instructions to define the desired outcomes and flow of your conversations.
- [Guardrails](https://docs.tavus.io/sections/conversational-video-interface/guardrails.md): Guardrails provide your PAL with strict behavioral guidelines that will be rigorously followed throughout every conversation.
- [Knowledge Base](https://docs.tavus.io/sections/conversational-video-interface/knowledge-base.md): Upload documents to your knowledge base for PALs to reference during conversations.
- [Memories](https://docs.tavus.io/sections/conversational-video-interface/memories.md): Help a PAL remember each participant and build continuity across conversations.
- [Overview](https://docs.tavus.io/sections/faces/overview.md): Understand Tavus Faces, learn how to create your own using a video or an image, or explore ready-to-use stock Faces.
- [Video to Face](https://docs.tavus.io/sections/faces/video-to-face-quickstart.md): Create a Phoenix face from a training video using the Create Face and Get Face APIs.
- [Image to Face](https://docs.tavus.io/sections/faces/image-to-face-quickstart.md): Create a Phoenix face from a headshot image using the Create Face and Get Face APIs.
- [Phoenix-4.5 Preview and Status](https://docs.tavus.io/sections/faces/phoenix-45-preview-and-status.md): How status and finetune_status work while a Phoenix-4.5 face goes from zero-shot preview to tuned.
- [Voices for Image-Based Faces](https://docs.tavus.io/sections/faces/voices-for-image-based-faces.md): Pick a voice when you train a face from a photo: use your own, or pick a stock voice to get running faster.
- [Choose a Model and Training Path](https://docs.tavus.io/sections/faces/which-training-path.md): Pick a Phoenix model, then decide whether to train from a photo or a video.
- [Phoenix-4.5 Image Requirements](https://docs.tavus.io/sections/faces/phoenix-45-image-requirements.md): Photo rules for training a Phoenix-4.5 face from an image.
- [Phoenix-4.5 Video Requirements](https://docs.tavus.io/sections/faces/phoenix-45-video-requirements.md): Recording rules for training a Phoenix-4.5 face from video.
- [Phoenix-4 Image Requirements](https://docs.tavus.io/sections/faces/phoenix-4-image-requirements.md): Photo rules for training a Phoenix-4 face from an image.
- [Phoenix-4 Video Requirements](https://docs.tavus.io/sections/faces/phoenix-4-video-requirements.md): Recording rules for training a Phoenix-4 face from video, including full body.
- [Phoenix-3 Video Requirements (Legacy)](https://docs.tavus.io/sections/faces/phoenix-3-video-requirements.md): Legacy recording rules for training a Phoenix-3 face from video.
- [Emotion Control with Phoenix-4 and Phoenix-4.5](https://docs.tavus.io/sections/conversational-video-interface/quickstart/emotional-expression.md): Unlock emotionally expressive facial movements and micro-expressions using Phoenix-4 and Phoenix-4.5 faces.
- [Stock Faces](https://docs.tavus.io/sections/faces/stock-faces.md): Start a conversation instantly with our ready-to-use stock faces - no training required. Stock faces are prebuilt, high-quality faces designed for natural, expressive communication. They enable lifelike interactions with dynamic facial expressions, smooth turn-taking, and consistent, high-quality vi…
- [Stock Face Model Map](https://docs.tavus.io/sections/faces/stock-face-model-map.md): UUID map so you can track Tavus stock faces and their looks across multiple Phoenix models. Always use the latest when available!
- [Face FAQs](https://docs.tavus.io/sections/faces/face-faqs.md)
- [Voices](https://docs.tavus.io/sections/conversational-video-interface/voices.md): Create a voice once, then use it by ID on any number of PALs and Faces.
- [Text-to-Speech (TTS)](https://docs.tavus.io/sections/conversational-video-interface/pal/tts.md): Configure how your PAL sounds. Set a Tavus Voice by ID, or bring a voice from your own TTS provider account.
- [Language Support](https://docs.tavus.io/sections/conversational-video-interface/language-support.md): Declare the languages a conversation may run in, and see which languages Tavus can speak and hear.
- [Pronunciation Dictionaries](https://docs.tavus.io/sections/conversational-video-interface/pal/pronunciation-dictionaries.md): Control how your PAL pronounces specific words, names, and terms during conversations.
- [Conversational Flow](https://docs.tavus.io/sections/conversational-video-interface/pal/conversational-flow.md): Learn how to configure the Conversational Flow layer to fine-tune turn-taking and interruption handling behavior.
- [Speech-to-Text (STT)](https://docs.tavus.io/sections/conversational-video-interface/pal/stt.md): Configure the STT layer to select an STT model, improve transcription accuracy, and optimize for your target languages.
- [Large Language Model (LLM)](https://docs.tavus.io/sections/conversational-video-interface/pal/llm.md): Learn how to use Tavus-optimized LLMs or integrate your own custom LLM.
- [Perception](https://docs.tavus.io/sections/conversational-video-interface/pal/perception.md): Learn how to configure the perception layer with Raven to enable real-time visual and audio understanding.
- [Screen Share](https://docs.tavus.io/sections/conversational-video-interface/pal/screen-share.md): Let participants share their screen so your PAL can see and reason about what is on it in real time.
- [Overview](https://docs.tavus.io/sections/conversational-video-interface/skills/overview.md): Attach pre-built capabilities like internet search, presentations, and interactive UI to your PALs.
- [Presentation](https://docs.tavus.io/sections/conversational-video-interface/skills/presentation.md): Let your PAL walk participants through a slide deck from your Knowledge Base.
- [Magic Canvas Overview](https://docs.tavus.io/sections/conversational-video-interface/magic-canvas/overview.md): Let your PAL show interactive UI (questions, calendars, charts, and more) inside a live video conversation.
- [Magic Canvas Quickstart](https://docs.tavus.io/sections/conversational-video-interface/magic-canvas/quickstart.md): Attach the Magic Canvas skill to a PAL, render cards in the call, and receive every interaction on your webhook.
- [Canvas Components](https://docs.tavus.io/sections/conversational-video-interface/magic-canvas/components.md): Every card the PAL can show, and how to enable and configure them.
- [Component: question](https://docs.tavus.io/sections/conversational-video-interface/magic-canvas/components/question.md): Show a multiple-choice question card on screen and get a structured answer back.
- [Component: input](https://docs.tavus.io/sections/conversational-video-interface/magic-canvas/components/input.md): Collect a single typed value (a name, an email, a phone number) and receive it in your webhook.
- [Component: calendar](https://docs.tavus.io/sections/conversational-video-interface/magic-canvas/components/calendar.md): Let the user pick a date, a time slot, or a date range without leaving the conversation.
- [Component: scheduling_embed](https://docs.tavus.io/sections/conversational-video-interface/magic-canvas/components/scheduling-embed.md): Embed your Calendly booking page in the conversation and get a webhook when the meeting is booked.
- [Component: text](https://docs.tavus.io/sections/conversational-video-interface/magic-canvas/components/text.md): A read-only card of text (an optional heading and a body) shown alongside the live video.
- [Component: image](https://docs.tavus.io/sections/conversational-video-interface/magic-canvas/components/image.md): Show an image from your Knowledge Base or an allowlisted website on the canvas during a conversation.
- [Component: chart](https://docs.tavus.io/sections/conversational-video-interface/magic-canvas/components/chart.md): Render a bar, line, or pie chart on the canvas during a live conversation.
- [Component: alert](https://docs.tavus.io/sections/conversational-video-interface/magic-canvas/components/alert.md): Show a dismissible notice (info, success, warning, or error) inside a live conversation.
- [PAL Canvas Configuration](https://docs.tavus.io/sections/conversational-video-interface/magic-canvas/api/configuration.md): Full reference for the magic_canvas skill on PALs: attaching it, the component overlay, the skills API, and every validation error.
- [Canvas Interactions](https://docs.tavus.io/sections/conversational-video-interface/magic-canvas/api/interactions.md): Record card taps, receive canvas.interaction webhooks, and fetch Canvas interaction history.
- [Integration: Tavus-Hosted Embed and Widget](https://docs.tavus.io/sections/conversational-video-interface/magic-canvas/integrations/hosted.md): Render a Magic Canvas conversation from a single HTML tag, with no SDK code or rendering work.
- [Integration: @tavus/cvi-ui MagicCanvas](https://docs.tavus.io/sections/conversational-video-interface/magic-canvas/integrations/cvi-ui-sdk.md): Render Magic Canvas cards inside your own React app with the @tavus/cvi-ui MagicCanvas component: install, mount, and handle every interaction.
- [Internet Search](https://docs.tavus.io/sections/conversational-video-interface/skills/internet-search.md): Let your PAL answer questions with real-time web search.
- [Browser Use](https://docs.tavus.io/sections/conversational-video-interface/skills/browser-use.md): Let your PAL drive a live browser and narrate a guided flow while participants watch over screen share.
- [Overview](https://docs.tavus.io/sections/conversational-video-interface/pal/tools.md): How tool calling works on Tavus - LLM, perception, post-call, and system tools like end_call, plus delivery channels.
- [Tool Calling for LLM](https://docs.tavus.io/sections/conversational-video-interface/pal/llm-tool.md): Define reusable tools, attach them to any PAL, and deliver tool calls via app message or API call.
- [Tool Calling for Perception](https://docs.tavus.io/sections/conversational-video-interface/pal/perception-tool.md): Define vision and audio tools that fire when Raven sees or hears something during a conversation.
- [Post-Call Actions](https://docs.tavus.io/sections/conversational-video-interface/pal/post-call-tool.md): Run a tool automatically after a conversation ends - Tavus fills its open arguments from the transcript and perception analysis and delivers the result for you.
- [Tool Delivery](https://docs.tavus.io/sections/conversational-video-interface/pal/llm-tool-delivery.md): How tool calls reach your application - app messages to your frontend or HTTPS API calls to your backend.
- [Tool Authentication](https://docs.tavus.io/sections/conversational-video-interface/pal/llm-tool-auth.md): How Tavus authenticates to your endpoint when a tool is delivered via an API call.
- [MCP Connectors](https://docs.tavus.io/sections/conversational-video-interface/pal/mcp-connectors.md): Let a PAL delegate multi-step work to your MCP servers during a conversation, and follow it from your client.
- [Overview](https://docs.tavus.io/sections/conversational-video-interface/conversation/overview.md): Learn how to customize identity and advanced settings for a conversation to suit your needs.
- [Conversation Recordings](https://docs.tavus.io/sections/conversational-video-interface/quickstart/conversation-recordings.md): Store conversation recordings in your own S3, GCS, or Azure Blob storage. Federated identity - no secrets shared with Tavus.
- [Audio-Only Conversation](https://docs.tavus.io/sections/conversational-video-interface/conversation/customizations/audio-only.md): Start a conversation in audio-only mode, perfect for voice-only or low-bandwidth environments.
- [Call Duration and Timeout](https://docs.tavus.io/sections/conversational-video-interface/conversation/customizations/call-duration-and-timeout.md): Configure call duration and timeout behavior to manage how and when a conversation ends.
- [Closed Captions](https://docs.tavus.io/sections/conversational-video-interface/conversation/customizations/closed-captions.md): Enable closed captions for accessibility or live transcription during conversations.
- [Background Customizations](https://docs.tavus.io/sections/conversational-video-interface/conversation/customizations/background-customizations.md): Apply a green screen or custom background for a personalized visual experience.
- [Private Rooms](https://docs.tavus.io/sections/conversational-video-interface/conversation/customizations/private-rooms.md): Create authenticated conversations with meeting tokens for enhanced security.
- [Participant Limits](https://docs.tavus.io/sections/conversational-video-interface/conversation/customizations/participant-limits.md): Control the maximum number of participants allowed in a conversation.
- [Interaction Events](https://docs.tavus.io/sections/conversational-video-interface/interactions-protocols/overview.md): Control CVI conversations by sending and listening to interaction events.
- [Echo Interaction](https://docs.tavus.io/sections/event-schemas/conversation-echo.md)
- [Text Respond Interaction](https://docs.tavus.io/sections/event-schemas/conversation-respond.md)
- [Sensitivity Interaction](https://docs.tavus.io/sections/event-schemas/conversation-sensitivity.md)
- [Interrupt Interaction](https://docs.tavus.io/sections/event-schemas/conversation-interrupt.md)
- [Overwrite Conversational Context Interaction](https://docs.tavus.io/sections/event-schemas/conversation-overwrite-context.md)
- [Append Conversational Context Interaction](https://docs.tavus.io/sections/event-schemas/conversation-append-context.md)
- [Utterance Event](https://docs.tavus.io/sections/event-schemas/conversation-utterance.md)
- [Utterance Streaming Event](https://docs.tavus.io/sections/event-schemas/conversation-utterance-streaming.md)
- [Tool Call Event](https://docs.tavus.io/sections/event-schemas/conversation-toolcall.md)
- [Tool Call Result](https://docs.tavus.io/sections/event-schemas/conversation-tool-result.md): Return a tool's result to the conversation by sending a conversation.tool_result event.
- [Started/Stopped Speaking Event](https://docs.tavus.io/sections/event-schemas/conversation-started-stopped-speaking.md)
- [Joined/Left Event](https://docs.tavus.io/sections/event-schemas/conversation-joined-left.md)
- [Perception Tool Call Event](https://docs.tavus.io/sections/event-schemas/conversation-perception-tool-call.md)
- [Perception Analysis Event](https://docs.tavus.io/sections/event-schemas/conversation-perception-analysis.md)
- [Agent Start Event](https://docs.tavus.io/sections/event-schemas/conversation-agent-start.md)
- [Agent Update Event](https://docs.tavus.io/sections/event-schemas/conversation-agent-update.md)
- [Agent Stop Event](https://docs.tavus.io/sections/event-schemas/conversation-agent-stop.md)
- [Canvas Interaction Event](https://docs.tavus.io/sections/event-schemas/canvas-interaction.md)
- [Wake/Sleep Phrase Detected Event](https://docs.tavus.io/sections/event-schemas/system-wake-sleep-phrase-detected.md)
- [CVI App Quickstart](https://docs.tavus.io/sections/conversational-video-interface/quickstart/build-first-app.md): Create a server-authenticated Tavus CVI conversation and embed it in a web app with the returned conversation_url.
- [CVI App: AI Prompt](https://docs.tavus.io/sections/conversational-video-interface/quickstart/ai-prompt-cvi-quickstart.md): Copy-paste checklist for Cursor, Copilot, or other AI coding agents to scaffold React (TypeScript, Vite) with Tavus CVI and @tavus/cvi-ui.
- [Deployments Overview](https://docs.tavus.io/sections/deployments/overview.md): Learn how Tavus Deployments let you ship a fully managed conversational AI experience with a single script tag - no backend or API key required in the browser.
- [Widget](https://docs.tavus.io/sections/deployments/widget.md): Add a floating Tavus conversation launcher to any website with the tavus-widget custom element.
- [Embed](https://docs.tavus.io/sections/deployments/embed.md): Render a Tavus conversation inline in your layout with the tavus-embed custom element - in plain HTML, React, or Next.js.
- [Landing Page](https://docs.tavus.io/sections/deployments/landing-page.md): Share a standalone Tavus conversation with a link - fully hosted by Tavus, no website or embed code required.
- [Host Communication](https://docs.tavus.io/sections/deployments/host-communication.md): Listen to deployment lifecycle events and send interactions to the conversation from your page, with plain DOM APIs or the TavusIntegration helper.
- [Embed Conversational Video Interface](https://docs.tavus.io/sections/integrations/embedding-cvi.md): Learn how to embed Tavus's Conversational Video Interface (CVI) into your site or app.
- [Customize Conversation UI](https://docs.tavus.io/sections/conversational-video-interface/quickstart/customize-conversation-ui.md): Experience a conversation in a custom Daily UI - styled to match your preference.
- [Overview](https://docs.tavus.io/sections/conversational-video-interface/component-library/overview.md): Learn how our Tavus Conversational Video Interface (CVI) Component Library can help you go live in minutes.
- [Blocks](https://docs.tavus.io/sections/conversational-video-interface/component-library/blocks.md): High-level component compositions that combine multiple UI elements into complete interface layouts
- [Components](https://docs.tavus.io/sections/conversational-video-interface/component-library/components.md): Learn about our pre-built React components to accelerate integrating the Tavus Conversational Video Interface (CVI) into your application.
- [Hooks](https://docs.tavus.io/sections/conversational-video-interface/component-library/hooks.md): See what hooks Tavus supports for managing video calls, media controls, participant management, and conversation events.
- [Server](https://docs.tavus.io/sections/conversational-video-interface/component-library/server.md): Server-side helpers for managing Tavus conversation lifecycle without leaking your API key to the browser.
- [Mobile](https://docs.tavus.io/sections/conversational-video-interface/mobile.md): Ship Tavus CVI on iOS, Android, React Native, and mobile web using Daily's mobile SDKs and the same conversation URLs as web.
- [Google Meet / Zoom / Teams](https://docs.tavus.io/sections/conversational-video-interface/pal/meetings.md): Give a PAL its own meeting identity so it can be invited to Google Meet, Zoom, or Microsoft Teams calls over a calendar invite and join automatically - including meetings that are already in progress.
- [LiveKit Agent](https://docs.tavus.io/sections/integrations/livekit.md): Integrate a Tavus Face into LiveKit as the conversational video avatar.
- [Pipecat](https://docs.tavus.io/sections/integrations/pipecat.md): Integrate a Tavus Face into your Pipecat application as a participant or a video feed for the bot.
- [Webhooks and Callbacks](https://docs.tavus.io/sections/webhooks-and-callbacks.md): Set up a webhook server to generate a callback URL that receives event notifications from Tavus API.
- [Errors and Status Details](https://docs.tavus.io/sections/errors-and-status-details.md): Identify errors and status details encountered when using the PAL Maker.
- [Troubleshooting](https://docs.tavus.io/sections/troubleshooting.md): Find solutions to common problems and get back on track quickly with our troubleshooting guides.
- [FAQs](https://docs.tavus.io/sections/conversational-video-interface/faq.md): Frequently asked questions about Tavus's Conversational Video Interface.
- [Teams](https://docs.tavus.io/sections/teams/overview.md): Share billing across individual Tavus accounts, with roles that control who can manage members, billing, API keys, and single sign-on.
- [Single Sign-On (SSO)](https://docs.tavus.io/sections/teams/sso.md): Let your team sign in to Tavus through your own identity provider over SAML or OIDC.
- [Example Projects](https://docs.tavus.io/sections/example-projects.md)
- [Overview](https://docs.tavus.io/api-reference/overview.md): Discover the Tavus API - build a real-time, human-like multimodal video conversation with a face.
- [Authentication](https://docs.tavus.io/api-reference/authentication.md): Generate an API key in the PAL Maker and send it on each request in the `x-api-key` header.
- [Create conversation](https://docs.tavus.io/api-reference/conversations/create-conversation.md): This endpoint starts a real-time video conversation with your AI face, powered by a PAL that allows it to see, hear, and respond like a human.
- [Get Conversation](https://docs.tavus.io/api-reference/conversations/get-conversation.md): This endpoint returns a single conversation by its unique identifier.
- [List Conversations](https://docs.tavus.io/api-reference/conversations/get-conversations.md): This endpoint returns a list of all Conversations created by the account associated with the API Key in use.
- [End Conversation](https://docs.tavus.io/api-reference/conversations/end-conversation.md): This endpoint ends a single conversation by its unique identifier. Use this for routine call cleanup when a user leaves or your app no longer needs the room. To destructively remove conversation data, use [Delete Conversation](/api-reference/conversations/delete-conversation).
- [Delete Conversation](https://docs.tavus.io/api-reference/conversations/delete-conversation.md): This endpoint deletes a single conversation by its unique identifier. Use this for destructive data removal. For normal call cleanup when a user leaves or a session is finished, use [End Conversation](/api-reference/conversations/end-conversation) instead.
- [Create PAL](https://docs.tavus.io/api-reference/pals/create-pal.md): Creates a PAL and configures how it behaves in CVI for every conversation that uses that PAL.
- [Get PAL](https://docs.tavus.io/api-reference/pals/get-pal.md): Returns a single PAL by its unique identifier.
- [List PALs](https://docs.tavus.io/api-reference/pals/list-pals.md): This endpoint returns a list of all PALs created by the account associated with the API Key in use.
- [Patch PAL](https://docs.tavus.io/api-reference/pals/patch-pal.md): Update specific fields of a PAL using [JSON Patch](https://datatracker.ietf.org/doc/html/rfc6902) operations.
- [Publish PAL](https://docs.tavus.io/api-reference/pals/publish-pal.md): This endpoint has been removed. PALs no longer have a separate published version.
- [Delete PAL](https://docs.tavus.io/api-reference/pals/delete-pal.md): This endpoint deletes a single PAL by its unique identifier.
- [Check Conferencing Username Availability](https://docs.tavus.io/api-reference/pals/check-conferencing-username.md): Check whether a conferencing `username` is available on `tavusinvite.com` before creating or patching a PAL.
- [Create Face](https://docs.tavus.io/api-reference/faces/create-face.md): Creates a new face from training video or image URL for use in conversations. See [Choose a Model and Training Path](/sections/faces/which-training-path) for model and footage requirements and [Face overview](/sections/faces/overview#platform-policies) for rights and permissions.
- [Get Face](https://docs.tavus.io/api-reference/faces/get-face.md): This endpoint returns a single Face by its unique identifier.
- [List Faces](https://docs.tavus.io/api-reference/faces/list-faces.md): Returns all faces (realistic or stylized human likenesses trained with Phoenix) created by the account associated with the API key.
- [Update Face](https://docs.tavus.io/api-reference/faces/update-face.md): JSON Merge Patch on the face. Send `face_name`, `default_voice_id`, or both.
- [Delete Face](https://docs.tavus.io/api-reference/faces/delete-face.md): Deletes a Face by its unique ID; deleted faces cannot be used in a conversation.
- [Create Voice](https://docs.tavus.io/api-reference/voices/create-voice.md): Creates a voice from a sample of audio and returns immediately with `status: "started"`.
- [Get Voice](https://docs.tavus.io/api-reference/voices/get-voice.md): Returns a single voice and its current status.
- [List Voices](https://docs.tavus.io/api-reference/voices/list-voices.md): Lists your [Voice](/sections/conversational-video-interface/voices) resources.
- [Update Voice](https://docs.tavus.io/api-reference/voices/update-voice.md): Renames, re-describes, or re-tags a voice. Send at least one field. `description: null` clears it; `voice_name` and `tags` have no meaningful empty state, so null is rejected for those.
- [Delete Voice](https://docs.tavus.io/api-reference/voices/delete-voice.md): Deletes a voice.
- [Create Tool](https://docs.tavus.io/api-reference/tools/create-tool.md): Create a standalone tool that can be attached to one or more PALs via [Attach Tools To PAL](/api-reference/pal-tools/attach-tools-to-pal).
- [Get Tools](https://docs.tavus.io/api-reference/tools/get-tools.md): Returns a paginated list of tools. The `type` query parameter controls which tools are returned:
- [Get Tool](https://docs.tavus.io/api-reference/tools/get-tool.md): Returns a single tool by its `tool_id`. Works for both user-owned tools and built-in system tools. Secret fields (`token`, `password`, `value`, `secret`, `client_secret`) are replaced with `********` in the response.
- [Update Tool](https://docs.tavus.io/api-reference/tools/update-tool.md): Update one or more fields on a tool. Only fields present in the body are changed; omitted fields keep their stored value. System tools cannot be updated.
- [Delete Tool](https://docs.tavus.io/api-reference/tools/delete-tool.md): Soft-deletes a tool and detaches it from every PAL it was attached to. The tool name is freed for reuse on a new tool. System tools cannot be deleted.
- [Attach Tools To PAL](https://docs.tavus.io/api-reference/pal-tools/attach-tools-to-pal.md): Attach one or more tools (by `tool_id`) to a PAL. A PAL can have at most 50 attached tools.
- [List PAL Tools](https://docs.tavus.io/api-reference/pal-tools/list-pal-tools.md): List all standalone tools currently attached to a PAL. Inline tools defined under `PAL.layers.llm.tools` and built-in system tools are not returned here - only tools created via [Create Tool](/api-reference/tools/create-tool) and attached to this PAL.
- [Detach Tool From PAL](https://docs.tavus.io/api-reference/pal-tools/detach-tool-from-pal.md): Detach a tool from a PAL. The tool itself is not deleted - it remains available to attach to other PALs.
- [Create Connector](https://docs.tavus.io/api-reference/connectors/create-connector.md): Register an MCP server. What happens next depends on `auth_config.type`.
- [List Connectors](https://docs.tavus.io/api-reference/connectors/list-connectors.md): Every connector you own, newest first. Deleted connectors are omitted.
- [Get Connector](https://docs.tavus.io/api-reference/connectors/get-connector.md): Returns a single connector. Secrets are omitted; check `oauth_status` to see whether an OAuth connector is usable.
- [Update Connector](https://docs.tavus.io/api-reference/connectors/update-connector.md): Update the name, endpoint, or auth of a connector. Only the fields you send change.
- [Delete Connector](https://docs.tavus.io/api-reference/connectors/delete-connector.md): Soft-deletes the connector. Any PAL referencing it in `layers.mcp.connectors` simply skips it from then on.
- [Preview Connector Tools](https://docs.tavus.io/api-reference/connectors/preview-connector-tools.md): The tools the server currently exposes, without importing anything. Use it to show a picker before scoping a PAL down with `layers.mcp.connector_tools`.
- [Reconnect OAuth](https://docs.tavus.io/api-reference/connectors/reconnect-connector-oauth.md): Issue a fresh authorize URL for an OAuth connector. Use it when `oauth_status` is `needs_reauth` - the refresh token stopped working, usually because the customer revoked access - or any time you want the customer to re-authorize.
- [List Skills](https://docs.tavus.io/api-reference/skills/list-skills.md): List every skill in the registry. Skills are pre-built capabilities authored by Tavus that you can attach to a PAL - see [Skills](/sections/conversational-video-interface/skills/overview).
- [Get Skill](https://docs.tavus.io/api-reference/skills/get-skill.md): Retrieve the metadata for a single skill in the registry.
- [List PAL Skills](https://docs.tavus.io/api-reference/pal-skills/list-pal-skills.md): List the skills attached to a PAL. The response is an object keyed by `skill_id`.
- [Get PAL Skill](https://docs.tavus.io/api-reference/pal-skills/get-pal-skill.md): Retrieve a single skill attachment on a PAL.
- [Attach Skill to PAL](https://docs.tavus.io/api-reference/pal-skills/attach-skill-to-pal.md): Attach a skill to a PAL, or overwrite the configuration of an existing attachment. The skill is active on the PAL's next conversation.
- [Update PAL Skill](https://docs.tavus.io/api-reference/pal-skills/update-pal-skill.md): Merge changes into an existing skill attachment's configuration. Fields you pass replace the existing values, fields you omit are preserved, and fields set to `null` are removed. The merged configuration is validated against the skill's config schema.
- [Detach Skill from PAL](https://docs.tavus.io/api-reference/pal-skills/detach-skill-from-pal.md): Detach a skill from a PAL. The skill no longer applies to the PAL's future conversations. The skill itself stays in the registry and can be re-attached at any time.
- [Replace PAL Skills](https://docs.tavus.io/api-reference/pal-skills/replace-pal-skills.md): Replace a PAL's entire skill set in one call. Skills not present in the request are detached.
- [Create Memory Store](https://docs.tavus.io/api-reference/memory-stores/create-memory-store.md): Creates a persistent memory store for one PAL and participant. This is useful when you need to add pinned memories before the participant's first conversation. Otherwise, passing one tag in `participant_tags` to Create Conversation creates the store automatically.
- [List Memory Stores](https://docs.tavus.io/api-reference/memory-stores/list-memory-stores.md): Lists memory stores owned by the caller. Filter by `pal_id`, `participant_tag`, or both. The returned `memory_store_id` is the resource identifier for reading, editing, or deleting the store; conversation creation uses `participant_tags` instead.
- [Get Memory Store](https://docs.tavus.io/api-reference/memory-stores/get-memory-store.md): Returns the pinned and learned memory for one store.
- [Delete Memory Store](https://docs.tavus.io/api-reference/memory-stores/delete-memory-store.md): Deletes a memory store so it can no longer be retrieved or used by future conversations.
- [Create Pinned Memory](https://docs.tavus.io/api-reference/memory-stores/create-pinned-memory.md): Adds a static fact to a memory store. The fact remains unchanged until you update or delete it. Each store supports up to 30 pinned facts, with up to 500 characters per fact.
- [List Pinned Memories](https://docs.tavus.io/api-reference/memory-stores/list-pinned-memories.md): Lists the pinned facts in a memory store.
- [Update Pinned Memory](https://docs.tavus.io/api-reference/memory-stores/update-pinned-memory.md): Replaces the text of one pinned memory.
- [Delete Pinned Memory](https://docs.tavus.io/api-reference/memory-stores/delete-pinned-memory.md): Deletes one pinned memory from a store.
- [Get Learned Memory](https://docs.tavus.io/api-reference/memory-stores/get-learned-memory.md): Returns the learned participant profile, timeline, or both.
- [Delete Learned Profile Memory](https://docs.tavus.io/api-reference/memory-stores/delete-learned-profile-memory.md): Deletes one path from the learned participant profile.
- [Delete Learned Timeline Memory](https://docs.tavus.io/api-reference/memory-stores/delete-learned-timeline-memory.md): Deletes one timeline entry. Provide exactly one of `timestamp`, `date`, `week`, or `month`.
- [Record Canvas Interaction](https://docs.tavus.io/api-reference/canvas-interactions/record-canvas-interaction.md): Record a Magic Canvas interaction (submit, skip, dismiss, clear, error, or heartbeat) while a conversation is **active**.
- [List Canvas Interactions](https://docs.tavus.io/api-reference/canvas-interactions/list-canvas-interactions.md): Returns every Canvas interaction recorded for a conversation, oldest first. Uses the same field shape as the `canvas.interaction` webhook's `properties` object.
- [Create Objectives](https://docs.tavus.io/api-reference/objectives/create-objectives.md): This endpoint creates objectives for a PAL.
- [Get Objective](https://docs.tavus.io/api-reference/objectives/get-objectives.md): This endpoint returns a single objective by its unique identifier.
- [Get Objectives](https://docs.tavus.io/api-reference/objectives/get-objectives-list.md): This endpoint returns a list of all objectives.
- [Patch Objective](https://docs.tavus.io/api-reference/objectives/patch-objectives.md): This endpoint allows you to update specific fields of an objective using JSON Patch operations.
- [Delete Objective](https://docs.tavus.io/api-reference/objectives/delete-objectives.md): This endpoint deletes a single objective by its unique identifier.
- [Create Guardrails](https://docs.tavus.io/api-reference/guardrails/create-guardrails.md): Create a new guardrail. Guardrails provide strict behavioral boundaries that are enforced throughout a conversation.
- [Get Guardrails](https://docs.tavus.io/api-reference/guardrails/get-guardrails.md): Retrieve a single guardrail by its unique identifier.
- [List Guardrails](https://docs.tavus.io/api-reference/guardrails/list-guardrails.md): Return a flat list of guardrails owned by the caller. Pass `legacy=false` - recommended for all new integrations. The `legacy=true` behavior returns the deprecated guardrail set list.
- [Patch Guardrails](https://docs.tavus.io/api-reference/guardrails/patch-guardrails.md): Update specific fields of a guardrail using [JSON Patch](https://jsonpatch.com/) operations. Paths must match the **current** document shape - compare against the response from [Get Guardrails](/api-reference/guardrails/get-guardrails) before patching.
- [Delete Guardrails](https://docs.tavus.io/api-reference/guardrails/delete-guardrails.md): Delete a single guardrail by its unique identifier. PALs with this guardrail attached via `guardrail_ids` will have the reference removed automatically.
- [Create Document](https://docs.tavus.io/api-reference/documents/create-document.md): Upload documents to your knowledge base for PALs to reference during conversations.
- [Get Document](https://docs.tavus.io/api-reference/documents/get-document.md): Retrieve detailed information about a specific document using its unique identifier.
- [List Documents](https://docs.tavus.io/api-reference/documents/get-documents.md): Retrieve a list of documents.
- [Delete Document](https://docs.tavus.io/api-reference/documents/delete-document.md): Delete a document and its associated data using its unique identifier.
- [Update Document](https://docs.tavus.io/api-reference/documents/patch-document.md): Update a document's `document_name` and `tags`.
- [Recrawl Document](https://docs.tavus.io/api-reference/documents/recrawl-document.md): Trigger a recrawl of a website document to fetch fresh content.
- [Create Pronunciation Dictionary](https://docs.tavus.io/api-reference/pronunciation-dictionaries/create-pronunciation-dictionary.md): Create a [pronunciation dictionary](/sections/conversational-video-interface/pal/pronunciation-dictionaries) with custom rules for controlling how words are spoken. Rules are automatically synced to both Cartesia and ElevenLabs so they work regardless of which TTS engine your PAL uses.
- [Get Pronunciation Dictionary](https://docs.tavus.io/api-reference/pronunciation-dictionaries/get-pronunciation-dictionary.md): Retrieve a pronunciation dictionary by its ID, including all rules.
- [List Pronunciation Dictionaries](https://docs.tavus.io/api-reference/pronunciation-dictionaries/list-pronunciation-dictionaries.md): List all pronunciation dictionaries for the authenticated user with pagination.
- [Update Pronunciation Dictionary](https://docs.tavus.io/api-reference/pronunciation-dictionaries/update-pronunciation-dictionary.md): Update a pronunciation dictionary's name or rules using [JSON Patch](https://jsonpatch.com/) format (RFC 6902). Supported mutable fields are `name` and `rules`.
- [Delete Pronunciation Dictionary](https://docs.tavus.io/api-reference/pronunciation-dictionaries/delete-pronunciation-dictionary.md): Permanently delete a pronunciation dictionary and remove it from all linked PALs.
- [Create Deployment](https://docs.tavus.io/api-reference/deployments/create-deployment.md): Create a managed deployment for the widget, embed, or landing-page channel.
- [List Deployments](https://docs.tavus.io/api-reference/deployments/list-deployments.md): List deployments owned by the authenticated user.
- [Get Deployment](https://docs.tavus.io/api-reference/deployments/get-deployment.md)
- [Patch Deployment](https://docs.tavus.io/api-reference/deployments/patch-deployment.md): Apply a [JSON Patch](https://jsonpatch.com/) array to the deployment document.
- [Delete Deployment](https://docs.tavus.io/api-reference/deployments/delete-deployment.md)
- [Get Deployment Init Config](https://docs.tavus.io/api-reference/deployments/get-deployment-init.md): Public endpoint called when a widget or embed mounts. Returns customization, limits, captcha settings, and availability.
- [Start Deployment Conversation](https://docs.tavus.io/api-reference/deployments/start-deployment-conversation.md): Creates a conversation for a deployment. Returns the same fields as [Create Conversation](/api-reference/conversations/create-conversation).
- [End Deployment Conversation](https://docs.tavus.io/api-reference/deployments/end-deployment-conversation.md): Ends an active conversation started through a deployment. No API key required in the browser.
- [Changelog](https://docs.tavus.io/sections/changelog/changelog.md)
- [Overview](https://docs.tavus.io/sections/video/overview.md): Generate high-quality async videos from a script and a face - separate from real-time CVI.
- [Quickstart](https://docs.tavus.io/sections/video/quickstart.md): Async Video API walkthrough - render a file from script or audio with a face; not real-time CVI.
- [Background Customizations](https://docs.tavus.io/sections/video/background-customizations.md): Customize AI video backgrounds with transparency, scrolling websites, or custom video sources.
- [Generate Video](https://docs.tavus.io/api-reference/video-request/create-video.md): This endpoint generates a new video using a face and either a script or an audio file.
- [Get Video](https://docs.tavus.io/api-reference/video-request/get-video.md): This endpoint returns a single video by its unique identifier.
- [List Videos](https://docs.tavus.io/api-reference/video-request/get-videos.md): This endpoint returns a list of all Videos created by the account associated with the API Key in use.
- [Delete Video](https://docs.tavus.io/api-reference/video-request/delete-video.md): This endpoint deletes a single video by its unique identifier.
- [Rename Video](https://docs.tavus.io/api-reference/video-request/patch-video-name.md): This endpoint renames a single video by its unique identifier.

## OpenAPI Specs

- [openapi](/openapi.yaml)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.