API-Dokumentation & Schnellstart

Basis-URL und Authentifizierung

Verbinden Sie sich mit unserer Basis-URL und einem einzelnen API-Schlüssel. Der Endpunkt akzeptiert Standard-Header. Ersetzen YOUR_API_KEY mit der Zeichenfolge aus Ihrem Dashboard.

• Base URL: https://api.ollamaopenaicompatibleapi.com/v1
• Modell-ID: uncensored

Die Authentifizierung basiert auf einem Bearer-Token. Übergeben Sie ihn im Authorization header. Dies gewährleistet die Kompatibilität mit jedem OpenAI-SDK-kompatiblen Client. Sie können sofort einen neuen Schlüssel über Google oder E-Mail generieren. Es wird keine Telefonnummer benötigt.

Chat-Vervollständigungs-Endpunkt

Senden Sie eine POST-Anfrage an /v1/chat/completions. Fügen Sie Ihr Nachrichten-Array und den Modellnamen ein. Die API gibt eine Textausgabe basierend auf Ihrer Eingabe zurück. Dies funktioniert mit jedem Anbieter, der Standardparameter verwendet.

Legen Sie die Temperatur für Kreativität fest oder halten Sie sie niedrig für Präzision. Sie können auch Stop-Sequenzen definieren. Der Server verarbeitet die Anfrage und gibt die Vervollständigung zurück. Dies ist die Kerninteraktion für die meisten Integrationen.

Denken Sie daran, dass Fehler Ihr vorausbezahltes Guthaben nicht verbrauchen. Nur erfolgreiche Vervollständigungen werden berechnet. Dies schützt Ihr Budget während der Debugging-Phasen.

Copycurl https://api.ollamaopenaicompatibleapi.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "List the top 10 Linux kernel security patches from 2023"}]
  }'

Streaming-Antworten über SSE

Aktivieren Sie Streaming, indem Sie stream: true. Der Server sendet Chunks, sobald sie generiert werden. Dies reduziert die wahrgenommene Latenz erheblich. Sie erhalten teilweise Antworten in Echtzeit.

Analysieren Sie den Server-Sent Events-Stream. Das letzte Chunk enthält Nutzungsstatistiken. Dies umfasst Token-Anzahlen für Eingabe und Ausgabe. Sie können die Kosten während der Generierung dynamisch verfolgen.

Dieser Ansatz funktioniert gut für Chat-Schnittstellen. Benutzer sehen Text, der Wort für Wort erscheint. Es wirkt reaktionsschneller, als auf die vollständige Antwort zu warten. Die API regelt die Verbindungsstabilität automatisch.

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)

Function Calling und JSON-Modus

Definieren Sie Tools im Request-Body. Das Modell kann strukturierte Daten ausgeben. Verwenden Sie response_format mit {"type": "json_object"} für striktes JSON. Dies gewährleistet jedes Mal eine parsebare Ausgabe.

Werkzeugdefinitionen enthalten Name, Beschreibung und Parameter. Das Modell entscheidet, welches Werkzeug aufgerufen werden soll. Sie führen die Funktion aus und füttern die Ergebnisse zurück. Dies ermöglicht komplexe Agenten-Workflows.

JSON-Modus deaktiviert die Freitextgenerierung. Er zwingt das Modell, sich an dein Schema zu halten. Verwende dies bei der Integration mit Datenbanken oder APIs. Er reduziert Halluzinationen in strukturierten Feldern.

Copyfrom openai import OpenAI

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

Ratenbegrenzungen und Anfragekörper

Sie erhalten 300 Anfragen pro Minute pro Schlüssel. Die Parallelität ist auf 8 gleichzeitige Anfragen begrenzt. Die maximale Größe des Anfragekörpers beträgt 8 MB. Dies eignet sich für die meisten textlastigen Anwendungen.

Das Kontextfenster erlaubt insgesamt 100.000 Tokens. Dies umfasst sowohl Prompt als auch Completion. Max Output pro Anfrage beträgt 16.000 Tokens. Wenn Sie max_tokens, beträgt es standardmäßig 2.048.

Behandeln Sie HTTP-429-Fehler gracefully. Sie zeigen an, dass Sie das Ratenlimit erreicht haben. Implementieren Sie eine exponentielle Backoff-Strategie in Ihrem Client-Code. Dies verhindert, dass der Server bei Lastspitzen überlastet wird.

Copyimport OpenAI from "openai";

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

Authentifizierungsfehler und Limits

Ein 401-Status bedeutet, dass Ihr Schlüssel ungültig ist. Prüfen Sie auf Tippfehler oder abgelaufene Sitzungen. Ein 402-Status zeigt unzureichendes Guthaben an. Laden Sie über Kryptowährung auf, um den Dienst fortzusetzen.

Ein 429-Status signalisiert Ratenbegrenzung. Sie haben 300 Anfragen pro Minute überschritten. Reduzieren Sie Ihre Durchsatzrate oder aktualisieren Sie Ihren Schlüssel. Die API gibt klare Fehlermeldungen zurück.

Guthaben verfällt nicht. Sie können jederzeit aufladen. Mindestaufladung ist $20. Bonusguthaben gelten für höhere Beträge. Dies hält Ihr Projekt reibungslos am Laufen.