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

# Introduction

> AI Agents Documentation

## Welcome to timepay.ai

timepay.ai is an AI-powered voice agent platform designed for high-volume outbound calling campaigns. Our platform enables businesses to automate customer interactions with human-like AI agents that can handle collections, lead generation, surveys, and more.

<CardGroup cols={2}>
  <Card title="Quick Start" icon="rocket" href="/quickstart">
    Get up and running with timepay.ai in minutes
  </Card>

  <Card title="API Reference" icon="code" href="/api-reference">
    Explore our REST API endpoints
  </Card>

  <Card title="AI Agents" icon="robot" href="/api-reference/agents/overview">
    Create and manage voice agents
  </Card>

  <Card title="Campaigns" icon="bullhorn" href="/api-reference/agents/agents/list">
    Launch outbound calling campaigns
  </Card>
</CardGroup>

## Why timepay.ai?

<CardGroup cols={3}>
  <Card title="Multi-Language Support" icon="language">
    15+ Indian languages including Hindi, Tamil, Telugu, Kannada, and more
  </Card>

  <Card title="Emotional TTS" icon="face-smile">
    Vox-v1 engine with 15+ emotions for natural conversations
  </Card>

  <Card title="Low Latency" icon="bolt">
    Sub-100ms response time for real-time conversations
  </Card>

  <Card title="High Scale" icon="chart-line">
    Handle 1,000+ concurrent calls with enterprise-grade infrastructure
  </Card>

  <Card title="Smart Dispositions" icon="tags">
    Automatic call classification and follow-up actions
  </Card>

  <Card title="BFSI Ready" icon="building-columns">
    Built for banking, finance, and insurance compliance
  </Card>
</CardGroup>

## Core Components

<AccordionGroup>
  <Accordion title="AI Agents" icon="robot">
    AI Agents are the voice assistants that handle your calls. Each agent has:

    * **Prompt**: System instructions defining behavior and personality
    * **Initiator Message**: Opening greeting when call connects
    * **Tools**: Actions like transfer calls, send SMS, or end call

    [Learn more →](/api-reference/agents/overview)
  </Accordion>

  <Accordion title="Campaigns" icon="bullhorn">
    Campaigns manage your outbound calling operations:

    * **Customer Data**: Upload lists with customer information
    * **Scheduling**: Set start/end dates and calling windows
    * **Workflow**: Define call flow and retry logic

    [Learn more →](/api-reference/campaigns/overview)
  </Accordion>

  <Accordion title="Dispositions" icon="tags">
    Dispositions classify call outcomes for follow-up actions:

    * **Contact Types**: Track successful contacts vs. no-answers
    * **Priority System**: Rank outcomes by importance
    * **Groups**: Organize dispositions for automated actions

    [Learn more →](/api-reference/dispositions/overview)
  </Accordion>

  <Accordion title="Customer Data" icon="users">
    Manage customer records within campaigns:

    * **Bulk Upload**: Import thousands of records via API
    * **Real-time Updates**: Modify customer data on the fly
    * **Validation**: Automatic data type and format checking

    [Learn more →](/api-reference/customer-data/overview)
  </Accordion>
</AccordionGroup>

## Base URL

All API requests should be made to:
[https://api.agents.timepay.ai/api/v1](https://api.agents.timepay.ai/api/v1)

## Authentication

timepay.ai uses Bearer token authentication. Include your API key in the `Authorization` header:

```bash theme={null}
curl -X GET "https://api.agents.timepay.ai/api/v1/agents" \
  -H "Authorization: Bearer YOUR_API_KEY"
```

<Warning>
  Keep your API keys secure. Never expose them in client-side code or public repositories.
</Warning>

To obtain an API key:

1. Log in to the [timepay.ai](https://console.timepay.ai)
2. Navigate to **API Keys**
3. Click **Generate New Key**
4. Copy and store your key securely

## Quick Example

Here's a quick example to list all your AI agents:

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET "https://api.agents.timepay.ai/api/v1/agents" \
    -H "Authorization: Bearer YOUR_API_KEY"
  ```

  ```javascript Node.js theme={null}
  const response = await fetch('https://api.agents.timepay.ai/api/v1/agents', {
    headers: {
      'Authorization': 'Bearer YOUR_API_KEY'
    }
  });

  const { data: agents } = await response.json();
  console.log(agents);
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://api.agents.timepay.ai/api/v1/agents',
      headers={'Authorization': 'Bearer YOUR_API_KEY'}
  )

  agents = response.json()['data']
  print(agents)
  ```
</CodeGroup>

## Response Format

All API responses follow a consistent format:

### Success Response

```json theme={null}
{
  "success": true,
  "message": "Operation completed successfully",
  "data": { ... },
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 100,
    "totalPages": 10
  }
}
```

### Error Response

```json theme={null}
{
  "success": false,
  "error": "Error Type",
  "message": "Human-readable error message",
  "errors": [
    "Detailed error 1",
    "Detailed error 2"
  ]
}
```

## HTTP Status Codes

| Code  | Description                                       |
| ----- | ------------------------------------------------- |
| `200` | Success                                           |
| `201` | Created                                           |
| `207` | Multi-status (partial success in bulk operations) |
| `400` | Bad Request - Validation error                    |
| `401` | Unauthorized - Invalid API key                    |
| `403` | Forbidden - Access denied                         |
| `404` | Not Found - Resource doesn't exist                |
| `409` | Conflict - Duplicate resource                     |
| `429` | Too Many Requests - Rate limited                  |
| `500` | Internal Server Error                             |

## Supported Languages

timepay.ai supports 10+ Indian languages:

<CardGroup cols={4}>
  <Card title="Hindi" icon="check" />

  <Card title="English" icon="check" />

  <Card title="Tamil" icon="check" />

  <Card title="Telugu" icon="check" />

  <Card title="Kannada" icon="check" />

  <Card title="Malayalam" icon="check" />

  <Card title="Marathi" icon="check" />

  <Card title="Bengali" icon="check" />

  <Card title="Gujarati" icon="check" />

  <Card title="Punjabi" icon="check" />

  <Card title="Odia" icon="check" />

  <Card title="Assamese" icon="check" />
</CardGroup>

## Webhooks

timepay.ai can send real-time notifications to your server for events like:

* Call
* WhatsApp
* SMS

[Learn more about webhooks →](/agents/webhook)

## Need Help?

<CardGroup cols={3}>
  <Card title="Documentation" icon="book" href="/api-reference">
    Browse the full API reference
  </Card>

  <Card title="Support" icon="headset" href="mailto:support@timepay.ai">
    Contact our support team
  </Card>
</CardGroup>