Developer Portal
How-to guides

How to Authenticate

Pass one of the following on every request to the Carbon Voice API.

MethodHow to send
Personal Access TokenAuthorization: Bearer cv_pat_<token>
OAuth2 BearerAuthorization: Bearer <access_token>
API Keyx-api-key: <key> header
PXToken (session)pxtoken: <token> header

Personal access tokens: The recommended method for integrations and bots. Create and manage tokens in the Developer Portal. Tokens have a cv_pat_ prefix, support read/write scopes, and can be revoked at any time.

OAuth2: Use the standard OAuth2 PKCE flow for apps acting on behalf of a user. The Developer Portal provides client ID, redirect URI configuration, and how-to examples.

API Key: Legacy method for server-to-server access. Manage keys in the Developer Portal.

How to Authenticate | Carbon Voice Developer Portal