Skip to content

Latest commit

 

History

History
83 lines (55 loc) · 3.56 KB

File metadata and controls

83 lines (55 loc) · 3.56 KB
LiveKit logo

LiveKit Agents Starter - Python

A complete starter project for building voice AI apps with LiveKit Agents for Python.

The starter project includes:

This starter app is compatible with SIP-based telephony or any custom web/mobile frontend.

Dev Setup

Clone the repository and install dependencies to a virtual environment:

cd agent-starter-python
uv sync

Set up the environment by copying .env.example to .env and filling in the required values:

You can load the LiveKit environment automatically using the LiveKit CLI:

lk app env -w .env

Run the agent

Run this command to speak to your agent directly in your terminal:

uv run python src/agent.py console

To run the agent for use with a frontend or telephony, use the dev command:

uv run python src/agent.py dev

In production, use the start command:

uv run python src/agent.py start

Web and mobile frontends

To use a prebuilt frontend or build your own, see the agents frontend guide.

Telephony

To add a phone number, see the agents telephony guide.

Tests and evals

This project includes a complete suite of evals, based on the LiveKit Agents testing & evaluation framework. To run them, use pytest.

uv run pytest evals

License

This project is licensed under the MIT License - see the LICENSE file for details.