Configurar a IA
PATCH /chatbot/settings
Liga ou desliga a automação da inbox e ajusta pausas, avisos à equipe e a chave da OpenAI. Só os campos enviados mudam.
- A automação começa desligada. Ligue com
enabled: truedepois de criar o agente e o gatilho. - A
openai_api_keyé usada no conhecimento, para entender áudio e para responder em áudio. O texto dos agentes usa a chave de cada agente (api_key). - Pausas por chat: a
stop_keywordpausa a IA porstop_minutes, e uma resposta sua enviada à mão pausa porpause_minutes_on_manual_reply.
Autenticação
[
{
"token": []
}
]
{
"token": {
"name": "token",
"type": "apiKey",
"in": "header"
}
}
Corpo da requisição
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AISettingsUpdate"
},
"example": {
"enabled": true,
"ignore_groups": true,
"stop_keyword": "atendente",
"stop_minutes": 60,
"pause_minutes_on_manual_reply": 30
}
}
}
}
Respostas
{
"200": {
"description": "Configuração gravada",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AISettings"
},
"example": {
"enabled": true,
"ignore_groups": true,
"stop_keyword": "#parar",
"stop_minutes": 60,
"pause_minutes_on_manual_reply": 30,
"has_openai_api_key": true,
"notify_number": "5511888888888",
"notify_url": "",
"max_replies_per_hour": 30
}
}
}
},
"400": {
"description": "`invalid_request`: JSON malformado ou campo desconhecido; ou número negativo, `notify_number` sem DDI, `notify_url` que não é http(s), ou `openai_api_key` mascarada ou fora do formato `sk-...`.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrkesioError"
},
"example": {
"error": "invalid_request",
"message": "JSON malformado ou campo desconhecido."
}
}
}
},
"401": {
"description": "Token ausente ou inválido.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrkesioError"
},
"example": {
"error": "unauthorized",
"message": "Token inválido."
}
}
}
},
"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."
}
}
}
}
}
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: PATCH /chatbot/settings.
- Mesmo caminho e mesmas funções; muda o formato: campos em
snake_case, datas em ISO 8601 (_at) e erros em{error, message}.
#/components/schemas/AISettingsUpdate
{
"type": "object",
"description": "Só os campos enviados mudam.",
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean",
"description": "Liga ou desliga toda a automação: agentes, respostas rápidas por gatilho e fluxos. Desligada, `POST /chatbot/flows/start` e o webhook do fluxo respondem `409 chatbot_disabled`. Começa desligada."
},
"ignore_groups": {
"type": "boolean",
"description": "Não responde em grupos."
},
"stop_keyword": {
"type": "string",
"description": "Mensagem que, enviada inteira (sem diferença de maiúsculas) pelo contato ou por você à mão, pausa a IA naquele chat por `stop_minutes` e cancela os fluxos agendados para ele. Vazio desativa."
},
"stop_minutes": {
"type": "integer",
"minimum": 0,
"description": "Por quantos minutos a `stop_keyword` pausa a IA no chat."
},
"pause_minutes_on_manual_reply": {
"type": "integer",
"minimum": 0,
"description": "Quando alguém responde à mão (pelo celular ou WhatsApp Web), a IA pausa naquele chat por esses minutos. Mensagens enviadas pela API, inclusive as da própria IA, não pausam. `0` desativa."
},
"openai_api_key": {
"type": "string",
"writeOnly": true,
"description": "Chave da OpenAI (`sk-...`) usada para o conhecimento (embeddings) e para transcrever áudio. `\"\"` remove a chave. Não aceita a chave mascarada."
},
"notify_number": {
"type": "string",
"description": "Número da equipe (com DDI) que recebe no WhatsApp o aviso de \"chamar humano\" (da IA ou do bloco do fluxo), do limite de respostas e da falha do provedor da IA, enviado pela própria inbox. A conversa com esse número fica fora de toda automação (não pausa, não arma silêncio, não responde). Vazio desliga.",
"example": "5521999990000"
},
"notify_url": {
"type": "string",
"description": "URL que recebe o mesmo aviso por `POST`. Num tópico do ntfy (`https://ntfy.sh/seu-topico`), o aviso chega como notificação no celular; em outra URL, vai o JSON `{event, chatid, name, reason, owner, timestamp}`, com `event` `handoff` (chamaram uma pessoa), `reply_limit` (limite de respostas) ou `ai_error` (o provedor da IA falhou; no máximo um aviso por hora). Vazio desliga.",
"example": "https://ntfy.sh/orkesio-seu-topico"
},
"max_replies_per_hour": {
"type": "integer",
"minimum": 0,
"description": "Máximo de respostas da IA por conversa em uma hora (só conta resposta enviada). Ao passar, a automação daquela conversa (IA, gatilhos e fluxos) pausa por 1 hora, com o motivo em `chatbot_summary` enquanto durar, e a equipe é avisada. Protege de loop entre robôs e de abuso. `0` desliga; o padrão é `20`.",
"example": 20
}
}
}
#/components/schemas/AISettings
{
"type": "object",
"description": "Configuração da IA na inbox.",
"required": [
"enabled",
"ignore_groups",
"stop_keyword",
"stop_minutes",
"pause_minutes_on_manual_reply",
"has_openai_api_key",
"notify_number",
"notify_url",
"max_replies_per_hour"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Liga ou desliga toda a automação: agentes, respostas rápidas por gatilho e fluxos. Desligada, `POST /chatbot/flows/start` e o webhook do fluxo respondem `409 chatbot_disabled`. Começa desligada."
},
"ignore_groups": {
"type": "boolean",
"description": "Não responde em grupos."
},
"stop_keyword": {
"type": "string",
"description": "Mensagem que, enviada inteira (sem diferença de maiúsculas) pelo contato ou por você à mão, pausa a IA naquele chat por `stop_minutes` e cancela os fluxos agendados para ele. Vazio desativa."
},
"stop_minutes": {
"type": "integer",
"minimum": 0,
"description": "Por quantos minutos a `stop_keyword` pausa a IA no chat."
},
"pause_minutes_on_manual_reply": {
"type": "integer",
"minimum": 0,
"description": "Quando alguém responde à mão (pelo celular ou WhatsApp Web), a IA pausa naquele chat por esses minutos. Mensagens enviadas pela API, inclusive as da própria IA, não pausam. `0` desativa."
},
"has_openai_api_key": {
"type": "boolean",
"description": "Se a chave da OpenAI da inbox está configurada. A chave nunca é devolvida."
},
"notify_number": {
"type": "string",
"description": "Número da equipe (com DDI) que recebe no WhatsApp o aviso de \"chamar humano\" (da IA ou do bloco do fluxo), do limite de respostas e da falha do provedor da IA, enviado pela própria inbox. A conversa com esse número fica fora de toda automação (não pausa, não arma silêncio, não responde). Vazio desliga.",
"example": "5521999990000"
},
"notify_url": {
"type": "string",
"description": "URL que recebe o mesmo aviso por `POST`. Num tópico do ntfy (`https://ntfy.sh/seu-topico`), o aviso chega como notificação no celular; em outra URL, vai o JSON `{event, chatid, name, reason, owner, timestamp}`, com `event` `handoff` (chamaram uma pessoa), `reply_limit` (limite de respostas) ou `ai_error` (o provedor da IA falhou; no máximo um aviso por hora). Vazio desliga.",
"example": "https://ntfy.sh/orkesio-seu-topico"
},
"max_replies_per_hour": {
"type": "integer",
"minimum": 0,
"description": "Máximo de respostas da IA por conversa em uma hora (só conta resposta enviada). Ao passar, a automação daquela conversa (IA, gatilhos e fluxos) pausa por 1 hora, com o motivo em `chatbot_summary` enquanto durar, e a equipe é avisada. Protege de loop entre robôs e de abuso. `0` desliga; o padrão é `20`.",
"example": 20
},
"last_error": {
"type": "object",
"description": "A última falha do provedor da IA (sem crédito, chave inválida, modelo inexistente…), em português. Some quando a IA volta a responder. Ausente sem falha.",
"properties": {
"at": {
"type": "string",
"format": "date-time",
"description": "Quando. ISO 8601 em UTC com milissegundos."
},
"reason": {
"type": "string",
"description": "O motivo, em português.",
"example": "A conta do provedor da IA está sem crédito."
},
"chat_id": {
"type": "string",
"description": "A conversa que ficou sem resposta."
}
},
"required": [
"at",
"reason",
"chat_id"
]
}
}
}
#/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