voice-gateway-setup

Voice Gateway Setup Guide

Deploy an AI Agent as a voice-enabled endpoint with WebRTC support. Users can talk to the agent directly in their browser.

Prerequisites

1. A Project — use list_resources { resourceType: "project" } to find one, or let create_ai_agent create one automatically.
2. A Flow — the conversation logic the voice endpoint connects to. Use list_resources { resourceType: "flow", projectId } to find existing flows.
3. An LLM — the agent needs an LLM to generate responses. Use setup_llm if not configured.

Quick Start

1. Create a Voice Gateway endpoint

{
  "projectId": "<24-char hex>",
  "flowId": "<flow referenceId>",
  "name": "My Voice Agent"
}

This automatically:

• Creates a voiceGateway2 endpoint
• Provisions a WebRTC client
• Returns a webrtcDemoUrl the user can open in a browser

2. Customize the WebRTC widget (optional)

{
  "projectId": "<24-char hex>",
  "flowId": "<flow referenceId>",
  "name": "My Voice Agent",
  "webrtcWidgetConfig": {
    "label": "Support Agent",
    "theme": "AI_PURPLE",
    "transcription": { "enabled": true },
    "tagline": "How can I help you today?",
    "avatarLogoUrl": "https://example.com/avatar.png"
  }
}

3. Update an existing endpoint

{
  "endpointId": "<24-char hex>",
  "webrtcWidgetConfig": {
    "theme": "CLEAN_WHITE"
  }
}

Create vs update:

• Omit endpointId → a new voiceGateway2 endpoint is always created (projectId + flowId required). The tool never auto-detects an existing endpoint.
• Pass endpointId → that endpoint is updated and the settings you pass are merged into its existing configuration; everything else is preserved. Find it first with list_resources { resourceType: "endpoint", projectId }.

WebRTC Widget Themes

Theme	Description
DARK_MODE	Dark background (default)
CLEAN_WHITE	Light/white background
AI_PURPLE	Purple accent theme