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.
Las rutas son relativas a la URL base. Cada tarjeta indica el permiso que necesita la llamada y cada parámetro, con su tipo y sus límites.
/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.
Cuerpo JSON
- messageobligatoriostring
The customer's message.
- conversationIdopcionalinteger
Continue an API-channel conversation. Omit to start a new one.
- messageIdopcionalstring
Your ID for this message, used to ignore duplicates.
- externalUserIdopcionalstring
Your ID for the customer.
- externalUsernameopcionalstring
The customer's username in your app.
- externalFirstNameopcionalstring
The customer's first name.
- externalChatIdopcionalstring
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 }.
Cuerpo JSON
- messageobligatoriostring
The customer's message.
- conversationIdopcionalinteger
Continue a conversation.
- externalUserIdopcionalstring
Your ID for the customer.
- externalUsernameopcionalstring
The customer's username in your app.
- externalFirstNameopcionalstring
The customer's first name.
- externalChatIdopcionalstring
Your chat or thread ID.
/agentsReturns the workspace's agent as [{ id, systemPrompt }], or [] before setup.