Skip to main content
POST

Exemplos de Código

Cabeçalhos

integer
obrigatório
ID do workspace. Obrigatório a partir de 01/09/2026. Até lá, se omitido, usa o workspace selecionado do usuário (deprecated). Após a data, ausência → 422.

Parâmetros de Caminho

Corpo da Requisição

Como usar memórias numa execuçãoPara injetar contexto de memória num agente, passe os IDs das Coleções de Memória no campo memory_collections. O fluxo completo é:
  1. Criar uma ColeçãoPOST /api/memory-collections — e anote o id retornado.
  2. Criar MemóriasPOST /api/memories — passando collection_id e o texto da memória no campo memory.
  3. Executar o Agente — inclua "memory_collections": [id_da_colecao] no corpo da requisição.
O agente usará automaticamente as memórias relevantes para contextualizar a resposta.Veja o guia completo em Memórias.

Funções das Mensagens (Modelos do Tipo Chat)

Para modelos do tipo chat, o array messages suporta as seguintes funções: Regras importantes:
  • As mensagens devem alternar entre as funções user e assistant (após a mensagem opcional developer).
  • A função developer só pode aparecer como a primeira mensagem no array e será extraída antes do processamento do restante.
  • Se duas mensagens consecutivas tiverem a mesma função (por exemplo, duas mensagens user), a API retornará um erro de validação: “Chat messages must be a pair of user/assistant”.
  • A função system não é suportada e causará um erro.
Exemplo com mensagem developer:
Exemplo sem mensagem developer:
Obter mais detalhes sobre quais opções são aceitas por este Agente solicitando este endpoint: Obter Agente

Resposta

Autorizações

Authorization
string
header
obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Cabeçalhos

x-workspace-id
integer
obrigatório

Workspace ID. Required as of 2026-09-01. Until then, if omitted, the user's selected workspace is used (deprecated). After the cutoff, a missing header returns 422.

Parâmetros de caminho

id
integer
obrigatório

The agent ID.

Corpo

application/json

Send a JSON object. Known fields are supported, and you can add custom fields directly at the root (for example: department, reporting_period, include_risks).

Free-form JSON object. Send known fields and any custom agent fields directly at the root level.

Resposta

200

Execution started (or completed if waitExecution: true).