API reference
210 operations across 25 resources, generated from the server's own OpenAPI document.
Resources
AI Agents
AI agents: configuration, publishing, testing
19 operations
Analytics
Metrics and reports
4 operations
Appointments
Calendar and appointments
4 operations
Billing
Plans, subscription and billing
13 operations
Bots
Compatibility: legacy AI agent paths
21 operations
Catalog
Product and service catalog
4 operations
Channels
WhatsApp channels
12 operations
Contatos
Workspace contacts
6 operations
Conversations
Conversations and messages
25 operations
CRM
Pipeline, cards and stages
17 operations
Dashboard
Home screen summaries
4 operations
Developers
Outbound webhooks, deliveries and logs
12 operations
Flows
Conversation flows
7 operations
Integrations
Native integrations and event → action bindings
10 operations
Knowledge
Knowledge sources
6 operations
Knowledge Bases
Knowledge bases
6 operations
Leads
Lead capture
6 operations
Marketing Campaigns
Campaigns and broadcasts
11 operations
Meta
Meta integration
2 operations
Meta Catalogs
Meta catalogs
7 operations
Orders
Orders
7 operations
Payments
Standalone charges and payment status
1 operation
Settings
Workspace and team settings
5 operations
WhatsApp Flows
Native WhatsApp Flows
1 operation
WhatsApp Templates
Approved message templates
8 operations
Machine-readable
The full contract is at /openapi.json (OpenAPI 3.1), generated from the running server. Every operation declares its required scope as x-required-scope, taken from the same authorization table the server enforces at request time. The document itself is published in a single language.