Documentação da API Compatível com OpenAI

Pré-requisitos: SDK e URL Base

Come instalando a biblioteca de sua preferência e apontando-a para o nosso endpoint. O base_url é https://api.apicompatible.com/v1. A documentação da API compatível com OpenAI confirma que as bibliotecas padrão funcionam imediatamente. Você não precisa de um roteador ou configuração de gateway complexa. Altere a URL e a chave, então execute seu código existente.

Autenticação: Formato do Cabeçalho e da Chave

Envie sua chave no Authorization cabeçalho. Use o formato Bearer your_api_key. Nossa API usa a estrutura padrão de chave API compatível com OpenAI. As chaves são geradas instantaneamente via login com Google ou e-mail. Mantenha sua chave segura, pois ela concede acesso ao seu crédito pré-pago.

Endpoint Chat Completions

Envie solicitações para /v1/chat/completions. Especifique o modelo como uncensored. A API retorna respostas de texto diretamente. Use o seguinte comando curl para verificar a conectividade:

Copycurl https://api.apicompatible.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "List available models"}]
  }'

Esta abordagem compatível com o SDK OpenAI garante que você obtenha geração de texto sem restrições. O modelo lida com prompts complexos sem recusas desnecessárias para conteúdo lícito.

Respostas em Streaming com SSE

Ative o streaming definindo stream: true. As respostas chegam via Server-Sent Events (SSE). Os detalhes de uso de tokens aparecem no último chunk. Esta documentação de API compatível com OpenAI suporta protocolos de streaming padrão. Use isso para experiências em tempo real:

Copyfrom openai import OpenAI

client = OpenAI(base_url="https://api.apicompatible.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)

O streaming reduz significativamente a latência percebida. Funciona perfeitamente com bibliotecas padrão do lado do cliente.

Parâmetros: Temperatura, Top-P e Tools

Controle a geração com parâmetros padrão. Defina temperature para aleatoriedade ou top_p para amostragem por núcleo. Ative tools para chamada de função. O modo JSON está disponível via response_format. O uncensored o modelo respeita essas restrições de forma eficaz:

Copyimport OpenAI from "openai";

const client = new OpenAI({ baseURL: "https://api.apicompatible.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);

Esses parâmetros permitem controle refinado do estilo de saída. Você pode impor estruturas JSON rígidas para casos de uso programáticos.

Limites: Limites de Taxa e Tamanho do Corpo

Cada chave permite 300 solicitações por minuto. Solicitações simultâneas são limitadas a 8 por chave. O tamanho máximo do corpo da solicitação é de 8 MB. A janela de contexto suporta 100.000 tokens no total. Lidere erros 401 verificando sua chave. Resolva erros 402 recarregando o crédito. Gerencie erros 429 implementando lógica de backoff.

Streaming

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)