Skip to main content
Account and organization endpoints live under /api/v1. Other API families keep their documented prefixes, such as billing under /v1/billing, learning under /api/learning, SMS under /sms, and carrier webhooks at root webhook paths.
Most endpoints accept API key, JWT bearer token, or dashboard session auth. Some sensitive endpoints require a verified user or organization admin.
Several organization endpoints accept or return secrets such as provider API keys, SIP credentials, carrier credentials, or one-time user API keys. Treat full responses as sensitive and avoid logging them.

Current User

Get Current User

Returns the authenticated user profile.

Update Current User

Request

Change Password

Request
OAuth users can set their first password with an empty current_password.

Organization Users and Invitations

List Users

Returns users in the current organization.

Invite User

Admin only.
Request

Validate Invitation

This endpoint is public. The invitation token acts as bearer access to the invitation metadata.

Accept Invitation

Request
The response includes an access token. Store it like any other JWT.

Organization

Get Organization

The organization response can include stored provider credentials and API key configuration. Do not log full responses.

Create Organization

Request
Trial credits are provisioned only for the user’s first eligible organization.

Update Organization

Admin only. Supports organization metadata, settings, provider keys, carrier credentials, Vonage settings, and SIP trunk config.
Request
If HIPAA/BAA requirements block BYO activation, the backend may save keys but prevent activation until compliance requirements are met.

Validate Twilio Credentials

Admin only. Sends raw Twilio credentials for validation.
Request

User API Keys

List API Keys

Returns key metadata only, including key_prefix, never the full secret.

Create API Key

Requires a verified user account.
Request
Response
The key field is shown only once. Store it immediately and never commit it to source control.

Update or Delete API Key

Both require a verified user account.

LLM Presets

List responses mask stored API keys. The apply endpoint is admin-only and can return an unmasked stored API key when the preset includes one.

Configuration Status

Returns organization provider configuration health and readiness status.

Fallback Keys

GET returns metadata only. POST and PUT accept provider secrets.
Request
For updates, api_key changes only when a non-empty value is provided.

Concurrency Settings

Admin only. Controls provider concurrency for TTS/STT.
Request