OpenAI-kompatibel API-dokumentation

Snabbstart: Anslut med OpenAI SDK

Börja med att autentisera med din nyckel och peka klienten mot vår bas-URL. Denna konfiguration fungerar med officiella OpenAI SDK:er för Python och Node.js, vilket säkerställer att du kan köra samma klientkod mot vår tjänst. Du behöver en giltig API-nyckel från kontrollpanelen och korrekt slutpunktskonfiguration.

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

Slutpunkt för chattkomplettering

Skicka text till vår enda chattslutpunkt för direkt textutmatning. Vi använder POST /v1/chat/completions för att bearbeta dina prompter och returnera genererad text. Detta är den grundläggande interaktionen för de flesta LLM-applikationer, utan behov av komplex routning eller ytterligare tjänstanrop.

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 med SSE

Ta emot token i realtid med Server-Sent Events för lägre latens. Aktivera strömning genom att ange stream-parametern till true i din begäran. Den sista chunken innehåller tokenanvändningsdata, vilket gör att du kan spåra kostnader noggrant när modellen genererar text. Detta håller ditt UI responsivt även för långa utdata.

Function Calling & JSON Mode

Integrera verktyg och tvinga fram strukturerade utdata för pålitliga programmatiska interaktioner. Använd verktygsparametern för att definiera funktions scheman och ange response_format till json_object för strikt JSON-kompatibilitet. Vår obegränsade modell hanterar komplexa instruktioner och kantfall utan att vägra giltiga funktionsförfrågningar.

Begäransgränser & parametrar

Övervaka din användning mot strikta gränser per nyckel för att undvika tjänststörningar. Du tillåts 300 begäranden per minut och åtta samtidiga begäranden per nyckel, med en 8 MB begränsning för begäranskroppen. Fel som 401 (ogiltig nyckel), 402 (ingen kredit) och 429 (hastighetsgräns) indikerar specifika kontostatusar.

Kontextfönster & Begränsningar

Maximera kontexthantering med ett 100 000-tokens fönster för kombinerad inmatning och output. Ställ in max_tokens för att styra längden på genereringen, med standard 2 048 om det inte anges. Vår modell körs på proprietära servrar, inte som en proxy för andra leverantörer, vilket säkerställer konsekvent prestanda för ditt specifika användningsområde.