Overview
LiveKit is an open-source real-time communication platform built on WebRTC and distributed media servers. In BrokerOS, the LiveKit integration is implemented inintegrations/voice/agents/livekit/src/index.ts under the Turborepo workspace package @brokeros/int-agent-livekit.
BrokerOS administrators configure LiveKit directly inside the Web UI at Dashboard -> Marketing -> Voice -> Settings. All API credentials and server endpoints are encrypted using AES-256-GCM and stored in PostgreSQL (VoiceAgentIntegration).
Architecture and Dispatch Sequence
The LiveKit integration implements theIVoiceAgentProvider contract from @brokeros/types.
Step 1: Obtain Credentials from LiveKit
- Log into your account at cloud.livekit.io (or your self-hosted LiveKit instance).
- Open your project dashboard.
- Under Project Settings -> Keys, generate and copy your API Key and API Secret.
- Copy your project WebSocket Server URL (e.g.
wss://yourproject.livekit.cloud).
Step 2: Connect in the BrokerOS Web Dashboard
In your BrokerOS dashboard:- Navigate to Dashboard -> Marketing -> Voice -> Settings.
- Select the Gateways & Voice Platforms tab (
/dashboard/marketing/voice/settings?tab=providers). - Click the AI Voice Platforms sub-tab.
- Click Add Platform and select LiveKit Agents.
- Fill in the modal connection fields:
- Click Save & Verify Engine. BrokerOS verifies connectivity, encrypts credentials via AES-256-GCM, and saves them in
VoiceAgentIntegration.
Integration Implementation Details
The LiveKit integration logic is located inintegrations/voice/agents/livekit/src/index.ts and integrations/voice/agents/livekit/src/livekit-dispatcher.ts.