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.
Pfade sind relativ zur Basis-URL. Jede Karte zeigt die Berechtigung, die der Aufruf braucht, und jeden Parameter mit Typ und Grenzen.
/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.
JSON-Body
- messageerforderlichstring
The customer's message.
- conversationIdoptionalinteger
Continue an API-channel conversation. Omit to start a new one.
- messageIdoptionalstring
Your ID for this message, used to ignore duplicates.
- externalUserIdoptionalstring
Your ID for the customer.
- externalUsernameoptionalstring
The customer's username in your app.
- externalFirstNameoptionalstring
The customer's first name.
- externalChatIdoptionalstring
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 }.
JSON-Body
- messageerforderlichstring
The customer's message.
- conversationIdoptionalinteger
Continue a conversation.
- externalUserIdoptionalstring
Your ID for the customer.
- externalUsernameoptionalstring
The customer's username in your app.
- externalFirstNameoptionalstring
The customer's first name.
- externalChatIdoptionalstring
Your chat or thread ID.
/agentsReturns the workspace's agent as [{ id, systemPrompt }], or [] before setup.