API Dokumentation

Basis-URL und Authentifizierung

Die API lebt unter https://api.ollamaapidoc.com/v1. Sie authentifizieren sich mit einem Bearer-Token im Authorization header. Generieren Sie Ihren Schlüssel sofort über Google oder E-Mail im Dashboard. Keine Telefonnummer erforderlich. Der Schlüssel funktioniert mit Standard-OpenAI-SDKs durch Festlegen der Basis-URL.

Ihre erste Anfrage

Senden Sie eine POST-Anfrage an /v1/chat/completions mit der Modell-ID uncensored. Dieser Endpunkt verarbeitet Texteingaben und Textausgaben. Er unterstützt Streaming, JSON-Modus und Function Calling. Sie können die Konnektivität testen, ohne Guthaben auszugeben, indem Sie zunächst den Models-Endpunkt prüfen.

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

Die Antwort gibt das Standard-OpenAI-Format zurück. Fehler geben entsprechende HTTP-Codes zurück. Überprüfen Sie den Body auf error Details, falls etwas fehlschlägt. Streaming-Antworten verwenden Server-Sent Events.

Python SDK-Integration

Installieren Sie das offizielle OpenAI-Paket. Konfigurieren Sie den Client mit Ihrer Basis-URL und Ihrem API-Schlüssel. Rufen Sie den Chat-Vervollständigungs-Endpunkt auf. Der Code bleibt identisch zur Standard-Nutzung von OpenAI. Dies gewährleistet eine einfache Migration für bestehende Projekte. Sie können Parameter wie Temperatur und top_p direkt in der Anfrage anpassen.

Copyfrom openai import OpenAI

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

Behandeln Sie Ausnahmen für Rate Limits oder ungültige Schlüssel. Die Bibliothek streamt Tokens, wenn Sie stream auf true setzen. Dieser Ansatz hält Ihren Code sauber und kompatibel.

Node.js-SDK-Einrichtung

Nutzen Sie die openai npm-Paket. Initialisieren Sie den Client mit der benutzerdefinierten Basis-URL. Übergeben Sie Ihren API-Schlüssel. Die Syntax spiegelt das Python-Beispiel wider. Diese Konsistenz reduziert die Debugging-Zeit. Sie können mehrere Nachrichten in einem Konversationsverlauf-Array senden.

Copyimport OpenAI from "openai";

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

Analysieren Sie die Antwort sorgfältig. Die API gibt strukturiertes JSON zurück. Fehlerbehandlung ist entscheidend für Produktions-Apps. Fangen Sie Netzwerkfehler und API-spezifische Fehler separat ab. Dies stellt sicher, dass Ihre App bei hohem Verkehrsaufkommen reaktionsfähig bleibt.

Streaming und JSON-Modus

Aktivieren Sie das Streaming, indem Sie den stream Parameter auf true setzen. Die API sendet Tokens über Server-Sent Events. Sie erhalten teilweise Antworten in Echtzeit. Dies verbessert die Benutzererfahrung für lange Ausgaben. Sie können auch JSON-Ausgabe erzwingen mit response_format. Dies ist nützlich für die Extraktion strukturierter Daten.

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 funktioniert ähnlich. Definieren Sie Tools in Ihrer Anfrage. Das Modell gibt Tool-Aufrufe zurück. Parsen Sie diese Aufrufe in Ihrem Code. Führen Sie sie aus und füttern Sie die Ergebnisse an das Modell zurück. Diese Schleife ermöglicht komplexe Workflows.

Limits, Fehler und Kontext

Das Context-Window umfasst 100.000 Tokens. Maximaler Output ist 16.000 Tokens pro Anfrage. Fehler umfassen 401 für ungültige Schlüssel und 402 für unzureichendes Guthaben. Rate-Limits begrenzen auf 300 Anfragen pro Minute. Behandeln Sie diese in Ihrer App angemessen. Die API verwendet Ihre Prompts niemals zum Training. Die Privatsphäre wird gewahrt. Guthaben verfällt nicht.