Nyx Web Chat Widget

The server handles audio processing and agent communication.

# 1. Clone & Setup
git clone https://github.com/myned-ai/avatar-chat-server.git
cd avatar-chat-server
uv sync

# 2. Configure Environment
Create environmental variables as seen on .env.example
# Required: Set OPENAI_API_KEY or GEMINI_API_KEY
# Optional: Set AUTH_SECRET_KEY for secured access

# 3. Add Knowledge (Optional)
# Create your website to knowledge base text
# Set KNOWLEDGE_BASE_SOURCE env variable to the location of your knowledge base text to ground the agent
# Can be a local file path (e.g. "data/knowledge.md") or a URL

# 4. Run Server
uv run python src/main.py

# Use the docker setup if you prefer containerization
docker-compose up -d

Add the widget to any HTML page using the CDN link.

<!-- Container -->
<div id="avatar-chat"></div>

<!-- CDN Script -->
<script src="https://cdn.jsdelivr.net/npm/@myned-ai/avatar-chat-widget"></script>

<script>
  AvatarChat.init({
    container: '#avatar-chat',
    serverUrl: 'wss://your-server.com/ws',
    authEnabled: true, 
    position: 'bottom-right'
  });
</script>