API Reference Overview

Estimated reading time: 10 minutes

The clariBI API lets you programmatically access your data sources, dashboards, reports, and analytics. This page covers the basics you need to get started.

Base URL

https://claribi.com/api/

All API endpoints are relative to this base URL.

Authentication

Two authentication methods are supported:

JWT Tokens

Obtain a token by posting credentials to /api/auth/login/. Include the token in subsequent requests:

Authorization: Bearer eyJ0eXAiOiJKV1Qi...

JWT tokens expire after 1 hour. Use the refresh token (valid 7 days) to get a new access token without re-authenticating.

API Keys

Generate API keys from Settings > Developer > API Keys. Include in requests as:

X-API-Key: claribi_key_abc123...

API keys can be set to expire after 30 days, 90 days, or 1 year, or configured to never expire. They can be revoked at any time. Keys inherit the permissions of the user who created them.

See Authentication for full details.

Rate Limits

API rate limits are determined by your subscription tier. See the Developer Portal (Settings > Developer) for the most current limits for your plan.

Rate limit headers are included in every response: X-RateLimit-Remaining, X-RateLimit-Reset.

Response Format

All responses are JSON. Successful responses return HTTP 200-201. Errors return 4xx/5xx with a JSON body:

{
  "error": "not_found",
  "message": "Report with ID 42 not found",
  "status": 404
}

Key Endpoints

The external API uses the /api/v1/ prefix. Key endpoints include:

Endpoint	Description
`GET /api/v1/reports`	List all reports
`GET /api/v1/reports/{id}`	Get report details
`POST /api/v1/reports/{id}/generate`	Generate report with AI analysis
`GET /api/v1/reports/{id}/download`	Download report file
`GET /api/v1/dashboards`	List all dashboards
`GET /api/v1/dashboards/{id}`	Get dashboard details with widgets
`POST /api/v1/dashboards/{id}/refresh`	Refresh dashboard data
`GET /api/v1/data-sources`	List all active data sources
`GET /api/v1/data-sources/{id}`	Get data source details

For full endpoint documentation with examples, visit the Developer Portal in Settings > Developer.

Pagination

List endpoints return paginated results with page and page_size query parameters. Default page size is 20, maximum is 100.

GET /api/reports/?page=2&page_size=50

Next Steps

Ready to try clariBI?

Start your free 14-day trial. No credit card required.

Start Free Trial View Pricing