Tavus

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


**Core Components:**
- Replica - Choice of audio/visual appearance 
- Persona - Define the replica's behavior and capabilities


The response includes a `conversation_url` that you can use to join the call or embed it on your website. [Learn how to embed it here](/sections/integrations/embedding-cvi).

If you provide a `callback_url`, you’ll receive webhooks with updates about the conversation status. [Learn more about Callback here](/sections/webhooks-and-callbacks).

- [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
- [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.

**Note:** The `path` field is a JSON Pointer string that references a location within the target document where the operation is performed.

For example:

```json
[
  { "op": "replace", "path": "/data/0/guardrails_prompt", "value": "Your updated prompt"},
  { "op": "add", "path": "/data/0/callback_url", "value": "https://your-server.com/webhook" }
]
```

- [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.

**Note:** The `path` field is a JSON Pointer string that references a location within the target document where the operation is performed.

For example:

```json
[
  { "op": "replace", "path": "/data/0/objective_name", "value": "updated_objective_name" },
  { "op": "replace", "path": "/data/0/objective_prompt", "value": "Updated prompt for the objective" },
  { "op": "replace", "path": "/data/0/confirmation_mode", "value": "manual" },
  { "op": "add", "path": "/data/0/output_variables", "value": ["new_variable"] },
  { "op": "replace", "path": "/data/0/modality", "value": "visual" },
  { "op": "remove", "path": "/data/0/callback_url" }
]
```

- [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).

**Core Components:**
- Replica - Choice of audio/visual appearance 
- Context - Customizable contextual information, for use by LLM 
- System Prompt - Customizable system prompt, for use by LLM
- Layers
  - Perception - Multimodal vision and understanding settings (Raven)
  - STT - Transcription and turn taking settings (Sparrow)
  - LLM - Language model settings 
  - TTS - Text-to-Speech settings

- [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`.

For example: