API Overview - ChatbotX Documentation

Authentication

You can authenticate with the ChatbotX API using API keys:

Workspace API Key

Get your workspace API key from Settings > Integrations > ChatbotX API Access Token. Include it in the Authorization header as a Bearer token:

curl -H "Authorization: Bearer your-api-key" https://app.chatbotx.io/api/v1/workspace/settings

Channel API Token

For channel-specific operations and webhook verification, use the dedicated channel API token configured under your channel settings.

Base URL

Environment	Base URL
ChatbotX Cloud	`https://app.chatbotx.io/api`
Self-hosted	`https://{YOUR_DOMAIN}/api`

Rate Limits

10,000 requests per minute limit applies to all endpoints.This doesn’t mean you can only post 10,000 times per minute, each API call counts as one request. Schedule multiple posts in a single request to maximize throughput.

Key Resource Groups

The ChatbotX Public API provides 390+ endpoints across 60+ resource categories:

Resource Group	Description
Connections	Unified Connection Engine (`/v1/connections`, `/v1/connect-sessions`) for channel and third-party integrations.
Mini Apps	Create, validate, and publish Mini Apps and WhatsApp Flows (`/v1/mini-apps`).
Channels & CAPI	Omnichannel configuration, Meta Conversions API (CAPI) datasets, coexist sync, and call settings for Messenger, WhatsApp, Instagram, TikTok, and Zalo.
AI Agents & Handover	Manage AI agents, knowledge bases, functions, MCP servers, and live handover settings (`/v1/inboxes/{inboxId}/ai-handover`).
Broadcasts & Sequences	Recurring broadcasts, audience previews (`/v1/broadcasts/audience/preview`), and sequence drip campaigns.
Contacts & Inboxes	Full contact CRUD, bulk sequence/tag operations, import/export jobs, and thread controls.
Products & Meta Catalog	Product catalog management, import pipelines, and direct Meta Catalog synchronization (`/v1/products/meta-catalog`).
Coupons	Coupon batch imports, CSV exports, and contact coupon redemption tracking (`/v1/coupon-imports`, `/v1/coupon-exports`).
Ref Links	Referral links, QR code generation, and embeddable chat widgets (`/v1/ref-links/{id}/chat-widget`).
Comment Automation	Post pickers, live comment automations, and analytics for Facebook, Instagram, Threads, and TikTok.
WhatsApp Calling	Call history, audio recording links, and AI-generated call summaries and transcripts (`/v1/whatsapp/calls`).
Google Ads	Offline conversion tracking, event streaming, and performance statistics (`/v1/google-ads`).

Browse the complete interactive API specifications and test endpoints directly under Application APIs in the sidebar.

​Authentication

​Workspace API Key

​Channel API Token

​Base URL

​Rate Limits

​Key Resource Groups

Authentication

Workspace API Key

Channel API Token

Base URL

Rate Limits

Key Resource Groups