API Reference

Welcome to the Brilo API documentation. This guide will help you integrate with our API to manage calls and contacts.

Authentication

All API requests require authentication using an API key. You can include your API key in the request headers:

Authorization: Bearer YOUR_API_KEY

To get an API key, visit the Developer Settings in your Brilo dashboard.

All API requests should be made to:

https://api.brilo.ai/v1

Our API is versioned. The current version is 2025-03-02. Include the version in your request headers:

X-API-Version: 2025-03-02

API requests are limited to 100 requests per minute per API key. If you exceed this limit, you’ll receive a 429 Too Many Requests response.

The API uses standard HTTP response codes:

Error responses include a message explaining what went wrong:

{
  "message": "Error description",
  "statusCode": 400
}

List endpoints support pagination using the following query parameters:

The response includes metadata about the pagination:

{
  "data": [...],
  "totalRecords": 100,
  "currentPage": 1
}