Getting Started

Three steps, you can get TEN up and running.

Step ⓵ - Prerequisites

• 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)

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_agents
cp ./.env.example ./.env
2. Setup Agora App ID, App Certificate, Deepgram API Key and ElevenLabs API Key in .env
# Agora App ID
# Agora App Certificate(only required if enabled in the Agora Console)
AGORA_APP_ID=
AGORA_APP_CERTIFICATE=
 
# Extension: elevenlabs_tts
# ElevenLabs TTS key
ELEVENLABS_TTS_KEY=
 
# Extension: deepgram_asr
# Deepgram ASR key
DEEPGRAM_API_KEY=
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
 
# this is equivalent to following command
task use AGENT=agents/examples/voice-assistant
 
# you can also change the command to setup other examples
task use AGENT=agents/examples/<example_name>
6. Start the web server
task run

Step â“· - Customize your agent with TMAN Designer

  1. Open localhost:49483.
  2. Right-click to load the corresponding graph (e.g., Voice Assistant).
  3. Enter API keys and set preferences for each extension if you have not set them in .env in previous steps.
  4. Right-click and select Manage Apps to start the Apps Manager.
  5. Click Run App to start TEN Agent.