Endpoints
API channel (AI chat)
Run your AI agent from your own app or website. Turn the channel on under Channels → API first. These routes take an API key only.
Les chemins sont relatifs à l’URL de base. Chaque carte indique la permission requise par l’appel et chaque paramètre, avec son type et ses limites.
/messagesSend a customer message to the AI agent. The agent replies a little later, like in a real DM: to the callback URL set under Channels → API, or poll GET /conversations/:id/messages.
Corps JSON
- messageobligatoirestring
The customer's message.
- conversationIdfacultatifinteger
Continue an API-channel conversation. Omit to start a new one.
- messageIdfacultatifstring
Your ID for this message, used to ignore duplicates.
- externalUserIdfacultatifstring
Your ID for the customer.
- externalUsernamefacultatifstring
The customer's username in your app.
- externalFirstNamefacultatifstring
The customer's first name.
- externalChatIdfacultatifstring
Your chat or thread ID.
- Answers 202 { conversationId, status: "buffering", delivery: "callback" | "polling" }.
- 403 when the API channel is not enabled under Channels → API.
/chatSynchronous one-shot chat: send a message and wait for the AI reply. Answers { conversationId, response, messages }.
Corps JSON
- messageobligatoirestring
The customer's message.
- conversationIdfacultatifinteger
Continue a conversation.
- externalUserIdfacultatifstring
Your ID for the customer.
- externalUsernamefacultatifstring
The customer's username in your app.
- externalFirstNamefacultatifstring
The customer's first name.
- externalChatIdfacultatifstring
Your chat or thread ID.
/agentsReturns the workspace's agent as [{ id, systemPrompt }], or [] before setup.