Gerar resposta sem enviar
POST /chatbot/agents/reply
Gera a resposta que o agente daria, sem enviar nem gravar nada. Funciona com a IA desligada e sem gatilho. Mande um destes três:
message_id: responde a uma mensagem que chegou, peloidque veio emmessage.received. A api acha a conversa e trata a mensagem como a nova, mesmo que ela ainda não tenha sido gravada. Serve para n8n e outros sistemas que recebem o webhook e pedem a resposta na hora.chat_id: responde à conversa como ela está agora, para sugerir ao atendente.messages: uma conversa de teste digitada, para testar o agente sem outro celular.
Com message_id ou chat_id, o agente lê a conversa pelas regras dele (janela de horas, mínimo e máximo de mensagens, memória zerada) ou as últimas limit mensagens, incluindo as que acabaram de chegar ou sair. Arquivos, menus, chamar_humano e funções que mudam dados (método diferente de GET) não rodam: voltam descritos em preview. Funções GET rodam de verdade.
Com instruction, a equipe orienta a resposta; ela sai só em texto, sem ferramentas.
Autenticação
[
{
"token": []
}
]
{
"token": {
"name": "token",
"type": "apiKey",
"in": "header"
}
}
Corpo da requisição
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AIReplyInput"
},
"examples": {
"mensagem": {
"summary": "Responder a uma mensagem que chegou (n8n, webhook)",
"value": {
"agent_id": "ra1b2c3d4e5f6a7",
"message_id": "3EB0C767D26A1D8B7F3A"
}
},
"conversa": {
"summary": "Sugerir resposta lendo as últimas 20 mensagens",
"value": {
"agent_id": "ra1b2c3d4e5f6a7",
"chat_id": "5511999999999@s.whatsapp.net",
"limit": 20
}
},
"instrucao": {
"summary": "Sugerir resposta com um pedido da equipe",
"value": {
"agent_id": "ra1b2c3d4e5f6a7",
"chat_id": "5511999999999@s.whatsapp.net",
"instruction": "Ofereça 10% de desconto no pagamento à vista."
}
},
"teste": {
"summary": "Conversa de teste digitada",
"value": {
"agent_id": "ra1b2c3d4e5f6a7",
"messages": [
{
"text": "Oi, vocês abrem sábado?"
}
]
}
}
}
}
}
}
Respostas
{
"200": {
"description": "Resposta que o agente daria",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AIReply"
},
"example": {
"replies": [
"Oi! Seu pedido sai hoje à tarde."
],
"handoff": "",
"preview": []
}
}
}
},
"400": {
"description": "`invalid_request`: JSON malformado ou campo desconhecido; ou nenhum ou mais de um entre `message_id`, `chat_id` e `messages`, `limit` junto com `messages`, ou valor fora do permitido. `agent_invalid`: o agente não pôde ser montado com o provedor, modelo e chave dele.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrkesioError"
},
"examples": {
"agent_invalid": {
"summary": "Agente que não monta",
"value": {
"error": "agent_invalid",
"message": "O agente não pôde ser montado com o provedor, modelo e chave dele."
}
},
"corpo_invalido": {
"summary": "JSON malformado",
"value": {
"error": "invalid_request",
"message": "JSON malformado ou campo desconhecido."
}
},
"valor_invalido": {
"summary": "Mais de uma origem",
"value": {
"error": "invalid_request",
"message": "Envie só um entre `message_id`, `chat_id` e `messages`."
}
}
}
}
}
},
"401": {
"description": "Token ausente ou inválido.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrkesioError"
},
"example": {
"error": "unauthorized",
"message": "Token inválido."
}
}
}
},
"404": {
"description": "Agente, conversa (`chat_id`) ou mensagem (`message_id`) não encontrados nesta inbox.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrkesioError"
},
"examples": {
"agent": {
"summary": "Agente",
"value": {
"error": "not_found",
"message": "Agente não encontrado."
}
},
"chat": {
"summary": "Conversa (`chat_id`)",
"value": {
"error": "not_found",
"message": "Conversa não encontrada."
}
},
"message": {
"summary": "Mensagem (`message_id`)",
"value": {
"error": "not_found",
"message": "Mensagem não encontrada."
}
}
}
}
}
},
"409": {
"description": "A inbox ainda não foi conectada ao WhatsApp. Os dados pertencem ao número conectado; conecte a inbox antes (`inbox_not_paired`).",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrkesioError"
},
"example": {
"error": "inbox_not_paired",
"message": "A inbox ainda não foi conectada ao WhatsApp. Os dados pertencem ao número conectado; conecte a inbox antes (`inbox_not_paired`)."
}
}
}
},
"429": {
"$ref": "#/components/responses/RateLimited"
},
"500": {
"description": "Falha inesperada ao gravar ou ler os dados.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrkesioError"
},
"example": {
"error": "internal_error",
"message": "Erro interno; tente de novo."
}
}
}
},
"502": {
"description": "O provedor da IA não respondeu (`ai_failed`): chave errada, modelo que não existe ou fora do ar.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrkesioError"
},
"example": {
"error": "ai_failed",
"message": "chave errada, modelo que não existe ou fora do ar."
}
}
}
}
}
Estado: Disponível
Compatibilidade de canais
| Canal | Compatível | Observação |
|---|---|---|
| WhatsApp (Web) | Sim | |
| WhatsApp (API oficial) | Sim | |
| Sim | ||
| Messenger | Sim | |
| Telegram | Sim |
Eventos que esta rota gera
Nenhum. Esta rota não gera evento no webhook (nem em GET /events): o resultado vem só na resposta.
Antes e depois (uazapi → Orkesio)
Na uazapi: POST /chatbot/agents/{id}/reply.
- Mesmas funções; o id vai no corpo, em
agent_id(antes{id}no caminho); muda o formato: campos emsnake_case, datas em ISO 8601 (_at) e erros em{error, message}. - Campos renomeados:
chatid→chat_id,fromMe→direction(in/out),messageid→message_id.
#/components/schemas/AIReplyInput
{
"type": "object",
"additionalProperties": false,
"description": "Mande um destes: `message_id`, `chat_id` ou `messages`.",
"properties": {
"agent_id": {
"type": "string",
"description": "ID do agente."
},
"message_id": {
"type": "string",
"description": "Mensagem a responder: o `id` dela (como vem em `message.received`). A conversa sai da própria mensagem."
},
"chat_id": {
"type": "string",
"description": "Conversa de verdade (JID, como `5511999999999@s.whatsapp.net`): o agente lê o histórico dela e responde ao ponto em que está."
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"description": "Com `chat_id` ou `message_id`: quantas mensagens da conversa a IA lê, as mais recentes (com `message_id`, as de antes dela). Respeita a memória zerada. Sem ele, valem as regras do agente (janela de horas, mínimo e máximo)."
},
"instruction": {
"type": "string",
"maxLength": 4096,
"description": "Pedido da equipe para esta resposta, como \"ofereça 10% de desconto\" ou \"reescreva o rascunho abaixo melhorando o tom: ...\". Vai para o agente depois da conversa, e a resposta sai só em texto: sem arquivos, menus, `chamar_humano` nem funções (`preview` e `handoff` voltam vazios)."
},
"messages": {
"type": "array",
"maxItems": 50,
"description": "Conversa de teste, em ordem. A última costuma ser do contato.",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"text"
],
"properties": {
"direction": {
"type": "string",
"enum": [
"in",
"out"
],
"default": "in",
"description": "`out`: mensagem do atendimento (o agente ou você); `in` (padrão): do contato."
},
"text": {
"type": "string",
"minLength": 1,
"maxLength": 4096,
"description": "Texto da mensagem (1 a 4.096 caracteres)."
}
}
}
}
},
"required": [
"agent_id"
]
}
#/components/schemas/AIReply
{
"type": "object",
"required": [
"replies",
"handoff",
"preview"
],
"properties": {
"replies": {
"type": "array",
"items": {
"type": "string"
},
"description": "As mensagens que o agente mandaria (já divididas em bolhas). Vazio quando ele só mandaria um menu."
},
"handoff": {
"type": "string",
"description": "Resumo do `chamar_humano`, se o agente passaria a conversa para uma pessoa; vazio se não."
},
"preview": {
"type": "array",
"items": {
"type": "string"
},
"description": "O que teria saído além do texto: menu, mensagem cadastrada, função que muda dados, chamar humano."
}
}
}
#/components/schemas/OrkesioError
{
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Código estável do erro, em inglês e `snake_case`. Os de uso geral: `invalid_request` (400): pedido inválido: JSON malformado, campo desconhecido ou valor fora do permitido (o detalhe em `message`; o campo em `field`, quando é um só); `unauthorized` (401): `token` ou `admintoken` ausente ou inválido; `forbidden` (403): o token não pode fazer isso (no servidor de demonstração, por exemplo); `not_admin` (403): o WhatsApp recusou por falta de permissão no grupo ou na newsletter; `account_restricted` (403): o WhatsApp restringiu a conta de iniciar conversas novas (mandar para quem já conversa continua valendo; até quando, em `GET /inbox/limits`); `new_chat_limit` (403): a conta atingiu a cota do WhatsApp de conversas novas neste ciclo (veja `GET /inbox/limits`); os dois também no `error` de `OrkesioMessage` e de `message.status`, e não adianta repetir o envio; `payment_required` (403): na API oficial, a Meta recusou o envio por um problema no pagamento da conta do WhatsApp Business (erro 131042 da Meta); acerte a forma de pagamento no gerenciador da Meta, porque repetir não adianta; também no `error` de `OrkesioMessage` e de `message.status`; `whatsapp_rejected` (400): o WhatsApp recusou a mudança pedida (o campo, em `field`, quando é um só); `not_found` (404): o recurso não existe nesta inbox; `conflict` (409): o recurso já existe ou mudou (id em uso, inbox de outro canal); `inbox_not_paired` (409): a inbox ainda não conectou um número; `payload_too_large` (413): o corpo passou do limite; `canceled` e `expired`: só no `error` de `OrkesioMessage` e de `message.status` (envio cancelado antes de sair, ou que passou do prazo na fila); `rate_limited` (429): muitos pedidos; espere o `Retry-After`; `internal_error` (500): falha inesperada na api; tente de novo; `send_failed` (500): o envio falhou (o motivo em `message`); também no `error` de `OrkesioMessage` e de `message.status`; `unsupported_for_channel` (501): o canal da inbox não atende esta rota ou este tipo de mensagem; `meta_error` (502): a Meta recusou ou não respondeu; `disconnected` (503): a inbox está desconectada (sem sessão do WhatsApp, ou token do canal oficial vencido); `unavailable` (503 ou 504): o WhatsApp não respondeu a tempo, ou algo em andamento impede agora; tente de novo. Cada rota lista os códigos próprios dela (`outside_window`, `number_invalid`, `flow_invalid`...). A lista pode crescer: trate código desconhecido pelo status HTTP."
},
"message": {
"type": "string",
"description": "Descrição para pessoas (às vezes o texto do WhatsApp ou da Meta). Não compare o texto: use `error`."
},
"field": {
"type": "string",
"description": "O campo do pedido que causou o erro, quando é um só (por exemplo, o campo que o WhatsApp recusou num `PATCH`)."
}
},
"required": [
"error",
"message"
],
"additionalProperties": true,
"description": "O objeto de erro da Orkesio, o mesmo em todo lugar: o corpo das respostas de erro e o `error` de `OrkesioMessage`, `message.status` e `message.failed`. Algumas rotas juntam campos próprios (`request_id`, `errors`...)."
}
#/components/responses/RateLimited
{
"description": "`rate_limited`: passou do limite de chamadas desta inbox (ou do admin); espere o tempo do header `Retry-After` e tente de novo.",
"headers": {
"Retry-After": {
"description": "Segundos até poder chamar de novo.",
"schema": {
"type": "integer",
"minimum": 1
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrkesioError"
},
"example": {
"error": "rate_limited",
"message": "Muitas requisições."
}
}
}
}
Guias relacionados
Visão geral · O que funciona em cada canal · O que muda da uazapi