Skip to content

Latest commit

 

History

History

examples

README.md

LiveKit Agents Examples

This directory contains various examples demonstrating different capabilities and use cases for LiveKit agents. Each example showcases specific features, integrations, or workflows that can be built with the LiveKit Agents framework.

Model Configuration

Most examples use LiveKit Inference by default for STT, LLM, and TTS models. This provides a unified API for accessing multiple model providers through LiveKit Cloud.

from livekit.agents import inference

session = AgentSession(
    stt=inference.STT("deepgram/nova-3"),
    llm=inference.LLM("openai/gpt-4.1-mini"),
    tts=inference.TTS("cartesia/sonic-3"),
)

Note: Realtime models (e.g., openai.realtime.RealtimeModel) are not supported by LiveKit Inference and must use the plugin directly. See the Real-time Models examples in voice_agents/.

📁 Example Categories

🎙️ Voice Agents

A comprehensive collection of voice-based agent examples, including basic voice interactions, tool integrations, RAG implementations, and advanced features like multi-agent workflows and push-to-talk agents.

🖼️ Avatar Agents

Examples showing how to integrate visual avatars with voice agents, including integrations with various avatar providers like Anam, Avatario, Bey, BitHuman, Hedra, Simli, and Tavus.

🔄 Warm Transfer

Demonstrates supervisor escalation workflows for call centers, showing how to implement warm transfers where agents can brief supervisors before connecting them to customers.

🚗 Drive-Thru

A complete drive-thru ordering system example that showcases interactive voice agents for food ordering with database integration and order management.

🏢 Front Desk

A front desk agent example demonstrating how to build customer service agents with calendar integration and appointment management capabilities.

🔧 Primitives

Basic building blocks and fundamental examples showing core LiveKit concepts like room connections, participant management, and basic audio/video handling.

🛠️ Other

Additional examples including text-only agents, various TTS providers, transcription services, and translation utilities.

Running Examples

To run the examples, you'll need:

Environment file

Create a .env file in the examples directory and add your API keys (see examples/.env.example):

LIVEKIT_URL="wss://your-project.livekit.cloud"
LIVEKIT_API_KEY="your_api_key"
LIVEKIT_API_SECRET="your_api_secret"

When using LiveKit Inference (default for most examples), your LiveKit API key/secret is used for authentication. For examples that use provider plugins directly (e.g., realtime models), you'll also need the provider-specific API keys:

OPENAI_API_KEY="sk-xxx"  # For realtime models and provider-specific features
# ... other model provider API keys as needed

Install dependencies

From the repository root, run the following command:

uv sync --all-extras --dev

Running an individual example

Run an example agent:

uv run examples/voice_agents/basic_agent.py console

Your agent is now running in the console.

For frontend support, use the Agents playground or the starter apps.

📖 Additional Resources