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

# Introduction

> Reddy API Reference Documentation

## Welcome

The Reddy API provides endpoints for managing live conversations, call events, and miscellaneous operations. This documentation is generated from our OpenAPI specification.

<Card title="Reddy API Endpoints" icon="api" href="https://app.reddy.io/api/v1/docs">
  View the OpenAPI specification file with Swagger
</Card>

## Authentication

All API endpoints require authentication using your API key. We support two authentication methods:

### Bearer Token Authentication (Recommended)

The preferred method is to include your API key in the Authorization header as a Bearer token:

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET 'https://app.reddy.io/api/v1/endpoint' \
    -H 'Authorization: Bearer your_api_key_here'
  ```

  ```javascript JavaScript theme={null}
  fetch('https://app.reddy.io/api/v1/endpoint', {
    headers: {
      'Authorization': 'Bearer your_api_key_here'
    }
  });
  ```

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

  headers = {
      'Authorization': 'Bearer your_api_key_here'
  }
  response = requests.get('https://app.reddy.io/api/v1/endpoint', headers=headers)
  ```
</CodeGroup>

### Query Parameter Authentication (Deprecated)

<Warning>
  The query parameter method is deprecated and will be removed in a future version. Please migrate to Bearer token authentication.
</Warning>

For backward compatibility, you can still include the API key as a query parameter:

```bash theme={null}
curl -X GET 'https://app.reddy.io/api/v1/endpoint?api_key=your_api_key_here'
```
