> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tavus.io/llms.txt
> Use this file to discover all available pages before exploring further.
# Pipecat
> Integrate a Tavus Replica into your Pipecat application as a participant or a video feed for the bot.
We recommend using Tavus’s Full Pipeline in its entirety for the lowest latency and most optimized multimodal experience. Integrations like LiveKit Agent or Pipecat only provide rendering, while our Full Pipeline includes perception, turn-taking, and rendering for complete conversational intelligence.
Tavus offers integration with Pipecat, an open-source framework for building multimodal conversational agents by Daily. You can integrate Tavus into your Pipecat application in two ways:
* Additional Tavus Participant (`TavusTransport`)
* The Tavus agent joins as a third participant alongside the Pipecat bot and human user. It receives audio from the Pipecat pipeline’s TTS layer and renders synchronized video and audio.
* Video Layer for Pipecat Bot (`TavusVideoService`)
* Only the Pipecat bot is present in the room. `TavusVideoService` acts as a pipeline layer, sending TTS audio to Tavus in the background. Tavus returns video and audio streams for the bot to display. No additional participant is added.
## Prerequisites
Before integrating Tavus with Pipecat, ensure you have the following:
* **Tavus API Key**
* **Tavus `replica_id`**
* You can use one of Tavus's stock replicas or your own custom replica.
* **Pipecat Python Application**
* Either your own existing application, or use Pipecat’s examples:
* `TavusTransport`
* `TavusVideoService`
## `TavusTransport`
`TavusTransport` connects your Pipecat app to a Tavus conversation, allowing the bot to join the same virtual room as the Tavus avatar and participants. To get started, you can follow the following steps or learn more from this sample code.
### Integration Guide for `TavusTransport`
1. Install the Tavus plugin for Pipecat.
```sh theme={null}
pip install pipecat-ai[tavus]
```
2. In the `.env` file of your pipecat application (at `/path/to/pipecat/.env`) add:
```env theme={null}
TAVUS_API_KEY=
TAVUS_REPLICA_ID=
```
* Replace `` with your actual API key. You can generate one in the Developer Portal.
* Replace `` with the Replica ID you want to use.
Create an instance of `TavusTransport` by providing your bot name, Tavus API key, Replica ID, session, and additional parameters.
```py {6, 16-27} theme={null}
import os
import aiohttp
from dotenv import load_dotenv
from loguru import logger
from pipecat.audio.vad.silero import SileroVADAnalyzer
from pipecat.transports.services.tavus import TavusParams, TavusTransport
# Other imports...
load_dotenv(override=True)
logger.remove(0)
logger.add(sys.stderr, level="DEBUG")
async def main():
async with aiohttp.ClientSession() as session:
transport = TavusTransport(
bot_name="Pipecat bot",
api_key=os.getenv("TAVUS_API_KEY"),
replica_id=os.getenv("TAVUS_REPLICA_ID"),
session=session,
params=TavusParams(
audio_in_enabled=True,
audio_out_enabled=True,
microphone_out_enabled=False,
vad_analyzer=SileroVADAnalyzer(),
),
)
# stt, tts, llm...
```
See Pipecat API Reference for the configuration details.
Add the Tavus transport layer to your processing pipeline.
```py {5, 10} theme={null}
# stt, tts, llm...
pipeline = Pipeline(
[
transport.input(), # Transport user input
stt, # STT
context_aggregator.user(), # User responses
llm, # LLM
tts, # TTS
transport.output(), # Transport bot output
context_aggregator.assistant(), # Assistant spoken responses
]
)
```
1. Run the following command to execute the program:
```sh theme={null}
python .py
```
Replace the `` with your actual Python filename.
2. Use the **Tavus Daily URL** provided in the console to interact with the agent.
## `TavusVideoService`
You can use `TavusVideoService` to enable real-time AI-driven video interactions in your Pipecat app. To get started, you can follow the following steps or refer from this sample code.
### Integration Guide for `TavusVideoService`
1. Install the Tavus plugin for Pipecat.
```sh theme={null}
pip install pipecat-ai[tavus]
```
2. In the `.env` file of your pipecat application (at `/path/to/pipecat/.env`) add:
```env theme={null}
TAVUS_API_KEY=
TAVUS_REPLICA_ID=
```
* Replace `` with your actual API key. You can generate one in the Developer Portal.
* Replace `` with the Replica ID you want to use.
Create an instance of `TavusVideoService` by providing your Tavus API key and Tavus Replica ID.
```py {6, 15-19} theme={null}
import argparse
import os
import aiohttp
from dotenv import load_dotenv
from loguru import logger
from pipecat.services.tavus.video import TavusVideoService
from pipecat.transports.base_transport import BaseTransport
# Other imports...
load_dotenv(override=True)
async def run_example(transport: BaseTransport, _: argparse.Namespace, handle_sigint: bool):
logger.info(f"Starting bot")
async with aiohttp.ClientSession() as session:
tavus = TavusVideoService(
api_key=os.getenv("TAVUS_API_KEY"),
replica_id=os.getenv("TAVUS_REPLICA_ID"),
session=session,
)
# stt, tts, llm...
```
See Pipecat Tavus Service for the configuration details.
Insert the `TavusVideoService` into the pipeline by adding the `tavus` service after the TTS processor in the pipeline.
```py {10} theme={null}
# stt, tts, llm...
pipeline = Pipeline(
[
transport.input(), # Transport user input
stt, # STT
context_aggregator.user(), # User responses
llm, # LLM
tts, # TTS
tavus, # Tavus output layer
transport.output(), # Transport bot output
context_aggregator.assistant(), # Assistant spoken responses
]
)
```
1. Run the following command to execute the program:
```sh theme={null}
python .py
```
Replace the `` with your actual Python filename.
2. Use the **localhost URL** provided in the console to interact with the agent.
Built with [Mintlify](https://mintlify.com).