Burki Voice AI Get your first AI-powered voice assistant up and running in minutes!

​
Prerequisites

Before you begin, make sure you have:
  • A Twilio account (for phone numbers and calls)
  • API keys for at least one provider in each category:
    • LLM (Language Model): OpenAI, Anthropic, Gemini, xAI, or Groq
    • TTS (Text-to-Speech): ElevenLabs, Deepgram, Inworld, or Resemble
    • STT (Speech-to-Text): Deepgram
  • A phone number purchased in Twilio (recommended)
  • Python 3.9+ and Docker (for local setup)
Tip: You can start with free or trial accounts for most providers.

​
1. Clone & Install

git clone https://github.com/meeran03/burki.git
cd burki
pip install -r requirements.txt
Or use Docker: 
docker build -t burki-voice-ai .
docker run -p 8000:8000 burki-voice-ai

​
2. Set Up Environment Variables

Copy the example file and fill in your secrets: 
cp .env.example .env
# Edit .env with your API keys and Twilio credentials

​
3. Run the App

python app/main.py
# or with Docker, as above
Visit http://localhost:8000 in your browser.

​
4. Create Your First Assistant

  1. Log in (register if needed)
  2. Click “Create New Assistant”
  3. Fill in:
    • Basic Info: Name, description
    • AI Configuration:
      • Pick your LLM, TTS, and STT providers
      • Paste in your API keys
      • Choose models and voices
      • Set a greeting message
    • Integration: Add your Twilio phone number
    • (Optional) Configure RAG, call management, and tools
  4. Click “Create Assistant”
That’s it! Your assistant is ready to take calls.

​
Minimal Example Configuration

Here’s what a minimal working setup looks like:
  • LLM Provider: OpenAI (GPT-4o)
  • TTS Provider: ElevenLabs (Flash v2.5, Rachel)
  • STT Provider: Deepgram (Nova-3, English)
  • Twilio Number: Your purchased number
You can always add more advanced features later!

​
5. Making Your First API Call

Once your assistant is created, you can interact with it using the API. All API requests must be authenticated using a Bearer Token.

​
A. Get Your API Key

  1. From the web interface, click on your profile/organization name in the top right corner.
  2. Navigate to API Keys.
  3. Click “Generate New API Key”.
  4. Give it a descriptive name and click “Create”.
  5. Copy the key immediately! You won’t be able to see it again for security reasons.

​
B. Authenticate Your Request

To make an authenticated API call, include the API key in the Authorization header of your request, prefixed with Bearer . Here is an example using curl to list your assistants: 
# Replace <YOUR_API_KEY> with the key you just copied
curl -X GET "http://localhost:8000/api/v1/assistants/" \
     -H "Authorization: Bearer <YOUR_API_KEY>" \
     -H "Content-Type: application/json"
A successful request will return a JSON array of your assistants. Now you’re ready to explore the full API Reference!

​
Next Steps