Integration Flow
Telephony Providers
Telephony Providers
Twilio (traditional, full-featured)
- Purpose: Handles phone calls, media streaming, and SMS.
- Setup:
- Sign up at Twilio.
- Buy a phone number and enable Media Streams.
- Set environment variables:
TWILIO_ACCOUNT_SID
,TWILIO_AUTH_TOKEN
- Configure Twilio webhook to point to your Burki backend.
- Purpose: Next-generation telephony with Call Control API.
- Setup:
- Sign up at Telnyx.
- Buy a phone number and create a Call Control Application.
- Set environment variables:
TELNYX_API_KEY
,TELNYX_CONNECTION_ID
- Configure Telnyx webhook to point to your Burki backend.
- Each assistant can use different telephony providers.
- Configure provider credentials in the assistant settings.
- System automatically detects and uses the appropriate provider.
Speech-to-Text (STT) Providers
Speech-to-Text (STT) Providers
Deepgram (default, recommended)
- Real-time transcription of audio calls.
- Set
DEEPGRAM_API_KEY
in your.env
.
- You can extend Burki to use other STT APIs by customizing the backend.
Language Model (LLM) Providers
Language Model (LLM) Providers
OpenAI (default, recommended)
- Generates intelligent responses using GPT models.
- Set
OPENAI_API_KEY
in your.env
.
- Use
INWORLD_BEARER_TOKEN
for Inworld LLM.
- Configure provider and API key in assistant settings or
.env
.
Text-to-Speech (TTS) Providers
Text-to-Speech (TTS) Providers
ElevenLabs (default, recommended)
- Converts text responses to natural-sounding speech.
- Set
ELEVENLABS_API_KEY
in your.env
.
- Use Deepgram for TTS if enabled in your assistant config.
- Use Inworld for TTS with
INWORLD_BEARER_TOKEN
.
- Use
RESEMBLE_API_KEY
for Resemble TTS.
Storage (S3, etc.)
Storage (S3, etc.)
- Stores call recordings and large audio files.
- Set S3 environment variables if using cloud storage.
Database (PostgreSQL)
Database (PostgreSQL)
- Stores all app data (users, calls, assistants, etc.)
- Set
DATABASE_URL
in your.env
file.