Simular agente

POST/v1/instances/{id}/agents/simulatedesde A1token da instância ou admin

Quando usar

Roda um agente salvo (agent_id), um não salvo (agent) ou um salvo com alterações (os dois) contra mensagens de exemplo (from: customer, agent, human, automatic). As ferramentas de escrita são sempre faz de conta: cada passo dry_run mostra o que o agente faria. As de leitura leem dados reais (com chat, os do chat informado). Nada é guardado nem enviado.

Confiabilidade e risco

É uma chamada real ao provedor e conta no limite do simulador.

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_...).

Corpo (JSON)

Nome	Tipo	Descrição
agent_id	string
agent	AgentInput
agent.name	string	(até 80)
agent.enabled	boolean
agent.mode	"aprovacao" | "autonomo" | "sugerir"	aprovacao: escritas viram rascunhos; autonomo: executa; sugerir: só notas.
agent.instructions	string	O que o agente faz (confiável: escrito por você). (até 20000)
agent.tools	"ler" | "ler_outros_chats" | "responder_no_chat" | "enviar_outros_chats" | "etiquetas" | "grupos" | "midia"[]
agent.trigger	AgentTrigger
agent.limits	AgentLimits
agent.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")
agent.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.
messages	object[]	(até 50 itens)
chat	string
input	string	(até 4000)

Exemplo

cURL

curl -s -X POST "$LITEZAP_URL/v1/instances/$ID/agents/simulate" \
  -H "Authorization: Bearer $LITEZAP_TOKEN" \
  -d '{"agent":{"name":"Teste","instructions":"Responda dúvidas de horário: seg a sáb, 9h às 18h."},"messages":[{"text":"vocês abrem sábado?"}]}'

Node.js

const res = await fetch("http://localhost:8787/v1/instances/inst_7f3a9c2e5b1d4086/agents/simulate", {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.LITEZAP_TOKEN}`, "Content-Type": "application/json" },
  body: JSON.stringify({
    "agent": {
      "name": "Teste",
      "instructions": "Responda dúvidas de horário: seg a sáb, 9h às 18h."
    },
    "messages": [
      {
        "text": "vocês abrem sábado?"
      }
    ]
  }),
});
console.log(res.status, res.status === 204 ? "" : await res.json());

Python

import os
import requests

r = requests.post(
    "http://localhost:8787/v1/instances/inst_7f3a9c2e5b1d4086/agents/simulate",
    headers={"Authorization": f"Bearer {os.environ['LITEZAP_TOKEN']}"},
    json={
        "agent": {
            "name": "Teste",
            "instructions": "Responda dúvidas de horário: seg a sáb, 9h às 18h.",
        },
        "messages": [
            {
                "text": "vocês abrem sábado?",
            },
        ],
    },
    timeout=150,
)
print(r.status_code, r.json() if r.content else "")

Go

package main

import (
  "fmt"
  "io"
  "net/http"
  "os"
  "strings"
)

func main() {
  req, _ := http.NewRequest("POST", "http://localhost:8787/v1/instances/inst_7f3a9c2e5b1d4086/agents/simulate", strings.NewReader(`{"agent":{"name":"Teste","instructions":"Responda dúvidas de horário: seg a sáb, 9h às 18h."},"messages":[{"text":"vocês abrem sábado?"}]}`))
  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))
}

PHP

<?php
require 'vendor/autoload.php'; // composer require guzzlehttp/guzzle

$client = new GuzzleHttp\Client(['base_uri' => 'http://localhost:8787']);
$res = $client->request('POST', '/v1/instances/inst_7f3a9c2e5b1d4086/agents/simulate', [
    'headers' => ['Authorization' => 'Bearer ' . getenv('LITEZAP_TOKEN')],
    'json' => [
        'agent' => [
            'name' => 'Teste',
            'instructions' => 'Responda dúvidas de horário: seg a sáb, 9h às 18h.',
        ],
        'messages' => [
            [
                'text' => 'vocês abrem sábado?',
            ],
        ],
    ],
    '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 O que o agente faria (dry_run: true, sem id).

Campos de AgentRun

id	string
agent_id	string
agent_name	string
trigger	"message" | "manual"
chat	string
message_id	string
mode	string
status	"running" | "completed" | "step_limit" | "failed" | "discarded"	discarded: um humano assumiu o chat durante a execução.
steps	AgentStep[]
output	string	Resumo final do agente para você (não é enviado a ninguém).
model	string
model_calls	integer
input_tokens	integer
output_tokens	integer
cost_usd	number
sent	integer	Escritas executadas.
drafts	integer	Rascunhos criados.
error	string
started_at	string
ended_at	string
dry_run	boolean	Só no simulador.

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.
not_configured	409	não

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

Outras operações de Agentes: Listar agentes · Criar agente · Ler 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