Skip to main content

Welcome

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

Reddy API Endpoints

View the OpenAPI specification file with Swagger

Authentication

All API endpoints require authentication using your API key. We support two authentication methods: The preferred method is to include your API key in the Authorization header as a Bearer token:
curl -X GET 'https://app.reddy.io/api/v1/endpoint' \
  -H 'Authorization: Bearer your_api_key_here'

Query Parameter Authentication (Deprecated)

The query parameter method is deprecated and will be removed in a future version. Please migrate to Bearer token authentication.
For backward compatibility, you can still include the API key as a query parameter:
curl -X GET 'https://app.reddy.io/api/v1/endpoint?api_key=your_api_key_here'