Quickstart
Send your first customer message in five minutes.
Authentication
Create an API key and learn what each scope allows.
Core concepts
Customers, conversations and messages, and how they fit together.
API reference
Every endpoint, with parameters, responses and examples.
What you can do
Register your customers
Register your customers
Create a customer once with your own user id. Sending the same customer again is safe: you get the existing one back.
Start and continue conversations
Start and continue conversations
Start a conversation with the customer’s first message, then add more messages as they write.
Read the replies
Read the replies
List the messages in a conversation to show your team’s and your AI agent’s replies in your own app.
Close and reopen
Close and reopen
Close a conversation when it is resolved, or reopen it.
Honour data-protection requests
Honour data-protection requests
Erase a customer’s personal data on request.
The shape of the API
Every successful response has the same envelope:
data holds the result. meta is present on lists and describes the page.
The API is for your servers. Never put an API key in a mobile app or in browser code.