Pular para o conteúdo

Ler agente

GET/v1/instances/{id}/agents/{agent_id}desde A1token da instância ou admin

Quando usar

Ler agente

Autenticação

Aceita o token da instância (só a própria instância) ou o token admin. Um token de outra instância recebe 403 forbidden (ou 404 not_found em webhooks de outra instância).

Parâmetros

Caminho

NomeTipoDescrição
idobrigatóriostringId da instância (inst_...).
agent_idobrigatóriostringId do agente (agn_...).

Exemplo

Janela do terminal
curl -s "$LITEZAP_URL/v1/instances/$ID/agents/$AGENT_ID" \
-H "Authorization: Bearer $LITEZAP_TOKEN"

Nos exemplos, LITEZAP_URL é a URL base (ex.: http://localhost:8787) e o token vem deLITEZAP_TOKEN (instância) ou LITEZAP_ADMIN_TOKEN.

Resposta

200 Agente.

Campos de Agent
idstring
namestring
enabledboolean
mode"aprovacao" | "autonomo" | "sugerir"
instructionsstring
toolsstring[]
triggerAgentTrigger
trigger.type"message" | "manual"message: cada mensagem nova (pelo hook de agente com target agents); manual: só Executar agora.
trigger.chatsstring[]Só nestes chats (JIDs ou números). Vazio = todos.
trigger.labelsstring[]Só em chats com uma destas etiquetas (id ou nome).
trigger.keywordsstring[]Só quando a mensagem contém uma destas palavras (sem diferenciar maiúsculas).
trigger.groupsbooleanTambém em grupos (desligado = só conversas 1:1).
limitsAgentLimits
limits.max_stepsintegerChamadas ao modelo por execução.
limits.max_recipientsintegerDestinatários distintos por execução.
limits.max_sendsintegerEnvios por execução (também na conversa do gatilho; rascunhos contam).
limits.max_writesintegerEscritas por execução (envios
limits.max_group_changesintegerMudanças em grupos por execução.
limits.daily_runsintegerExecuções por dia UTC (0 = sem limite do agente; os limites do Atendente IA continuam valendo).
runtime"provider" | "codex_cli"
todayobject
today.runsinteger
today.cost_usdnumber
created_atstring
updated_atstring

Erros

CódigoHTTPRetentávelO que fazer
unauthorized401nãoEnvie Authorization: Bearer <token> válido.
forbidden403nãoUse o token certo (admin, ou o da própria instância).
not_found404nãoConfira o id do recurso (mensagem, chat, contato, mídia ou webhook).
instance_not_found404nãoConfira o id da instância.

Todo erro usa o envelope {"error":{"code","message","retryable"}}. Tabela completa em Erros.

Outras operações de Agentes: Listar agentes · Criar agente · Alterar agente · Excluir agente · Executar agente agora · Execuções do agente · Ler execução · Quem pode rodar agentes · Listar rascunhos · Aprovar rascunho · Rejeitar rascunho · Simular agente