### 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=
```
##### 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 `graph` ( ~5min - ~8min)
check the `/examples` folder for more examples
```bash
# use the default agent
task use
# or use the demo agent
task use AGENT=agents/examples/demo
```
##### 6. Start the web server
```bash
task run
```
#### Step ⓷ - Customize your agent with TMAN Designer
1. Open [localhost:49483](http://localhost:49483).
2. Right click to load the corresponding graph (e.g., Voice Assistant).
3. Enter API keys and set preferences for each extension.
4. Right click and Select 'Manage Apps' to open the Apps Manager.
5. Click the ▶ to run App.
[![][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.
Read the [Deployment Guide](https://theten.ai/docs/ten_agent/deploy_ten_agent/deploy_agent_service) for detailed information about deployment.
#### 🅱️ 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)