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

# API Reference

> Welcome to the VozAgent API. Programmatically manage your AI voice agents, contacts, calls, and integrations.

The VozAgent API lets you integrate AI-powered voice automation directly into your applications. Manage contacts, trigger outbound calls, configure assistants, and receive real-time webhooks — all through a simple REST API.

## Quick Links

<CardGroup cols={3}>
  <Card title="Contacts" icon="user" color="#1a9e75" href="/developers/api/contacts/list">
    Create, list, update, and delete contacts.
  </Card>

  <Card title="Calls" icon="phone" color="#1a9e75" href="/developers/api/calls/list">
    List calls and trigger outbound calls.
  </Card>

  <Card title="Assistants" icon="robot" color="#1a9e75" href="/developers/api/assistants/list">
    List and retrieve your AI assistants.
  </Card>

  <Card title="Phone Numbers" icon="hashtag" color="#1a9e75" href="/developers/api/phone-numbers/list">
    Manage your phone number inventory.
  </Card>

  <Card title="Webhooks" icon="webhook" color="#1a9e75" href="/developers/api/webhooks/list">
    Real-time event notifications.
  </Card>
</CardGroup>

## Base URL

All API requests should be made to the following base URL:

```
https://api.vozagent.ai/v1
```

## Authentication

The VozAgent API uses API keys to authenticate requests. You can view and manage your API keys in your [VozAgent Dashboard](https://app.vozagent.ai/settings/api).

Include your API key in all requests via the `Authorization` header:

```bash theme={null}
Authorization: Bearer YOUR_API_KEY
```

<Warning>
  **Keep your API key secret!** Do not share your API key in publicly accessible areas such as GitHub, client-side code, or anywhere that could be exposed.
</Warning>

## Rate Limits

The API enforces fair usage limits to maintain service quality for all users. Current limits are generous and apply equally across all plans. If you encounter rate limiting, reduce the frequency of your requests or add delays between calls.

| Plan       | Rate Limit    |
| ---------- | ------------- |
| Essential  | Standard      |
| Growth     | Standard      |
| Advanced   | Standard      |
| Enterprise | Custom limits |

<Note>
  If you need higher throughput for your use case, [contact us](https://vozagent.ai/contact) to discuss Enterprise limits.
</Note>

## Error Handling

VozAgent uses conventional HTTP response codes to indicate the success or failure of an API request.

| Code  | Description                                               |
| ----- | --------------------------------------------------------- |
| `2xx` | Success                                                   |
| `4xx` | Client error (e.g., bad request, unauthorized, not found) |
| `5xx` | Server error (something went wrong on our end)            |

Error responses include a JSON body with details:

```json theme={null}
{
  "error": {
    "code": "invalid_request",
    "message": "The request body is missing required fields",
    "details": {
      "missing_fields": ["phone_number"]
    }
  }
}
```

## API Versioning

The current version of the API is **v1**. The version is included in the URL path.

We strive to make backwards-compatible changes when possible. When breaking changes are necessary, we will release a new API version and provide migration guides.

## Get Started

<CardGroup cols={2}>
  <Card title="List Your Contacts" icon="address-book" color="#1a9e75" href="/developers/api/contacts/list">
    Retrieve your existing contacts to verify your API connection.
  </Card>

  <Card title="Create an Outbound Call" icon="phone-arrow-up-right" color="#1a9e75" href="/developers/api/calls/create">
    Programmatically initiate AI-powered outbound calls.
  </Card>

  <Card title="Set Up Webhooks" icon="bell" color="#1a9e75" href="/developers/api/webhooks/create">
    Receive real-time notifications about call events.
  </Card>

  <Card title="Browse Assistants" icon="robot" color="#1a9e75" href="/developers/api/assistants/list">
    List and inspect your configured AI assistants.
  </Card>
</CardGroup>