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

# Vapi.ai

## Overview

AwaazAI provides a managed telephony platform that connects your Vapi AI voice agents to real phone calls. We handle all the telephony infrastructure, audio processing, and connectivity - you just need to provide your Vapi credentials.

**Key Benefits:**

* No telephony infrastructure to manage
* Use Indian phone numbers for compliance and local reach
* Real-time, low-latency audio streaming to Vapi
* Automatic audio format conversion and optimization
* Production-ready reliability and error handling

***

## Requirements

To use this service, you need:

### 1. Vapi Account

* An active account at [vapi.ai](https://vapi.ai)
* One or more configured Vapi assistants
* Your Vapi API key (found in your Vapi dashboard)

### 2. AwaazAI Account

* Contact our sales team to set up your account
* We'll provision Indian phone numbers for your use
* With the help of AwaazAI team, create assistant specific template. The template needs to be configured with assistant parameters.

### 3. Information to Provide

* For each assistant, you'll need to provide us:

| Parameter                      | Description                               | Required | Example                                         |
| ------------------------------ | ----------------------------------------- | -------- | ----------------------------------------------- |
| **Vapi Assistant ID**          | The unique ID of your Vapi assistant      | Yes      | `7420f27a-30fd-4f49-a995-5549ae7cc00d`          |
| **Vapi API Key**               | Your Vapi API authentication key          | Yes      | `sk_live_xxxxx...`                              |
| **Custom Metadata** (optional) | Additional data to pass to your assistant | No       | `{"customer_name": "Ravi", "priority": "high"}` |

***

## How It Works

Here's what happens when we make a call on your behalf:

```
┌─────────────┐        ┌──────────────┐        ┌─────────────┐
│   End User  │ ◄────► │   AwaazAI    │ ◄────► │  Vapi AI    │
│   (Phone)   │ Voice  │  Telephony   │   API  │  Assistant  │
└─────────────┘        └──────────────┘        └─────────────┘
```

### Step-by-Step Flow

**Template Setup**

* You share your Vapi Assistant ID and API key with AwaazAI team
* We will configure template with assistant parameters

**Call Initiation**

* Upload contact numbers and create messages using configured template
* AwaazAI scheduler places the call using your assigned Indian phone number
* When the recipient answers, we immediately establish a connection to Vapi
* Your Vapi assistant receives the call via Vapi's standard API

**Conversation**

* Audio flows in real-time between the caller and your Vapi assistant
* All audio processing, transcription, and AI responses are handled by Vapi
* We maintain low-latency audio transmission

**Call Completion**

* When the call ends (by either party), we gracefully disconnect
* Your assistant receives a standard Vapi call completion event

***

## Configuration Guide

### Finding Your Vapi Credentials

**Vapi Assistant ID:**

1. Log in to [vapi.ai](https://vapi.ai)
2. Navigate to "Assistants" in the dashboard
3. Click on the assistant you want to use
4. Copy the Assistant ID from the URL or settings page
   * Format: `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`

**Vapi API Key:**

1. In your Vapi dashboard, go to "Settings" → "API Keys"
2. Create a new API key or copy an existing one
3. Store it securely - you'll need to provide this to AwaazAI
   * Format: `sk_live_...` or `sk_test_...`

***

## Audio Technical Specifications

For reference, here are the audio specifications we use (handled automatically - no action needed):

* **Format:** μ-law (PCMU) / 16-bit PCM
* **Sample Rate:** 8 kHz (standard telephony quality)
* **Encoding:** Base64 when transmitted via WebSocket
* **Latency:** Optimized for low round-trip latency
* **Channels:** Mono (single channel)

We handle all audio conversion automatically - your Vapi assistant receives audio in the standard format expected by Vapi's API.

***

## Support & Resources

### AwaazAI Support

* Email: [info@awaaz.ai](mailto:info@awaaz.ai)

### Vapi Resources

* Dashboard: [vapi.ai](https://vapi.ai)
* Documentation: [docs.vapi.ai](https://docs.vapi.ai)
* API Reference: [Vapi API Docs](https://docs.vapi.ai/api-reference)

***

## Frequently Asked Questions

**Q: Do I need to modify my Vapi assistant for AwaazAI?**\
A: No, your existing Vapi assistants work without modification. We connect to Vapi's standard API.

**Q: Can I use the same assistant for multiple templates?**\
A: Yes, you can reuse the same Vapi Assistant ID across multiple AwaazAI campaigns.

**Q: What happens if my Vapi API key expires?**\
A: Calls will fail to connect. Provide your updated API key immediately to resume service.

***

## Getting Started Checklist

* Create your Vapi assistant at vapi.ai
* Test your assistant in Vapi's playground
* Get your Vapi Assistant ID
* Get your Vapi API key
* Sign up for AwaazAI account
* Configure template
* Upload sample messages
* Run test calls with sample contacts
* Launch your production campaign

***