Ver agente
GET /chatbot/agents/{agent_id}
Devolve o agente pelo id.
Autenticação
[
{
"token": []
}
]
{
"token": {
"name": "token",
"type": "apiKey",
"in": "header"
}
}
Parâmetros
[
{
"name": "agent_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "ID do agente."
}
]
Respostas
{
"200": {
"description": "Agente",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AIAgent"
},
"example": {
"id": "ra1b2c3d4e5f6a7",
"name": "Atendente da loja",
"provider": "openai",
"model": "gpt-6-luna",
"has_api_key": true,
"base_prompt": "Você atende a Loja Exemplo. Responda curto e em português.",
"temperature": 0.7,
"top_p": 1,
"frequency_penalty": 0,
"presence_penalty": 0,
"sign_messages": false,
"read_messages": true,
"max_message_length": 500,
"typing_delay_seconds": 2,
"context_window_hours": 24,
"context_max_messages": 30,
"context_min_messages": 3,
"created_at": "2026-10-17T12:00:00.000Z",
"updated_at": "2026-10-17T12:00:00.000Z",
"reply_with_audio": "never",
"audio_voice": "",
"menu_mode": "auto",
"update_lead": true
}
}
}
},
"401": {
"description": "Token ausente ou inválido.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrkesioError"
},
"example": {
"error": "unauthorized",
"message": "Token inválido."
}
}
}
},
"404": {
"description": "Nenhum recurso com esse `id` nesta inbox.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrkesioError"
},
"example": {
"error": "not_found",
"message": "Nenhum recurso com esse `id` nesta inbox."
}
}
}
},
"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."
}
}
}
}
}
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: GET /chatbot/agents/{id}.
- Mesmo caminho e mesmas funções; muda o formato: campos em
snake_case, datas em ISO 8601 (_at) e erros em{error, message}. - Caminho com o id nomeado:
/chatbot/agents/{id}→/chatbot/agents/{agent_id}. - Campos renomeados:
audioVoice→audio_voice,basePrompt→base_prompt,contextMaxMessages→context_max_messages,contextMinMessages→context_min_messages,contextWindowHours→context_window_hours,createdAt→created_at,frequencyPenalty→frequency_penalty,hasApiKey→has_api_key,maxMessageLength→max_message_length,menuMode→menu_mode,presencePenalty→presence_penalty,readMessages→read_messages,replyWithAudio→reply_with_audio,signMessages→sign_messages,topP→top_p,typingDelaySeconds→typing_delay_seconds,updateLead→update_lead,updatedAt→updated_at.
#/components/schemas/AIAgent
{
"type": "object",
"description": "Agente de IA: modelo, instruções e comportamento da resposta.",
"required": [
"id",
"name",
"provider",
"model",
"has_api_key",
"base_prompt",
"temperature",
"top_p",
"frequency_penalty",
"presence_penalty",
"sign_messages",
"read_messages",
"max_message_length",
"typing_delay_seconds",
"context_window_hours",
"context_max_messages",
"context_min_messages",
"created_at",
"updated_at",
"reply_with_audio",
"audio_voice",
"menu_mode",
"update_lead"
],
"properties": {
"id": {
"type": "string",
"readOnly": true,
"description": "ID do agente. É o `agent_id` dos gatilhos e das rotas `/chatbot/agents/{agent_id}`."
},
"name": {
"type": "string",
"description": "Nome do agente. Aparece na assinatura quando `sign_messages` é `true`."
},
"provider": {
"type": "string",
"enum": [
"openai",
"anthropic",
"gemini",
"deepseek"
],
"description": "Provedor do modelo."
},
"model": {
"type": "string",
"description": "Modelo do provedor, como `gpt-4o-mini` ou `claude-sonnet-4-5`."
},
"base_prompt": {
"type": "string",
"description": "Instruções do agente. Aceita `{{name}}`, `{{lead_name}}`, `{{lead_status}}` e os demais campos do lead do chat, que são trocados pelos valores do contato."
},
"temperature": {
"type": "number",
"minimum": 0,
"maximum": 2,
"description": "Criatividade da resposta (0 a 2). Use valores baixos para respostas previsíveis."
},
"top_p": {
"type": "number",
"minimum": 0,
"maximum": 1,
"description": "Diversidade das palavras escolhidas (0 a 1)."
},
"frequency_penalty": {
"type": "number",
"minimum": 0,
"maximum": 2,
"description": "Penaliza repetir as mesmas palavras (0 a 2)."
},
"presence_penalty": {
"type": "number",
"minimum": 0,
"maximum": 2,
"description": "Incentiva trazer assuntos novos (0 a 2)."
},
"sign_messages": {
"type": "boolean",
"description": "Começa cada resposta com `*Nome do agente*:`."
},
"read_messages": {
"type": "boolean",
"description": "Marca as mensagens do contato como lidas ao responder."
},
"max_message_length": {
"type": "integer",
"minimum": 0,
"description": "Respostas maiores que isso (em caracteres) são divididas em várias mensagens, por frase. `0`, o padrão, manda uma mensagem por frase."
},
"typing_delay_seconds": {
"type": "integer",
"minimum": 0,
"description": "Segundos mostrando \"digitando...\" antes de cada resposta, até 60. `0`, o padrão, não mostra."
},
"context_window_hours": {
"type": "integer",
"minimum": 0,
"description": "Quantas horas de conversa o agente lê como contexto. Padrão `24`."
},
"context_max_messages": {
"type": "integer",
"minimum": 0,
"description": "Máximo de mensagens anteriores lidas como contexto. Padrão `50`; `0` não lê nenhuma. Os três campos de contexto em `0` valem como o padrão."
},
"context_min_messages": {
"type": "integer",
"minimum": 0,
"description": "Mínimo de mensagens anteriores lidas, mesmo fora da janela de horas. Padrão `10`."
},
"has_api_key": {
"type": "boolean",
"description": "Se o agente tem chave do provedor. A chave nunca é devolvida."
},
"created_at": {
"description": "Criação. ISO 8601 em UTC com milissegundos.",
"readOnly": true,
"type": "string",
"format": "date-time"
},
"updated_at": {
"description": "Última alteração. ISO 8601 em UTC com milissegundos.",
"readOnly": true,
"type": "string",
"format": "date-time"
},
"reply_with_audio": {
"type": "string",
"enum": [
"never",
"when_audio",
"always"
],
"description": "Responder em áudio: `never` (padrão), `when_audio` (quando o contato mandou áudio) ou `always`. A voz é gerada pela OpenAI com a `openai_api_key` da inbox; sem a chave, ou com resposta acima de 4.096 caracteres, a resposta sai em texto."
},
"audio_voice": {
"type": "string",
"enum": [
"",
"alloy",
"ash",
"ballad",
"coral",
"echo",
"fable",
"nova",
"onyx",
"sage",
"shimmer"
],
"description": "Voz da resposta em áudio. Vazio usa `coral`."
},
"menu_mode": {
"type": "string",
"enum": [
"off",
"auto",
"button",
"list",
"poll"
],
"description": "Perguntas fechadas como menu: `off` (padrão) não envia menu; `button`, `list` ou `poll` usam sempre esse formato; `auto` deixa o agente escolher. Botões com mais de 3 opções viram lista; lista até 10 opções e enquete até 12. A escolha do contato volta como texto."
},
"update_lead": {
"type": "boolean",
"description": "A IA grava no CRM o que o contato informar (nome, e-mail, CPF/CNPJ, situação e os campos personalizados que têm nome em `PATCH /leads/fields`) e a etapa do funil (coluna do kanban), pela função `atualizar_lead`. As notas internas ficam de fora. Padrão `false`."
}
}
}
#/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