Documentação da API Compatível com OpenAI

Início rápido: Conecte com SDK OpenAI

Comece autenticando com sua chave e apontando o cliente para nossa URL base. Esta configuração funciona com os SDKs oficiais do OpenAI para Python e Node.js, garantindo que você possa executar o mesmo código de cliente contra nosso serviço. Você precisa de uma chave de API válida do painel e da configuração correta do endpoint.

Copycurl https://api.openaiapicompatible.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Return the current UTC timestamp in ISO 8601 format"}]
  }'

Copyfrom openai import OpenAI

client = OpenAI(base_url="https://api.openaiapicompatible.com/v1", api_key="YOUR_KEY")

resp = client.chat.completions.create(
    model="uncensored",
    messages=[{"role": "user", "content": "Summarise this thread without softening it."}],
)
print(resp.choices[0].message.content)

Copyimport OpenAI from "openai";

const client = new OpenAI({ baseURL: "https://api.openaiapicompatible.com/v1", apiKey: process.env.API_KEY });

const resp = await client.chat.completions.create({
  model: "uncensored",
  messages: [{ role: "user", content: "Draft a villain monologue for my game." }],
});
console.log(resp.choices[0].message.content);

Endpoint Chat Completions

Envie texto para nosso único endpoint de chat para saída direta de texto. Usamos POST /v1/chat/completions para processar seus prompts e retornar texto gerado. Esta é a interação principal para a maioria das aplicações LLM, sem necessidade de roteamento complexo ou chamadas adicionais a serviços.

Copystream = client.chat.completions.create(
    model="uncensored",
    messages=[{"role": "user", "content": "Tell the story in second person."}],
    stream=True,
)
for chunk in stream:
    if chunk.choices and chunk.choices[0].delta.content:
        print(chunk.choices[0].delta.content, end="", flush=True)

Streaming com SSE

Receba tokens em tempo real usando Server-Sent Events para menor latência. Ative o streaming definindo o parâmetro stream como true na sua solicitação. O último chunk inclui dados de uso de tokens, permitindo que você rastreie os custos com precisão conforme o modelo gera texto. Esta abordagem mantém sua interface responsiva mesmo para saídas longas.

Function Calling & JSON Mode

Integre ferramentas e garanta saídas estruturadas para interações programáticas confiáveis. Use o parâmetro tools para definir esquemas de função e defina response_format como json_object para estrita conformidade com JSON. Nosso modelo sem censura lida com instruções complexas e casos extremos sem recusar solicitações funcionais válidas.

Limites de Taxa & Parâmetros

Monitore seu uso contra limites rigorosos por chave para evitar interrupções no serviço. Você tem direito a 300 solicitações por minuto e oito solicitações simultâneas por chave, com um limite de corpo de 8 MB. Erros como 401 (chave inválida), 402 (sem crédito) e 429 (limite de taxa) indicam estados específicos da conta.

Janela de Contexto e Restrições

Maximize o gerenciamento de contexto com uma janela de 100.000 tokens para entrada e saída combinadas. Defina max_tokens para controlar o comprimento da geração, com padrão de 2.048 se não especificado. Nosso modelo roda em servidores proprietários, não como proxy para outros fornecedores, garantindo desempenho consistente para o seu caso de uso específico.