Alterar agente
/v1/instances/{id}/agents/{agent_id}desde A1token da instância ou adminQuando usar
Atualização parcial: campos omitidos ficam como estão (por exemplo {"enabled": false} pausa o 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
| Nome | Tipo | Descrição |
|---|---|---|
idobrigatório | string | Id da instância (inst_...). |
agent_idobrigatório | string | Id do agente (agn_...). |
Corpo (JSON)
| Nome | Tipo | Descrição |
|---|---|---|
name | string | (até 80) |
enabled | boolean | |
mode | "aprovacao" | "autonomo" | "sugerir" | aprovacao: escritas viram rascunhos; autonomo: executa; sugerir: só notas. |
instructions | string | O que o agente faz (confiável: escrito por você). (até 20000) |
tools | "ler" | "ler_outros_chats" | "responder_no_chat" | "enviar_outros_chats" | "etiquetas" | "grupos" | "midia"[] | |
trigger | AgentTrigger | |
trigger.type | "message" | "manual" | message: cada mensagem nova (pelo hook de agente com target agents); manual: só Executar agora. (padrão "message") |
trigger.chats | string[] | Só nestes chats (JIDs ou números). Vazio = todos. |
trigger.labels | string[] | Só em chats com uma destas etiquetas (id ou nome). |
trigger.keywords | string[] | Só quando a mensagem contém uma destas palavras (sem diferenciar maiúsculas). |
trigger.groups | boolean | Também em grupos (desligado = só conversas 1:1). (padrão false) |
limits | AgentLimits | |
limits.max_steps | integer | Chamadas ao modelo por execução. (padrão 8, 1–20) |
limits.max_recipients | integer | Destinatários distintos por execução. (padrão 3, 1–10) |
limits.max_sends | integer | Envios por execução (também na conversa do gatilho; rascunhos contam). (padrão 5, 1–50) |
limits.max_writes | integer | Escritas por execução (envios (padrão 10, 1–100) |
limits.max_group_changes | integer | Mudanças em grupos por execução. (padrão 3, 1–20) |
limits.daily_runs | integer | Execuções por dia UTC (0 = sem limite do agente; os limites do Atendente IA continuam valendo). (padrão 200) |
runtime | "provider" | "codex_cli" | Quem pensa. provider: o provedor de IA da instância (chave de API). codex_cli (opt-in): o Codex CLI logado neste computador com a sua conta ChatGPT; só o token admin cria, edita, executa ou simula um agente codex_cli. Veja Guias > IA por assinatura. (padrão "provider") |
accept_runtime_notice | boolean | Obrigatório (true) ao mudar um agente para codex_cli: confirma o aviso sobre os termos da OpenAI e os limites do seu plano. |
Exemplo
curl -s -X PUT "$LITEZAP_URL/v1/instances/$ID/agents/$AGENT_ID" \ -H "Authorization: Bearer $LITEZAP_TOKEN" \ -d '{"enabled":false}'const res = await fetch("http://localhost:8787/v1/instances/inst_7f3a9c2e5b1d4086/agents/agent_id", { method: "PUT", headers: { Authorization: `Bearer ${process.env.LITEZAP_TOKEN}`, "Content-Type": "application/json" }, body: JSON.stringify({ "enabled": false }),});console.log(res.status, res.status === 204 ? "" : await res.json());import osimport requests
r = requests.put( "http://localhost:8787/v1/instances/inst_7f3a9c2e5b1d4086/agents/agent_id", headers={"Authorization": f"Bearer {os.environ['LITEZAP_TOKEN']}"}, json={ "enabled": False, }, timeout=150,)print(r.status_code, r.json() if r.content else "")package main
import ( "fmt" "io" "net/http" "os" "strings")
func main() { req, _ := http.NewRequest("PUT", "http://localhost:8787/v1/instances/inst_7f3a9c2e5b1d4086/agents/agent_id", strings.NewReader(`{"enabled":false}`)) req.Header.Set("Authorization", "Bearer "+os.Getenv("LITEZAP_TOKEN")) req.Header.Set("Content-Type", "application/json") resp, err := http.DefaultClient.Do(req) if err != nil { panic(err) } defer resp.Body.Close() out, _ := io.ReadAll(resp.Body) fmt.Println(resp.Status, string(out))}<?phprequire 'vendor/autoload.php'; // composer require guzzlehttp/guzzle
$client = new GuzzleHttp\Client(['base_uri' => 'http://localhost:8787']);$res = $client->request('PUT', '/v1/instances/inst_7f3a9c2e5b1d4086/agents/agent_id', [ 'headers' => ['Authorization' => 'Bearer ' . getenv('LITEZAP_TOKEN')], 'json' => [ 'enabled' => false, ], 'http_errors' => false,]);echo $res->getStatusCode(), ' ', $res->getBody(), PHP_EOL;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 alterado.
Campos de Agent
id | string | |
name | string | |
enabled | boolean | |
mode | "aprovacao" | "autonomo" | "sugerir" | |
instructions | string | |
tools | string[] | |
trigger | AgentTrigger | |
trigger.type | "message" | "manual" | message: cada mensagem nova (pelo hook de agente com target agents); manual: só Executar agora. |
trigger.chats | string[] | Só nestes chats (JIDs ou números). Vazio = todos. |
trigger.labels | string[] | Só em chats com uma destas etiquetas (id ou nome). |
trigger.keywords | string[] | Só quando a mensagem contém uma destas palavras (sem diferenciar maiúsculas). |
trigger.groups | boolean | Também em grupos (desligado = só conversas 1:1). |
limits | AgentLimits | |
limits.max_steps | integer | Chamadas ao modelo por execução. |
limits.max_recipients | integer | Destinatários distintos por execução. |
limits.max_sends | integer | Envios por execução (também na conversa do gatilho; rascunhos contam). |
limits.max_writes | integer | Escritas por execução (envios |
limits.max_group_changes | integer | Mudanças em grupos por execução. |
limits.daily_runs | integer | Execuções por dia UTC (0 = sem limite do agente; os limites do Atendente IA continuam valendo). |
runtime | "provider" | "codex_cli" | |
today | object | |
today.runs | integer | |
today.cost_usd | number | |
created_at | string | |
updated_at | string |
Erros
| Código | HTTP | Retentável | O que fazer |
|---|---|---|---|
validation_failed | 400 | não | Corrija o corpo ou os parâmetros; a message diz o campo. |
unauthorized | 401 | não | Envie Authorization: Bearer <token> válido. |
forbidden | 403 | não | Use o token certo (admin, ou o da própria instância). |
not_found | 404 | não | Confira o id do recurso (mensagem, chat, contato, mídia ou webhook). |
instance_not_found | 404 | não | Confira 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 · Ler 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

