Executar Compatível com OpenAI

POST /agents/{id}/openai/chat/completions

Executa um agente de chat específico por ID usando a API compatível com OpenAI.

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.

cURL

curl --request POST \
  --url 'https://api.tess.im/agents/{id}/openai/chat/completions' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "temperature": "1",
    "model": "tess-5",
    "messages": [{ "role": "user", "content": "olá!" }],
    "tools": "no-tools",
    "stream": true
  }'

Node.js

import OpenAI from 'openai';

const client = new OpenAI({
  baseURL: 'https://api.tess.im/agents/{id}/openai',
  apiKey: 'YOUR_API_KEY',
});

async function main() {
  const chatCompletion = await client.chat.completions.create({
    messages: [{ role: 'user', content: 'Say this is a test' }],
    model: 'gpt-4o',
  });
}

main();

Python

import os
from openai import OpenAI

client = OpenAI(
    base_url="https://api.tess.im/agents/{id}/openai",
    api_key="YOUR_API_KEY"
)

chat_completion = client.chat.completions.create(
    messages=[
        {
            "role": "user",
            "content": "Say this is a test",
        }
    ],
    model="gpt-4o",
)

Cabeçalhos

Parâmetro	Tipo	Obrigatório	Descrição
x-workspace-id	integer	Não	ID do espaço de trabalho. Se não fornecido, o espaço de trabalho selecionado do usuário será usado.

Nota: Este campo será obrigatório em uma versão futura da API. É altamente recomendável configurá-lo agora para garantir a compatibilidade com futuras atualizações.

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 os parâmetros do corpo da solicitação. 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.

Experimente!

Autenticação

Este endpoint requer autenticação com token Bearer.

Testar Endpoint

id

Corpo da Requisição