# ten-framework
**Repository Path**: mapoet/ten-framework
## Basic Information
- **Project Name**: ten-framework
- **Description**: Open-source framework for conversational voice AI agents
- **Primary Language**: C
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-10-25
- **Last Updated**: 2025-11-12
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
Table of Contents
#### Table of Contents
- [👋 Welcome to TEN](#-welcome-to-ten)
- [🎨 TMAN Designer](#-tman-designer)
- [✨ Features](#-features)
- [1️⃣ Real-time Avatar](#1️⃣-real-time-avatar)
- [2️⃣ Real-time voice with MCP servers](#2️⃣-real-time-voice-with-mcp-servers)
- [3️⃣ Real-time communication with hardware](#3️⃣-real-time-communication-with-hardware)
- [4️⃣ Real-time vision and real-time screenshare detection](#4️⃣-real-time-vision-and-real-time-screenshare-detection)
- [5️⃣ TEN with other LLM platforms](#5️⃣-ten-with-other-llm-platforms)
- [6️⃣ StoryTeller - TEN image generation](#6️⃣-storyteller---ten-image-generation)
- [👩💻 Get TEN Agent up and running](#-get-ten-agent-up-and-running)
- [🅰️ Run TEN Agent in `localhost`](#🅰️-run-ten-agent-in-localhost)
- [🅱️ Run TEN Agent in Codespace(no docker)](#🅱️-run-ten-agent-in-codespaceno-docker)
- [🛳️ TEN Agent Self Hosting](#️-ten-agent-self-hosting)
- [🅰️ Deploying with Docker](#🅰️-deploying-with-docker)
- [🅱️ Deploying with other cloud services](#🅱️-deploying-with-other-cloud-services)
- [🌍 TEN Ecosystem](#-ten-ecosystem)
- [❓ Ask Questions](#-ask-questions)
- [🥰 Contributing](#-contributing)
- [Code Contributors](#code-contributors)
- [Contribution Guidelines](#contribution-guidelines)
- [License](#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 [TEN Framework](https://github.com/ten-framework/ten-framework), [TEN Turn Detection](https://github.com/ten-framework/ten-turn-detection), [TEN VAD](https://github.com/ten-framework/ten-vad), [TEN Agent](https://github.com/TEN-framework/ten-framework/tree/main/ai_agents/demo), [TMAN Designer](https://github.com/TEN-framework/ten-framework/tree/main/core/src/ten_manager/designer_frontend), and [TEN Portal](https://github.com/ten-framework/portal). Check out [🌍 TEN Ecosystem](#-ten-ecosystem) for more details.
| Community Channel | Purpose |
| ---------------- | ------- |
| [](https://twitter.com/intent/follow?screen_name=TenFramework) | Follow TEN Framework on X for updates and announcements |
| [](https://www.linkedin.com/company/ten-framework) | Follow TEN Framework on LinkedIn for updates and announcements |
| [](https://discord.gg/VnPftUzAMJ) | Join our Discord community to connect with developers |
| [](https://huggingface.co/TEN-framework) | Join our Hugging Face community to explore our spaces and models |
| [](https://github.com/TEN-framework/ten-agent/discussions/170) | 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
[![][back-to-top]](#readme-top)
## 🎨 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](https://theten.ai/blog/tman-designer-of-ten-framework) for more details.
[![][back-to-top]](#readme-top)
## ✨ Features
### 1️⃣ Real-time Avatar
Build engaging AI avatars with TEN Agent using [Trulience](https://trulience.com)'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](https://trulience.com/docs#/authentication/jwt-tokens/jwt-tokens?id=use-your-custom-userid) you get from [Trulience](https://trulience.com)
[![][back-to-top]](#readme-top)
### 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.
[![][back-to-top]](#readme-top)
### 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](https://github.com/TEN-framework/ten-framework/tree/main/ai_agents/esp32-client) for more details.
[![][back-to-top]](#readme-top)
### 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.
[![][back-to-top]](#readme-top)
### 5️⃣ TEN with other LLM platforms
[TEN Agent + Dify](https://theten.ai/docs/ten_agent/playground/use-cases/voice-assistant/run_dify#steps)
TEN offers a great support to make the realtime interactive experience even better on other LLM platform as well, check out docs for more.
[![][back-to-top]](#readme-top)
### 6️⃣ StoryTeller - TEN image generation
Experience the real-time image generation with StoryTeller, it is a ready-to-use extension, along with powerful tools like Weather Check and Web Search integrated perfectly into TEN.
[![][back-to-top]](#readme-top)
## 👩💻 Get TEN Agent up and running
#### 🅰️ Run TEN Agent in localhost
#### Step ⓵ - Prerequisites
| Category | Requirements |
| --- | --- |
| **Keys** | • Agora [App ID](https://docs.agora.io/en/video-calling/get-started/manage-agora-account?platform=web#create-an-agora-project) and [App Certificate](https://docs.agora.io/en/video-calling/get-started/manage-agora-account?platform=web#create-an-agora-project) (free minutes every month)
• [OpenAI](https://openai.com/index/openai-api/) API key (any LLM that is compatible with OpenAI)
• [Deepgram](https://deepgram.com/) ASR (free credits available with signup)
• [Elevenlabs](https://elevenlabs.io/) TTS (free credits available with signup) |
| **Installation** | • [Docker](https://www.docker.com/) / [Docker Compose](https://docs.docker.com/compose/)
• [Node.js(LTS) v18](https://nodejs.org/en) |
| **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`
```bash
cd ai_agents
cp ./.env.example ./.env
```
##### 2. Setup Agora App ID and App Certificate in `.env`
```bash
AGORA_APP_ID=
AGORA_APP_CERTIFICATE=
# In case you are running 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
```bash
docker compose up -d
```
##### 4. Enter container
```bash
docker exec -it ten_agent_dev bash
```
##### 5. Build agent with the default example ( ~5min - ~8min)
check the `/examples` folder for more examples
```bash
# use the chained voice assistant
cd agents/examples/voice-assistant
# or use the speech-to-speech voice assistant realtime
cd agents/examples/voice-assistant-realtime
```
##### 6. Start the web server
```bash
task install
# run task build if you changed any local source code, this is necessary if you are working on languages which require compilation like TypeScript or Golang, while not needed for languages like Python
# task build
task run
```
##### 7. Access the agent
- Frontend: http://localhost:3000
- API Server: http://localhost:8080
- TMAN Designer: http://localhost:49483
#### Step ⓷ - Customize your agent with TMAN Designer
1. Open [localhost:49483](http://localhost:49483).
2. Right-click on the STT, LLM, and TTS extensions.
3. Open their properties and enter APIs respectively.
4. Right-click the canvas and select 'Manage Apps' to open the Apps Manager.
5. Right under the Actions, click the ▶ to run the App.
6. Check the 'Run with TEN Agent' option and click the Run button.
[![][back-to-top]](#readme-top)
### 🅱️ Run TEN Agent 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.
[codespaces-shield]:
[![][codespaces-shield]](https://codespaces.new/ten-framework/ten-agent)
Check out [this guide](https://theten.ai/docs/ten_agent/setup_development_env/setting_up_development_inside_codespace) for more details.
[![][back-to-top]](#readme-top)
## 🛳️ 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.
##### Release as Docker image
**Note**: The following commands need to be executed outside of any Docker container.
###### Build image
```bash
cd ai_agents
docker build -f agents/examples//Dockerfile -t example-app .
```
###### Run
```bash
docker run --rm -it --env-file .env -p 3000:3000 example-app
```
#### 🅱️ Deploying with other cloud services
*coming soon*
[![][back-to-top]](#readme-top)
## 🌍 TEN Ecosystem
| Project | Preview |
| ------- | ------- |
| [**🏚️ TEN Framework**][ten-framework-link]
TEN is an open-source framework for real-time, multimodal conversational AI.
![][ten-framework-shield] | ![][ten-framework-banner] |
| [**️🔂 TEN Turn Detection**][ten-turn-detection-link]
TEN is for full-duplex dialogue communication.
![][ten-turn-detection-shield] | ![][ten-turn-detection-banner] |
| [**🔉 TEN VAD**][ten-vad-link]
TEN VAD is a low-latency, lightweight and high-performance streaming voice activity detector (VAD).
![][ten-vad-shield] | ![][ten-vad-banner] |
| [**🎙️ TEN Agent**][ten-agent-link]
TEN Agent is a showcase of TEN Framewrok.
| ![][ten-agent-banner] |
| [**🎨 TMAN Designer**][tman-designer-link]
TMAN Designer is low/no code option to make a voice agent with easy to use workflow UI.
| ![][tman-designer-banner] |
| [**📒 TEN Portal**][ten-portal-link]
The official site of TEN framework, it has documentation and blog.
![][ten-portal-shield] | ![][ten-portal-banner] |
[![][back-to-top]](#readme-top)
## ❓ Ask 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 | [](https://deepwiki.com/TEN-framework/TEN-framework) |
| ReadmeX | [](https://readmex.com/TEN-framework/ten-framework) |
[![][back-to-top]](#readme-top)
## 🥰 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](https://x.com/elliotchen100) on 𝕏 or [@cyfyifanchen](https://github.com/cyfyifanchen) on GitHub for project updates, discussions and collaboration opportunities.
### Code Contributors
[](https://github.com/TEN-framework/ten-agent/graphs/contributors)
### Contribution Guidelines
Contributions are welcome! Please read the [contribution guidelines](./docs/code-of-conduct/contributing.md) 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](./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](./third_party/) folder.
[![][back-to-top]](#readme-top)
[back-to-top]: https://img.shields.io/badge/-Back_to_top-gray?style=flat-square
[ten-framework-shield]: https://img.shields.io/github/stars/ten-framework/ten_framework?color=ffcb47&labelColor=gray&style=flat-square&logo=github
[ten-framework-banner]: https://github.com/user-attachments/assets/7c8f72d7-3993-4d01-8504-b71578a22944
[ten-framework-link]: https://github.com/ten-framework/ten_framework
[ten-vad-link]: https://github.com/ten-framework/ten-vad
[ten-vad-shield]: https://img.shields.io/github/stars/ten-framework/ten-vad?color=ffcb47&labelColor=gray&style=flat-square&logo=github
[ten-vad-banner]: https://github.com/user-attachments/assets/d45870e4-9453-4047-8163-08737f82863f
[ten-turn-detection-link]: https://github.com/ten-framework/ten-turn-detection
[ten-turn-detection-shield]: https://img.shields.io/github/stars/ten-framework/ten-turn-detection?color=ffcb47&labelColor=gray&style=flat-square&logo=github
[ten-turn-detection-banner]: https://github.com/user-attachments/assets/8d0ec716-5d0e-43e4-ad9a-d97b17305658
[ten-agent-link]: https://github.com/TEN-framework/ten-framework/tree/main/ai_agents
[ten-agent-banner]: https://github.com/user-attachments/assets/38de2207-939b-4702-a0aa-04491f5b5275
[tman-designer-banner]: https://github.com/user-attachments/assets/804c3543-0a47-42b7-b40b-ef32b742fb8f
[tman-designer-link]: https://github.com/TEN-framework/ten-framework/tree/main/core/src/ten_manager/designer_frontend
[ten-portal-link]: https://github.com/ten-framework/portal
[ten-portal-shield]: https://img.shields.io/github/stars/ten-framework/portal?color=ffcb47&labelColor=gray&style=flat-square&logo=github
[ten-portal-banner]: https://github.com/user-attachments/assets/e17d8aaa-5928-45dd-ac71-814928e26a89 
[Official Site](https://theten.ai)
•
[Documentation](https://theten.ai/docs/ten_agent/overview)
•
[Blog](https://theten.ai/blog)