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

# Introduction

> Call24x7.AI API reference documentation

## Welcome to the Call24x7.AI API

The Call24x7.AI API enables you to make AI-powered phone calls programmatically. Use our REST API to initiate outbound calls, handle inbound calls, and manage your AI agents.

## Base URL

All API requests should be made to:

```
https://api.call24x7.ai
```

## Authentication

All API endpoints require authentication using an API key. Include your API key in the `Authorization` header as a Bearer token:

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

<Info>
  Get your API key from the [Call24x7.AI Developer Portal](https://manage.call24x7.ai).
</Info>

### Example Request

```bash theme={null}
curl -X POST https://api.call24x7.ai/outbound_call \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "to_phone_number": "+1234567890",
    "agent_id": "your-agent-id"
  }'
```

## API Endpoints

The Call24x7.AI API provides the following main endpoints:

<CardGroup cols={2}>
  <Card title="Make Outbound Call" icon="phone" href="/api-reference/endpoint/create">
    Initiate an outbound phone call using an AI agent (POST)
  </Card>

  <Card title="Get Call Status" icon="info-circle" href="/api-reference/endpoint/get">
    Retrieve the status of an existing call (GET)
  </Card>

  <Card title="Handle Inbound Call" icon="phone-incoming" href="/api-reference/endpoint/delete">
    Process incoming calls from Twilio (POST)
  </Card>
</CardGroup>

## Response Format

All API responses are returned in JSON format. Successful responses include a `success: true` field, while errors include `success: false` along with an error message and error code.

### Success Response Example

```json theme={null}
{
  "success": true,
  "call_id": "12345",
  "status": "RINGING",
  "message": "Call initiated successfully"
}
```

### Error Response Example

```json theme={null}
{
  "success": false,
  "message": "Missing required parameter: to_phone_number",
  "error_code": "MISSING_PARAMS"
}
```

## Error Codes

The API uses the following error codes:

| Error Code             | Description                           |
| ---------------------- | ------------------------------------- |
| `MISSING_PARAMS`       | Required parameters are missing       |
| `UNAUTHORIZED`         | Invalid or missing API key            |
| `INSUFFICIENT_BALANCE` | Account has insufficient balance      |
| `AGENT_NOT_FOUND`      | The specified agent ID does not exist |
| `CALL_NOT_FOUND`       | The specified call ID does not exist  |
| `INTERNAL_ERROR`       | An internal server error occurred     |

## Rate Limits

API requests are subject to rate limiting. If you exceed the rate limit, you'll receive a `429 Too Many Requests` response.

## Webhooks

You can configure webhooks to receive notifications when calls complete. Include a `webhook_url` parameter in your call requests to receive call completion events.

<Card title="OpenAPI Specification" icon="file-code" href="https://github.com/call24x7/docs/blob/main/api-reference/openapi.json">
  View the complete OpenAPI specification
</Card>
