OpenAI-kompatibelt API-dokumentation

Forudsætninger: SDK og Base URL

Start med at installere dit foretrukne bibliotek og pege det mod vores endpoint. The base_url er https://api.apicompatible.com/v1. Denne OpenAI-kompatible API-dokumentation bekræfter, at standardbiblioteker fungerer med det samme. Du behøver ikke en router eller kompleks gateway-konfiguration. Skift URL og nøgle, og kør din eksisterende kode.

Autentificering: Header og nøgleformat

Send dit nøgle i Authorization header. Brug formatet Bearer your_api_key. Vores API bruger den standard openai-kompatible API-nøglestruktur. Nøgler genereres øjeblikkeligt via Google- eller e-maillogin. Hold din nøgle sikker, da den giver adgang til din forudbetalte kredit.

Chat Completions Endpoint

Send anmodninger til /v1/chat/completions. Angiv modellen som uncensored. API'en returnerer tekstsvare direkte. Brug følgende curl-kommando til at verificere forbindelsen:

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"}]
  }'

Denne openai SDK-kompatible tilgang sikrer, at du får ubegrænset tekstgenerering. Modellen håndterer komplekse prompts uden unødvendige afvisninger af lovligt indhold.

Streaming-svar med SSE

Aktivér streaming ved at indstille stream: true. Svar modtages via Server-Sent Events (SSE). Detaljer om tokenforbrug vises i den sidste chunk. Denne OpenAI-kompatible API-dokumentation understøtter standard streaming-protokoller. Brug dette til realtidsbrugeroplevelser:

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)

Streaming reducerer den opfattede forsinkelse betydeligt. Det fungerer sømløst med standard biblioteker på klientsiden.

Parametre: Temperatur, Top-P og Værktøjer

Styr genereringen med standardparametre. Indstil temperature for tilfældighed eller top_p for nucleus sampling. Aktiver tools til function calling. JSON-tilstand er tilgængelig via response_formatThe uncensored modellen respekterer disse begrænsninger effektivt:

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);

Disse parametre giver finjusteret kontrol over output-stil. Du kan tvinge strenge JSON-strukturer til programmerbare use cases.

Begrænsninger: Rate Limits og Body Størrelse

Hver nøgle giver 300 requests i minuttet. Samtidige requests er begrænset til 8 per nøgle. Den maksimale request body-størrelse er 8 MB. Context-vinduet understøtter i alt 100,000 tokens. Håndter 401-fejl ved at tjekke din nøgle. Løs 402-fejl ved at fylde kredit på. Håndter 429-fejl ved at implementere backoff-logik.

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)