# Tavus

## Docs

- [Authentication](https://docs.tavus.io/api-reference/authentication.md): Learn how to generate and use your Tavus API key to authenticate requests.
- [Create Conversation](https://docs.tavus.io/api-reference/conversations/create-conversation.md): This endpoint starts a real-time video conversation with your AI replica, powered by a persona that allows it to see, hear, and respond like a human.
- [Delete Conversation](https://docs.tavus.io/api-reference/conversations/delete-conversation.md): This endpoint deletes a single conversation by its unique identifier.
- [End Conversation](https://docs.tavus.io/api-reference/conversations/end-conversation.md): This endpoint ends a single conversation by its unique identifier.
- [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.
- [Create Document](https://docs.tavus.io/api-reference/documents/create-document.md): Upload documents to your knowledge base for personas to reference during conversations
- [Delete Document](https://docs.tavus.io/api-reference/documents/delete-document.md): Delete a specific document
- [Get Document](https://docs.tavus.io/api-reference/documents/get-document.md): Retrieve a specific document by ID
- [List Documents](https://docs.tavus.io/api-reference/documents/get-documents.md): Retrieve a list of documents with optional filtering and pagination
- [Update Document](https://docs.tavus.io/api-reference/documents/patch-document.md): Update a specific document's metadata
- [Recrawl Document](https://docs.tavus.io/api-reference/documents/recrawl-document.md): Trigger a recrawl of a website document to fetch fresh content
- [Create Guardrails](https://docs.tavus.io/api-reference/guardrails/create-guardrails.md): This endpoint creates a new set of guardrails for a persona. Guardrails provide strict behavioral boundaries and guidelines that will be rigorously followed throughout conversations.
- [Delete Guardrails](https://docs.tavus.io/api-reference/guardrails/delete-guardrails.md): This endpoint deletes a single set of guardrails by its unique identifier.
- [Get Guardrails (One Set)](https://docs.tavus.io/api-reference/guardrails/get-guardrails.md): This endpoint returns a single set of guardrails by its unique identifier.
- [Get Guardrails (All Sets)](https://docs.tavus.io/api-reference/guardrails/get-guardrails-list.md): This endpoint returns a list of all sets of guardrails.
- [Patch Guardrails](https://docs.tavus.io/api-reference/guardrails/patch-guardrails.md): This endpoint allows you to update specific fields of guardrails using JSON Patch operations.
- [Create Objectives](https://docs.tavus.io/api-reference/objectives/create-objectives.md): This endpoint creates a new objective for a persona. Objectives provide goal-oriented instructions that help guide conversations toward specific achievements and desired outcomes.
- [Delete Objective](https://docs.tavus.io/api-reference/objectives/delete-objectives.md): This endpoint deletes a single objective by its unique identifier.
- [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.
- [Overview](https://docs.tavus.io/api-reference/overview.md): Discover the Tavus API — build a real-time, human-like multimodal video conversation with a replica.
- [Create Persona](https://docs.tavus.io/api-reference/personas/create-persona.md): This endpoint creates and customizes a digital replica's behavior and capabilities for Conversational Video Interface (CVI).
- [Delete Persona](https://docs.tavus.io/api-reference/personas/delete-persona.md): This endpoint deletes a single persona by its unique identifier.
- [Get Persona](https://docs.tavus.io/api-reference/personas/get-persona.md): This endpoint returns a single persona by its unique identifier.
- [List Personas](https://docs.tavus.io/api-reference/personas/get-personas.md): This endpoint returns a list of all Personas created by the account associated with the API Key in use.
- [Patch Persona](https://docs.tavus.io/api-reference/personas/patch-persona.md): This endpoint updates a persona using a JSON Patch payload (RFC 6902). You can modify **any field within the persona** using supported operations like `add`, `remove`, `replace`, `copy`, `move`, and `test`.
- [Create Replica](https://docs.tavus.io/api-reference/phoenix-replica-model/create-replica.md): This endpoint creates a new replica using the latest `phoenix-4` model, which can be used in real-time conversations.
- [Delete Replica](https://docs.tavus.io/api-reference/phoenix-replica-model/delete-replica.md): This endpoint deletes a Replica by its unique ID. Deleted Replicas cannot be used in a conversation.
- [Get Replica](https://docs.tavus.io/api-reference/phoenix-replica-model/get-replica.md): This endpoint returns a single Replica by its unique identifier.
- [List Replicas](https://docs.tavus.io/api-reference/phoenix-replica-model/get-replicas.md): This endpoint returns a list of all Replicas created by the account associated with the API Key in use. In the response, a root level `data` key will contain the list of Replicas.
- [Rename Replica](https://docs.tavus.io/api-reference/phoenix-replica-model/patch-replica-name.md): This endpoint renames a single Replica by its unique identifier.
- [Generate Video](https://docs.tavus.io/api-reference/video-request/create-video.md): This endpoint generates a new video using a Replica and either a script or an audio file.
- [Delete Video](https://docs.tavus.io/api-reference/video-request/delete-video.md): This endpoint deletes a single video by its unique identifier.
- [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.
- [Rename Video](https://docs.tavus.io/api-reference/video-request/patch-video-name.md): This endpoint renames a single video by its unique identifier.
- [Changelog](https://docs.tavus.io/sections/changelog/changelog.md)
- [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.
- [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.
- [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.
- [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.
- [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.
- [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.
- [Private Rooms](https://docs.tavus.io/sections/conversational-video-interface/conversation/customizations/private-rooms.md): Create authenticated conversations with meeting tokens for enhanced security.
- [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.
- [Customer Support](https://docs.tavus.io/sections/conversational-video-interface/conversation/usecases/customer-support.md): Engage in real-time customer support and sales conversations with the Customer Support persona (Gloria).
- [Interviewer](https://docs.tavus.io/sections/conversational-video-interface/conversation/usecases/interviewer.md): Engage with the Interviewer persona to run structured, conversational screening interviews.
- [Sales Coach](https://docs.tavus.io/sections/conversational-video-interface/conversation/usecases/sales-coach.md): Engage with the Sales Coach persona to simulate real-time sales conversations.
- [Sales Development Rep](https://docs.tavus.io/sections/conversational-video-interface/conversation/usecases/sales-development-rep.md): Engage with Anna, the Tavus sales development rep persona.
- [FAQs](https://docs.tavus.io/sections/conversational-video-interface/faq.md): Frequently asked questions about Tavus's Conversational Video Interface.
- [Interactions Protocol](https://docs.tavus.io/sections/conversational-video-interface/interactions-protocols/overview.md): Control conversations with a Replica using the defined protocol by sending and listening to interaction events.
- [Knowledge Base](https://docs.tavus.io/sections/conversational-video-interface/knowledge-base.md): Upload documents to your knowledge base for personas to reference during conversations.
- [Language Support](https://docs.tavus.io/sections/conversational-video-interface/language-support.md): Customize the conversation language using full language names supported by Tavus TTS engines.
- [Memories](https://docs.tavus.io/sections/conversational-video-interface/memories.md): Memories let personas remember information across conversations, allowing participants to have personalized, flowing conversations across multiple sessions.
- [Overview](https://docs.tavus.io/sections/conversational-video-interface/overview-cvi.md): CVI enables real-time, human-like video interactions through configurable lifelike replicas.
- [Conversational Flow](https://docs.tavus.io/sections/conversational-video-interface/persona/conversational-flow.md): Learn how to configure the Conversational Flow layer to fine-tune turn-taking and interruption handling behavior.
- [Guardrails](https://docs.tavus.io/sections/conversational-video-interface/persona/guardrails.md): Guardrails provide your persona with strict behavioral guidelines that will be rigorously followed throughout every conversation.
- [Large Language Model (LLM)](https://docs.tavus.io/sections/conversational-video-interface/persona/llm.md): Learn how to use Tavus-optimized LLMs or integrate your own custom LLM.
- [Tool Calling for LLM](https://docs.tavus.io/sections/conversational-video-interface/persona/llm-tool.md): Set up tool calling to trigger functions from user speech using Tavus-hosted or custom LLMs.
- [Objectives](https://docs.tavus.io/sections/conversational-video-interface/persona/objectives.md): Objectives are goal-oriented instructions to define the desired outcomes and flow of your conversations.
- [Overview](https://docs.tavus.io/sections/conversational-video-interface/persona/overview.md): Define how your persona behaves, responds, and speaks by configuring layers and modes.
- [Perception](https://docs.tavus.io/sections/conversational-video-interface/persona/perception.md): Learn how to configure the perception layer with Raven to enable real-time visual and audio understanding.
- [Tool Calling for Perception](https://docs.tavus.io/sections/conversational-video-interface/persona/perception-tool.md): Configure tool calling with Raven to trigger functions from visual or audio input.
- [Stock Personas](https://docs.tavus.io/sections/conversational-video-interface/persona/stock-personas.md): Tavus offers pre-built personas to help you get started quickly.
- [Speech-to-Text (STT)](https://docs.tavus.io/sections/conversational-video-interface/persona/stt.md): Learn how to configure the STT layer to enable smart turn detection and enhance conversational flow.
- [Text-to-Speech (TTS)](https://docs.tavus.io/sections/conversational-video-interface/persona/tts.md): Discover how to integrate custom voices from third-party TTS engines for multilingual or localized speech output.
- [Conversation Recordings](https://docs.tavus.io/sections/conversational-video-interface/quickstart/conversation-recordings.md): Enable conversation recording and store it in your S3 bucket for on-demand access.
- [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.
- [Emotion Control with Phoenix-4](https://docs.tavus.io/sections/conversational-video-interface/quickstart/emotional-expression.md): Unlock emotionally expressive facial movements and micro-expressions using Phoenix-4 replicas.
- [Use the Full Pipeline](https://docs.tavus.io/sections/conversational-video-interface/quickstart/use-the-full-pipeline.md): Create your first persona using the full pipeline and start a conversation in seconds.
- [Errors and Status Details](https://docs.tavus.io/sections/errors-and-status-details.md): Identify errors and status details encountered when using the Tavus platform.
- [Append Conversational Context Interaction](https://docs.tavus.io/sections/event-schemas/conversation-append-context.md): This is an event developers may broadcast to Tavus.
- [Echo Interaction](https://docs.tavus.io/sections/event-schemas/conversation-echo.md): This is an event developers may broadcast to Tavus.
- [Interrupt Interaction](https://docs.tavus.io/sections/event-schemas/conversation-interrupt.md): This is an event developers may broadcast to Tavus.
- [Overwrite Conversational Context Interaction](https://docs.tavus.io/sections/event-schemas/conversation-overwrite-context.md): This is an event developers may broadcast to Tavus.
- [Perception Analysis Event](https://docs.tavus.io/sections/event-schemas/conversation-perception-analysis.md): This is an event broadcasted by Tavus.
- [Perception Tool Call Event](https://docs.tavus.io/sections/event-schemas/conversation-perception-tool-call.md): This is an event broadcasted by Tavus.
- [Replica Interrupted Event](https://docs.tavus.io/sections/event-schemas/conversation-replica-interrupted.md): This is an event broadcasted by Tavus.
- [Replica Started/Stopped Speaking Event](https://docs.tavus.io/sections/event-schemas/conversation-replica-started-stopped-speaking.md): This is an event broadcasted by Tavus.
- [Text Respond Interaction](https://docs.tavus.io/sections/event-schemas/conversation-respond.md): This is an event developers may broadcast to Tavus.
- [Sensitivity Interaction](https://docs.tavus.io/sections/event-schemas/conversation-sensitivity.md): This is an event developers may broadcast to Tavus.
- [Tool Call Event](https://docs.tavus.io/sections/event-schemas/conversation-toolcall.md): This is an event broadcasted by Tavus.
- [User Started/Stopped Speaking Event](https://docs.tavus.io/sections/event-schemas/conversation-user-started-stopped-speaking.md): This is an event broadcasted by Tavus.
- [Utterance Event](https://docs.tavus.io/sections/event-schemas/conversation-utterance.md): This is an event broadcasted by Tavus.
- [Example Projects](https://docs.tavus.io/sections/example-projects.md)
- [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.
- [LiveKit Agent](https://docs.tavus.io/sections/integrations/livekit.md): Integrate a Tavus Replica into LiveKit as the conversational video avatar.
- [Pipecat](https://docs.tavus.io/sections/integrations/pipecat.md): Integrate a Tavus Replica into your Pipecat application as a participant or a video feed for the bot.
- [Introduction](https://docs.tavus.io/sections/introduction.md): Leverage Tavus tools and guides to give your AI Agent real-time human-like perception and presence, bringing the human layer to AI.
- [Models](https://docs.tavus.io/sections/models.md)
- [Overview](https://docs.tavus.io/sections/replica/overview.md): Learn about Personal, Non-Human and Stock Replicas, and how to create your own.
- [Quickstart](https://docs.tavus.io/sections/replica/quickstart.md): Create high-quality Personal or Non-human Replicas for use in conversations.
- [Replica Training](https://docs.tavus.io/sections/replica/replica-training.md): Guide to recording a high-quality training video for generating Phoenix-4 replicas.
- [Stock Replicas](https://docs.tavus.io/sections/replica/stock-replicas.md): Browse ready-to-use digital presenters from Tavus for fast, high quality video creation.
- [Troubleshooting](https://docs.tavus.io/sections/troubleshooting.md): Find solutions to common problems and get back on track quickly with our troubleshooting guides.
- [Background Customizations](https://docs.tavus.io/sections/video/background-customizations.md): Customize AI video backgrounds with transparency, scrolling websites, or custom video sources.
- [Overview](https://docs.tavus.io/sections/video/overview.md): Learn how to generate high-quality AI videos using Replicas.
- [Quickstart](https://docs.tavus.io/sections/video/quickstart.md): Learn how to quickly generate high-quality videos using your personalized replica.
- [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.

## OpenAPI Specs

- [openapi](https://docs.tavus.io/openapi.yml)


Built with [Mintlify](https://mintlify.com).