Table of Contents
- Welcome to TEN
- Agent Examples
- Quick Start with Agent Examples
- Agent Examples Self-Hosting
- Stay Tuned
- TEN Ecosystem
- Questions
- Contributing
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 |
| 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. |
| 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 |
cd ai_agents
cp ./.env.example ./.envAGORA_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_heredocker compose up -ddocker exec -it ten_agent_dev bashCheck 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-realtimeRun 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 runOnce 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
- Open localhost:49483.
- Right-click the STT, LLM, and TTS extensions.
- Open their properties and enter the corresponding API keys.
- Right-click the canvas and select Manage Apps to open the Apps Manager.
- Under Actions, click ▶ to run the app.
- Select Run with TEN Agent, then click Run.
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.
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.
Note: The following commands need to be executed outside of any Docker container.
cd ai_agents
docker build -f agents/examples/<example-name>/Dockerfile -t example-app .docker run --rm -it --env-file .env -p 3000:3000 example-appYou can split the deployment into two pieces when you want to host TEN on providers such as Vercel or Netlify.
-
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
8080from that service. -
Deploy only the frontend to Vercel or Netlify. Point the project root to
ai_agents/agents/examples/<example>/frontend, runpnpm install(orbun install) followed bypnpm build(orbun run build), and keep the default.nextoutput directory. -
Configure environment variables in your hosting dashboard so that
AGENT_SERVER_URLpoints to the backend URL, and add anyNEXT_PUBLIC_*keys the UI needs (for example, Agora credentials you surface to the browser). -
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.
Get instant notifications for new releases and updates. Your support helps us grow and improve TEN!
| 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. |
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 |
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.
Contributions are welcome! Please read the contribution guidelines first.
-
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.
-
The components within the
packagesdirectory are released under the Apache License, Version 2.0. For details, please refer to theLICENSEfile located in each package's root directory. -
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.