> ## Documentation Index
> Fetch the complete documentation index at: https://docs.burki.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Usage

> How to use Burki Voice AI: dashboard, phone, and API

This page explains how to use Burki Voice AI as an end user, admin, or developer.

***

## Web Dashboard

The web dashboard at [burki.dev/dashboard](https://burki.dev/dashboard) is the main interface for managing your voice AI system.

### Common Tasks

* **Log in** with your credentials or Google account
* **Create or edit assistants**: Set up personalities, assign phone numbers, and configure integrations
* **View call history**: Access transcripts, recordings, and analytics
* **Manage billing**: Add funds, view usage, and configure auto top-up
* **Manage team**: Add team members, set roles, and manage permissions

***

## Phone Call Flow

Burki handles real phone calls through your configured telephony provider.

### Inbound Call Flow

1. **Customer calls your number** assigned to an assistant
2. **Burki answers** and plays the greeting message
3. **Real-time transcription** converts speech to text
4. **AI generates response** based on the conversation context
5. **Text-to-speech** converts the response to natural speech
6. **Customer hears response** with sub-second latency
7. **Call is recorded** and available in the dashboard

### Outbound Call Flow

1. **API request** triggers an outbound call
2. **Burki dials** the target number
3. **Same conversation flow** once connected
4. **Webhook notification** sent with call status

***

## API Usage

Burki exposes a RESTful API for programmatic access.

### Authentication

All API requests require a Bearer token:

```bash theme={null}
curl -X GET "https://api.burki.dev/api/v1/assistants/" \
     -H "Authorization: Bearer YOUR_API_KEY"
```

### Common Operations

<AccordionGroup>
  <Accordion title="List Assistants">
    ```bash theme={null}
    GET /api/v1/assistants/
    ```
  </Accordion>

  <Accordion title="Create Assistant">
    ```bash theme={null}
    POST /api/v1/assistants/
    Content-Type: application/json

    {
      "name": "Support Bot",
      "llm_provider": "openai",
      "llm_model": "gpt-4o"
    }
    ```
  </Accordion>

  <Accordion title="Get Call History">
    ```bash theme={null}
    GET /api/v1/calls/
    ```
  </Accordion>

  <Accordion title="Send SMS">
    ```bash theme={null}
    POST /sms/send
    Content-Type: application/json

    {
      "from_phone_number": "+10987654321",
      "to_phone_number": "+1234567890",
      "message": "Hello from Burki!"
    }
    ```
  </Accordion>

  <Accordion title="Get Wallet Balance">
    ```bash theme={null}
    GET /v1/billing/wallet
    ```
  </Accordion>
</AccordionGroup>

For the complete API reference, see [API Reference](/api-reference/introduction).

Billing endpoints use the `/v1/billing` prefix. Assistant and call management endpoints use `/api/v1/...`, while outbound SMS uses `/sms/send`.

***

## User Roles

### Admin

* Set up organization and billing
* Invite and manage team members
* Configure all assistants
* Access all analytics and reports

### Member

* Create and manage assigned assistants
* View call history and transcripts
* Configure phone numbers

### Viewer

* View dashboards and analytics
* Listen to call recordings
* Read transcripts

***

## Live Monitoring

### Live Transcript

Watch calls in real-time:

1. Go to **Calls** → **Live**
2. Select an active call
3. See transcript updates as they happen

### Analytics Dashboard

Monitor key metrics:

* **Total calls** (today, this week, this month)
* **Average call duration**
* **Success rate**
* **Cost breakdown**

***

## Next Steps

<CardGroup cols={2}>
  <Card title="Configuration" icon="gear" href="/configuration">
    Detailed configuration options
  </Card>

  <Card title="API Reference" icon="code" href="/api-reference/introduction">
    Full API documentation
  </Card>
</CardGroup>
