Chronox AI is a customer experience platform powered by AI agents. Businesses use it to talk to their customers on WhatsApp, Instagram, Facebook Messenger, Slack and their website: answering questions, qualifying leads, taking orders, and passing the conversation to a person when needed.The Chronox API lets your own software work with the WhatsApp part of Chronox without opening the Chronox dashboard. For example, your website or CRM can send a WhatsApp message to a customer automatically when an order is placed.New to APIs? An API is a way for one piece of software to talk to another. You send a request to a web address (an endpoint), and Chronox sends back a response. Every endpoint in the sidebar has its own page showing exactly what to send and what you get back.
What you can do with the API#
The API covers four areas:| Area | What it lets you do |
|---|
| Account | See the details of your Chronox account and your connected WhatsApp setup. |
| WhatsApp templates | See your message templates, look at one in detail, and create new ones. |
| Messaging | Send a WhatsApp message or a WhatsApp template to a customer. |
| Inbox | Read your conversations and the messages inside each one. |
Everything else in Chronox is managed in the dashboard and can't be done through the API today. That includes AI agents and the knowledge base, voice agents and call campaigns, broadcast and retargeting campaigns, the no-code flow builder, contacts and segments, and the product catalogue and orders.The endpoints listed in the sidebar are the full set available to you. If something isn't listed there, it isn't available through the API.
Where requests are sent#
Every request goes to the same base address:https://api.chronox.ai/api
https://api.chronox.ai/api/user/get-user-detail
Your API key#
Every request must include an API key. The key tells Chronox who is making the request, and it also decides what that request is allowed to do.You add the key to each request as a header, written like this:Authorization: Bearer YOUR_API_KEY
YOUR_API_KEY with your own key. Keep the word Bearer and the space after it exactly as shown.A complete request looks like this. If you're comfortable with a terminal, you can paste it in and run it:A few things to know about keys:You create keys in the Chronox dashboard. The Authentication page shows exactly where. The key is shown only once, when you create it. Copy it somewhere safe straight away; you can't view it again later.
Keys expire. By default a key stops working one year after it's created, and you'll need to create a new one.
You can have up to three active keys at a time.
To replace a key, create a new one, switch your software over to it, then delete the old key. A deleted key stops working immediately. If you already have three keys, delete one before creating a new one.
Treat your API key like a password. Anyone who has it can act on your Chronox account. Don't share it by email or chat, don't put it in website code that visitors can see, and delete it right away if you think someone else has seen it.
To stop the API being overloaded, Chronox limits how many requests a key can make in a short period. If you send too many too quickly, you'll be asked to wait before trying again. See Rate limiting for details. Account#
Get User Details returns the Chronox account your API key belongs to. It's the simplest way to check that your key works, so it's a good first request to try.Get Meta Integration shows the WhatsApp Business account you've connected to Chronox through Meta (the company behind WhatsApp). Check this first if messages aren't sending: nothing can be sent until your WhatsApp account is connected.WhatsApp templates#
A template is a pre-written message that Meta has reviewed and approved, such as an order confirmation or appointment reminder. It can include blanks, such as the customer's name, that are filled in each time you send it. WhatsApp requires you to use an approved template whenever you message a customer who hasn't messaged you recently (see Sending messages below).| Endpoint | What it does |
|---|
| Get Whatsapp Templates | Lists all the templates on your account. |
| Get Whatsapp Template Details | Shows everything about one template. |
| Create Whatsapp Template | Creates a new template and sends it to Meta for approval. |
A template has to follow Meta's rules about what it can contain. To help you fill in Create Whatsapp Template correctly, the endpoints below list the values you're allowed to use for each part of a template:| Endpoint | Lists the allowed… |
|---|
| Get Whatsapp Template Category | Categories, such as marketing or utility |
| Get Whatsapp Languages | Languages |
| Get Whatsapp Template Type | Template types |
| Get Whatsapp Template Interactive Type | Interactive options |
| Get Whatsapp Template Header Type | Header formats, such as text or image |
| Get Whatsapp Template Button Type | Button types |
| Get Whatsapp Template Dynamic Variable Type | Kinds of blanks you can fill in, such as a name |
These lists rarely change. Check them when you're building a template rather than before every request, and use the exact values they return. A template with an invalid value will be rejected, and you'll have to wait for Meta to review it again.
Sending messages#
Send Whatsapp Message sends a normal message to a customer. This can be text, or a file such as an image, document, video, audio clip or sticker.Send Whatsapp Template sends one of your approved templates. Use it to start a new conversation, or to reach a customer when you can no longer send a normal message.WhatsApp's 24-hour rule. You can only send a normal message within 24 hours of the customer's last message to you. After that, WhatsApp will only deliver an approved template. Once the customer replies, you can send normal messages again for another 24 hours. This is Meta's rule for WhatsApp, not a Chronox limit.
Inbox#
Get Inbox Data lists your WhatsApp conversations, and Get Thread Details shows the messages inside one conversation.These endpoints only read conversations. To reply, use the sending endpoints above. Assigning conversations, tagging and ticketing are done in the Chronox dashboard.Before you begin#
1
Connect WhatsApp
You need a Chronox account with your WhatsApp Business account connected. You can check this with Get Meta Integration.
2
Create an API key
Create a key in the Chronox dashboard.
Authentication walks you through it. Copy the key straight away, because it won't be shown again.
3
Test your key
Send the Get User Details request shown above. If you get your account details back, your key works.
4
Get a template approved
If you plan to message customers who haven't contacted you in the last 24 hours, create a template and wait for Meta to approve it before you send anything.
Where to go next#
Quickstart
Make your first request, step by step.
Authentication
Create, use and replace API keys.
Send a template
The most common first task. 