Base URL
All API requests are made over HTTPS to the following base URL:Quick Example
The following request retrieves your most recent leads usingcurl. Replace YOUR_API_KEY with the key generated in your dashboard.
Request Format
All request and response bodies use JSON. When sending data inPOST or PATCH requests, include the Content-Type: application/json header so the API can parse the request body correctly.
GET and DELETE requests do not require a Content-Type header.
Available Resources
Leads
Create, retrieve, update, and delete lead records. Filter by status, channel, score, and more.
Conversations
Access the full message history for any lead across all channels — WhatsApp, email, calls, and web forms.
Agents
List and configure your AI agents, including language, tone, escalation rules, and active channels.
Webhooks
Subscribe to real-time events such as new leads, status changes, and conversation milestones.
Rate Limits
The API allows up to 1,000 requests per minute per API key. If you exceed this limit, the API returns a429 Too Many Requests response.
Every response includes two headers to help you track your current usage:
When your integration receives a
429 response, wait until X-RateLimit-Reset before retrying, or implement exponential backoff. See the Errors reference for full details on 429 handling.
Next Steps
- Authentication — learn how to generate and send your API key
- Errors — understand status codes, error shapes, and retry strategies