Skip to main content

Base URL

Authentication

Send your dashboard API key as a Bearer token on API operations. GET /health is public, and recording links can also use the call-scoped token embedded in the link.
Create and copy an API key from the Sarj.ai dashboard. The key is shown only once. Choose the permissions your integration needs and an expiration within 12 months (365 days). Both are required; neither has a default. Include calls:read to read calls and calls:write to create, cancel or reschedule calls and create retry policies. Reading call details and recordings requires calls:read. Keys remain limited to their organization and their owner’s current permissions. An expired or revoked key returns 401; a valid key missing the required scope returns 403. Rotate a key by creating a replacement, updating your integration, verifying access, then revoking the old key. API keys cannot create other keys.

Responses and errors

JSON success responses contain data and meta; errors contain error and meta. The generated reference documents each endpoint’s fields and responses. Branch on error.type, not the human-readable message. Retain meta.request_id for support, falling back to the X-Request-ID header when it is null. Follow the quickstart for a first call and the SDK recovery guide for errors, timeouts, and retries. Download OpenAPI.
Last modified on November 10, 2026