Official Site • Documentation • Blog

Table of Contents

Table of Contents

• 👋 Welcome to TEN
• 🎨 TMAN Designer
• 🤖 TEN Agent
  • 1️⃣ Real-time Avatar
  • 2️⃣ Real-time voice with MCP servers
  • 3️⃣ Real-time communication with hardware
  • 4️⃣ Real-time vision and real-time screenshare detection
  • 5️⃣ TEN with other LLM platforms
• 🛝 TEN Agent Playground
  • ️🅰️ Run Playground in localhost
  • ️🅱️ Run Playground in Codespace(no docker)
• 🛳️ TEN Agent Self Hosting
  • 🅰️ 🐳 Deploying with Docker
  • 🅱️ Deploying with other cloud services
• 🏗️ TEN Agent Architecture
• 🌍 TEN Framework Ecosystem
• 🥰 Contributing
  • Code Contributors
  • Contribution Guidelines
  • License

👋 Welcome to TEN

TEN is a collection of open-source projects for building real-time, multimodal conversational voice agents, including TEN Framework, TEN VAD, TEN Turn Detection, TEN Agent, TMAN Designer, TEN Portal, and more.

Community Channel	Purpose
	Follow TEN Framework on X 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

Important

Star TEN Repositories ⭐️

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

Star History

🎨 TMAN Designer

TMAN Designer

TMAN Designer is a low/no-code option to create voice agents with an easy-to-use workflow UI. It can load apps and graphs, and includes an online editor, log viewer, and much more.

Check out this blog for more details.

🤖 TEN Agent

1️⃣ Real-time Avatar

Build engaging AI avatars with TEN Agent using Trulience's diverse collection of free avatar options. To get it up and running, you only need 2 steps:

1. Follow the README to finish setting up and running the Playground
2. Enter the avatar ID and token you get from Trulience

2️⃣ Real-time voice with MCP servers

TEN Agent now integrates seamlessly with MCP servers, expanding its LLM capabilities. To get started:

1. Open the Module Picker in Playground
2. Add the MCP server tool for LLM integration
3. Paste a URL from your MCP server in the extension
4. Start a realtime conversation with TEN Agent

This integration allows you to leverage MCP's diverse servers offerings while maintaining TEN Agent's powerful conversational abilities.

esp32.mov

3️⃣ Real-time communication with hardware

TEN Agent is now running on the Espressif ESP32-S3 Korvo V3 development board, an excellent way to integrate realtime communication with LLM on hardware.

Check out the integration guide for more details.

4️⃣ Real-time vision and real-time screenshare detection

Try Google Gemini Multimodal Live API with realtime vision and realtime screenshare detection capabilities, it is a ready-to-use extension, along with powerful tools like Weather Check and Web Search integrated perfectly into TEN Agent.

5️⃣ TEN with other LLM platforms

TEN Agent + Dify

TEN offers a great support to make the realtime interactive experience even better on other LLM platform as well, check out docs for more.

🛝 Quick Start with TEN Agent Playground

🅰️ Run Playground in 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 Core • RAM >= 4 GB

Note

macOS: Docker setting on Apple Silicon

Uncheck "Use Rosetta for x86/amd64 emulation" in Docker settings, it may result in slower build times on ARM, but performance will be normal when deployed to x64 servers.

Step ⓶ - Build agent in VM

1. Clone down the repo,cd to ai-agents and create .env file from .env.example

cd ai_agent
cp ./.env.example ./.env

2. Setup Agora App ID and App Certificate in .env

AGORA_APP_ID=
AGORA_APP_CERTIFICATE=

3. Start agent development containers

docker compose up -d

4. Enter container

docker exec -it ten_agent_dev bash

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

check the /examples folder for more examples

# use the default agent
task use

# or use the demo agent
task use AGENT=agents/examples/demo

6. Start the web server

task run

Step ⓷ - Customize your agent with TMAN Designer

1. Open localhost:49483.
2. Load the corresponding graph from the menu (e.g., Voice Assistant).
3. Enter API keys and set preferences for each extension.
4. Open localhost:3000 to see the changes after selecting Voice Assistant.

🅱️ Run Playground in Codespace(no docker)

GitHub offers free Codespace for each repository, you can run the playground in Codespace without using Docker.Also, the speed of Codespace is much faster than localhost.

Check out this guide for more details.

🛳️ TEN Agent Self Hosting

🅰️ 🐳 Deploying with Docker

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

Read the Deployment Guide for detailed information about deployment.

🅱️ Deploying with other cloud services

coming soon

🌏 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 is for full-duplex dialogue communication.
🎙️ TEN Agent TEN Agent is a showcase of TEN Framewrok.
🎨 TMAN Designer beta TMAN Designer is low/no code option to make a voice agent with easy to use workflow UI.
📒 TEN Portal The official site of TEN framework, it has documentation and blog.

🥰 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 with to inspire others!

Connect with one of the TEN maintainers @elliotchen100 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.