Agentes
Executar Compatível com OpenAI
Executa um agente de chat específico por ID usando a API compatível com OpenAI.
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 modelotemperature 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
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
x-workspace-id | integer | Não | ID do workspace. Se não fornecido, o workspace selecionado pelo usuário será usado. Será obrigatório em uma versão futura. |
Parâmetros de Rota
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | integer | Sim | O ID do agente. |
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 modelotemperature 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
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Cabeçalhos
ID of the workspace. If not provided, the user's selected workspace will be used. This field will be required in a future release.
Parâmetros de caminho
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.