Official Site • Documentation • Blog

Table of Contents

• Welcome to TEN
• Agent Examples
• Quick Start with Agent Examples
  • Localhost
  • Codespaces
• Agent Examples Self-Hosting
  • Deploying with Docker
  • Deploying with other cloud services
• Stay Tuned
• TEN Ecosystem
• Questions
• Contributing
  • Code Contributors
  • Contribution Guidelines
  • License

Welcome to TEN

TEN is a comprehensive open-source ecosystem for creating, customizing, and deploying real-time conversational AI agents with multimodal capabilities including voice, vision, and avatar interactions.

TEN includes the TEN Framework, TEN VAD, TEN Turn Detection and TEN Portal. See TEN Ecosystem for more details.

Community Channel	Purpose
	Follow TEN Framework on X for updates and announcements
	Follow TEN Framework on LinkedIn for updates and announcements
	Join our Discord community to connect with developers
	Join our Hugging Face community to explore our spaces and models
	Join our WeChat group for Chinese community discussions

Agent Examples

Preview	Highlights
	Multi-Purpose Voice Assistant — Low-latency, high-quality, real-time assistant that you can extend with memory, VAD, TEN Turn Detection and other extensions. See the Example code for more details.
	Lip Sync Avatars — Works with multiple avatar vendors, the demo features Kei, an anime character with Live2D-powered lip sync, and also supports realistic avatars from Trulience, HeyGen, and Tavus (coming soon). See the Example code for Live2D avatars.
	SIP Call — SIP extension that enables phone calls powered by TEN. Example code
	Speech Diarization — Real-time diarization that detects and labels speakers, the Who Likes What game shows an interactive use case. Example code
	Transcription — A transcription tool that transcribes audio to text. Example code
	ESP32-S3 Korvo V3 — Runs TEN Agent example on the Espressif ESP32-S3 Korvo V3 development board to integrate LLM-powered communication with hardware. See the integration guide for more details.

Quick Start with Agent Examples

Localhost

Step ⓵ - Prerequisites

Category	Requirements
Keys	• Agora App ID and App Certificate (free minutes every month) • OpenAI API key (any LLM that is compatible with OpenAI) • Deepgram ASR (free credits available with signup) • ElevenLabs TTS (free credits available with signup)
Installation	• Docker / Docker Compose • Node.js (LTS) v18
Minimum System Requirements	• CPU >= 2 cores • RAM >= 4 GB

Step ⓶ - Build agent examples in VM

1. Clone the repo, cd into ai_agents, and create a .env file from .env.example

cd ai_agents
cp ./.env.example ./.env

2. Set up the Agora App ID and App Certificate in .env

AGORA_APP_ID=
AGORA_APP_CERTIFICATE=

# In case you are running the default voice-assistant example
# Deepgram (required for speech-to-text)
DEEPGRAM_API_KEY=your_deepgram_api_key_here

# OpenAI (required for language model)
OPENAI_API_KEY=your_openai_api_key_here
OPENAI_MODEL=gpt-4o

# ElevenLabs (required for text-to-speech)
ELEVENLABS_TTS_KEY=your_elevenlabs_api_key_here

3. Start agent development containers

docker compose up -d

4. Enter the container

docker exec -it ten_agent_dev bash

5. Build the agent with the default example (~5-8 min)

Check the agents/examples folder for additional samples. Start with one of these defaults:

# use the chained voice assistant
cd agents/examples/voice-assistant

# or use the speech-to-speech voice assistant in real time
cd agents/examples/voice-assistant-realtime

6. Start the web server

Run task build if you changed any local source code. This step is required for compiled languages (for example, TypeScript or Go) and not needed for Python.

task install
task run

7. Access the agent

Once the agent example is running, you can access the following interfaces:

localhost:49483

localhost:3000

• TMAN Designer: http://localhost:49483
• Example UI: http://localhost:3000

Step ⓷ - Customize your agent

1. Open localhost:49483.
2. Right-click the STT, LLM, and TTS extensions.
3. Open their properties and enter the corresponding API keys.
4. Right-click the canvas and select Manage Apps to open the Apps Manager.
5. Under Actions, click ▶ to run the app.
6. Select Run with TEN Agent, then click Run.

Codespaces

GitHub offers free Codespaces for each repository. You can run Agent Examples in Codespaces without using Docker. Codespaces typically start faster than local Docker environments.

Check out this guide for more details.

Agent Examples Self-Hosting

Deploying with Docker

Once you have customized your agent (either by using the TMAN Designer or editing property.json directly), you can deploy it by creating a release Docker image for your service.

Release as Docker image

Note: The following commands need to be executed outside of any Docker container.

Build image

cd ai_agents
docker build -f agents/examples/<example-name>/Dockerfile -t example-app .

Run

docker run --rm -it --env-file .env -p 3000:3000 example-app

Deploying with other cloud services

You can split the deployment into two pieces when you want to host TEN on providers such as Vercel or Netlify.

1. Run the TEN backend on any container-friendly platform (a VM with Docker, Fly.io, Render, ECS, Cloud Run, or similar). Use the example Docker image without modifying it and expose port 8080 from that service.

2. Deploy only the frontend to Vercel or Netlify. Point the project root to ai_agents/agents/examples/<example>/frontend, run pnpm install (or bun install) followed by pnpm build (or bun run build), and keep the default .next output directory.

3. Configure environment variables in your hosting dashboard so that AGENT_SERVER_URL points to the backend URL, and add any NEXT_PUBLIC_* keys the UI needs (for example, Agora credentials you surface to the browser).

4. Ensure your backend accepts requests from the frontend origin — via open CORS or by using the built-in proxy middleware.

With this setup, the backend handles long-running worker processes, while the hosted frontend simply forwards API traffic to it.

Stay Tuned

Get instant notifications for new releases and updates. Your support helps us grow and improve TEN!

TEN Ecosystem

Project	Preview
️TEN Framework TEN is an open-source framework for real-time, multimodal conversational AI.
TEN VAD TEN VAD is a low-latency, lightweight and high-performance streaming voice activity detector (VAD).
️ TEN Turn Detection TEN Turn Detection enables full-duplex dialogue communication.
TEN Portal The official site of the TEN Framework with documentation and a blog.
TEN Agent TEN Agent is a showcase of the TEN Framework.
TMAN Designer TMAN Designer is a low/no-code option for building a voice agent with an easy-to-use workflow UI.

Questions

TEN Framework is available on these AI-powered Q&A platforms. They can help you find answers quickly and accurately in multiple languages, covering everything from basic setup to advanced implementation details.

Service	Link
DeepWiki
ReadmeX

Contributing

We welcome all forms of open-source collaboration! Whether you're fixing bugs, adding features, improving documentation, or sharing ideas, your contributions help advance personalized AI tools. Check out our GitHub Issues and Projects to find ways to contribute and show your skills. Together, we can build something amazing!

Tip

Welcome all kinds of contributions 🙏

Join us in building TEN better! Every contribution makes a difference, from code to documentation. Share your TEN Agent projects on social media to inspire others!

Connect with one of the TEN maintainers @elliotchen200 on 𝕏 or @cyfyifanchen on GitHub for project updates, discussions, and collaboration opportunities.

Code Contributors

Contribution Guidelines

Contributions are welcome! Please read the contribution guidelines first.

License

1. The entire TEN framework (except for the folders explicitly listed below) is released under the Apache License, Version 2.0, with additional restrictions. For details, please refer to the LICENSE file located in the root directory of the TEN framework.

2. The components within the packages directory are released under the Apache License, Version 2.0. For details, please refer to the LICENSE file located in each package's root directory.

3. The third-party libraries used by the TEN framework are listed and described in detail. For more information, please refer to the third_party folder.