Documentation   •   Getting Started   •   TEN Framework Repository

Table of Contents

Table of Contents

• 👋 Getting Started & Join TEN Community
• ✨ Features
  • 1️⃣ Ten Agent + Trulience
  • 2️⃣ Ten Agent + Deepseek
  • 3️⃣ Ten Agent + ESP32
  • 4️⃣ Ten Agent + Gemini Multimodal Live API
  • 5️⃣ Ten Agent + Storyteller + Image Generator
  • 6️⃣ Ten Agent + Dify
  • 7️⃣ Ten Agent + Coze
• 💡 TEN Agent Usecases
• 🔌 Ready to use Extensions
• 🎮 TEN Agent Playground
  • ️️🅰 Run Playground in localhost
  • ️🅱 Run Playground in Codespace(no docker)
• 🎥 Run Agent Demo
• ️🛳️ Deployment
  • 🅰 Deploying with Docker
  • 🅱 Deploying with other services
• 🏗️ TEN Agent Architecture
• 🌍 TEN Framework Ecosystem
• 🤝 Contributing

👋 Getting Started & Join TEN Community

TEN Agent is a conversational voice AI agent powered by TEN, integrating DeepSeek, Gemini, OpenAI, RTC, and hardware like ESP32. It enables realtime AI capabilities like seeing, hearing, and speaking, and is fully compatible with platforms like Dify and Coze.

Community Channel	Purpose
	Join our Discord community to connect with developers, share projects and get help
	Follow TEN Framework on X for updates and announcements
	Join our WeChat group for Chinese community discussions

Important

Star Our Repository ⭐️

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

Star History

✨ Features

1️⃣ 🔥 Ten Agent + Trulience

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 in localhost:3000
2. Enter the avatar ID and token you get from Trulience

TEN Agent + Trulience

2️⃣ TEN Agent + DeepSeek

TEN is a very versatile framework. That said, TEN Agent is compatible with DeepSeek R1, try experiencing realtime conversations with DeepSeek R1!

3️⃣ TEN Agent + ESP32

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.

4️⃣ TEN Agent + Gemini Multimodal Live API

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.

Gemini 2.0 Multimodal Live API

5️⃣ TEN Agent + Storyteller + Image Generator

Describe a topic and ask TEN Agent to tell you a story while also generating images of the story to provide a more immersive experience for kids.

Storyteller + Image Generator

6️⃣ TEN Agent + Dify

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.

TEN Agent + Dify with RAG

7️⃣ TEN Agent + Coze

TEN Agent + Coze

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

💡 TEN Agent Usecases

🔌 Ready-to-use Extensions

🎮 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 and create .env file from .env.example

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

task use

6. Start the web server

task run

Step ⓷ - Customize your agent

1. Open Up localhost:3000 and select a graph example
2. Choose a corresponding module
3. Select an extension and configure its API key and settings

Module Picker Example

Now, we have successfully set up the playground. This is just the beginning of TEN Agent. There are many different ways to explore and utilize TEN Agent. To learn more, please refer to the documentation.

🅱️ 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 Demo

Playground and Demo server different purposes, in a nut shell, think it as Playground is for you to customize you agent, and Demo is for you to deploy your agent.

Check out this guide for more details.

🛳️ Deployment

🅰️ Deploying with Docker

Once you have customized your agent (either by using the 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 services

coming soon...

🏗️ TEN Agent Architecture

🌍 TEN Framework Ecosystem

🏚️ TEN Framework TEN, a AI agent framework to create various AI agents which supports real-time conversation.
🎙️ TEN Agent TEN Agent is a conversational voice AI agent powered by TEN, integrating Deepseek, Gemini, OpenAI, RTC, and hardware like ESP32. It enables realtime AI capabilities like seeing, hearing, and speaking, and is fully compatible with platforms like Dify and Coze.
🎨 TMAN Designer alpha TMAN Designer is low/no code option to make a cool voice agent. With it's easy-to-use workflow UI, you can build things easily. It comes with runtime, dark/light themes, integrated editors and integrated terminals.
📒 TEN Portal The official site of TEN framework, it has documentation, blog and showcases.

🤝 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! 🤝✨

Code Contributors

Contribution Guidelines

Contributions are welcome! Please read the contribution guidelines first.

License

This project is Apache 2.0 licensed.