Carbon Voice API — AI Agent Guide

Documentation & Resources

Full API Docs: https://api.carbonvoice.app/docs
Developer Portal (API keys, OAuth, how-to examples): https://www.developer.carbonvoice.app/
Base URL: https://api.carbonvoice.app
Health check: GET /health

Authentication

Pass one of the following on every request:

Method	How to send
API Key	`x-api-key: <key>` header
OAuth2 Bearer	`Authorization: Bearer <access_token>`
PXToken (session)	`pxtoken: <token>` header

Terminology

Term	Meaning
Workspace	Top-level area grouping people and conversations
Conversation / Channel	A channel of communication — these terms are interchangeable throughout the API (endpoints use both)
Collaborators	People who are part of a conversation or workspace

Core Behavior Rules

Reply to a user using the same Conversation_ID. When a webhook fires for a new message, send your response back to the same channel_id to have it feel like a reply. Set reply_to_message_id to reply as a thread (good practice).

Login to API

To Login, use oAuth flow.

Identify Yourself — whoami