Skip to main content
The Charley API is a RESTful HTTP API that powers the dashboard. You can use it to build custom integrations, automate device management, or pull analytics into your own systems.

Base URL

All endpoints are prefixed with /api. Example: https://dash.charlemagnelabs.ai/api/devices.

Authentication

The API uses Bearer token authentication with Auth0-issued JWTs.
To obtain a token programmatically, use the Auth0 Client Credentials flow with your organization’s API audience.
Tokens are short-lived (typically 24 hours). Your application should handle token refresh automatically.

Response Format

All responses return JSON. Successful responses return a 2xx status code. Error responses include a message field:

Common Status Codes

Rate Limiting

The API does not currently enforce rate limits, but we recommend no more than 60 requests per minute per organization for polling use cases.

Versioning

The API is currently unversioned. Breaking changes will be communicated in advance via email and the changelog.