Skip to main content
POST

Exemplos de Código

Veja a documentação do OpenAI SDK para mais informações. No momento, nossa API suporta apenas os parâmetros de modelo temperature e messages (funções system, user e assistant). Além disso, o parâmetro tools é um enum de string. Para verificar os parâmetros de modelo de um agente específico, consulte o endpoint Obter Agente.

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 Rota

Corpo da Solicitação

Veja a documentação da API OpenAI para a referência completa de parâmetros. No momento, nossa API suporta apenas os parâmetros de modelo temperature e messages (funções system, user e assistant). Além disso, o parâmetro tools é um enum de string. Para verificar os parâmetros de modelo de um agente específico, consulte o endpoint Obter Agente.

Resposta

Veja a documentação da API OpenAI para o formato da 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 in OpenAI-compatible format. You can also include custom root-level fields when needed by your agent configuration.

Free-form JSON object in OpenAI-compatible format. Custom fields can also be sent at the root level.

Resposta

200

Chat completion response.