README.md

LiveKit + OpenAI Realtime Playground

This project is an interactive playground that demonstrates the capabilities of OpenAI's Realtime API, allowing users to experiment with the API directly in their browser. It's built on top of LiveKit Agents.

See it in action at realtime-playground.livekit.io

Repository Structure

/agent

This directory contains the agent implementation in build on the LiveKit Python Agents framework.

/web

This directory houses the web frontend, built with Next.js.

Prerequisites

• Python 3.9 or higher
• pip (Python package installer)
• LiveKit Cloud or self-hosted LiveKit server

Getting Started

Agent Setup

1. Navigate to the /agent directory
2. Copy the sample environment file: cp .env.sample .env
3. Open .env in a text editor and enter your LiveKit credentials
4. Create a virtual environment: python -m venv .venv
5. Activate the virtual environment:
   • On macOS and Linux: source .venv/bin/activate
   • On Windows: .venv\Scripts\activate
6. Install dependencies: pip install -r requirements.txt
7. Run the agent in development mode: python main.py dev

Web Frontend Setup

1. Navigate to the /web directory
2. Copy the sample environment file: cp .env.sample .env.local
3. Open .env.local in a text editor and enter your LiveKit credentials:
4. Install dependencies: pnpm install
5. Run the development server: pnpm dev
6. Open http://localhost:3000 in your browser

Deployment

The agent can be deployed in a variety of ways: Deployment & Scaling Guide

The web frontend can be deployed using your preferred Next.js hosting solution, such as Vercel.

Troubleshooting

Ensure the following:

• Both web and agent are running
• Environment variables are set up correctly
• Correct versions of Python and pnpm are installed

Additional Resources

For more information or support, please refer to LiveKit docs.

License

Apache 2.0