Ollama API-Dokumentation: Endpunkt-Referenz
Diese Seite dokumentiert die OpenAI-kompatible API für unzensierte Inferenz. Sie funktioniert mit Standard-SDKs, indem Sie die Basis-URL und den API-Schlüssel ändern.
Basis-URL und Authentifizierung
Die Base-URL für alle Anfragen ist https://api.ollamaapidocumentation.com/v1. Sie authentifizieren sich mit einem Bearer-Token, das im Authorization header. Ihr Schlüssel wird im Dashboard generiert und funktioniert sofort.
- Verwenden Sie die offiziellen OpenAI-SDKs oder einen beliebigen kompatiblen Client.
- Legen Sie die Basis-URL auf den oben genannten Wert fest.
- Fügen Sie Ihren API-Schlüssel in den Header ein.
Die Authentifizierung ist streng. Wenn der Schlüssel fehlt oder ungültig ist, gibt die API einen 401-Fehler zurück. Dies stellt sicher, dass Ihre Nutzung für die Abrechnung genau verfolgt wird.
Chat-Vervollständigungs-Endpunkt: POST /v1/chat/completions
Senden Sie Nachrichten an das Modell über POST /v1/chat/completions. Der Endpunkt akzeptiert einen JSON-Body mit einem model field set to "uncensored" and a messages array.
Dieser Endpunkt behandelt Textgenerierung. Er unterstützt keine Bilder, Audio oder Video. Sie können Antworten streamen oder auf das vollständige Ergebnis warten.
Fehler wie 402 deuten auf unzureichendes Guthaben hin. Anfragen werden basierend auf der tatsächlichen Token-Nutzung berechnet. Ablehnungen aufgrund von Guthangmangel sind kostenlos.
Modellauflistung: GET /v1/models
Rufen Sie verfügbare Modelle mit GET /v1/models. Dies gibt eine Liste von Modellobjekten zurück. Die einzige verfügbare Model-ID ist "uncensored".
Dieser Endpunkt hilft bei der Überprüfung der Konnektivität. Er bestätigt, dass die Basis-URL korrekt ist. Er zeigt auch den Modellnamen und den Objekttyp an.
Verwenden Sie dies, um Verbindungsprobleme zu debuggen, bevor Sie große Payloads senden.
Parameter: Temperatur, Top P, Seed
Steuern Sie die Generierung mit temperature, top_p, und seed. Die seed parameter stellt deterministische Ausgaben sicher. Verwenden Sie ihn für Debugging oder konsistente Ergebnisse.
Festlegen temperature zwischen 0 und 2. Niedrigere Werte machen Antworten vorhersehbarer. Höhere Werte erhöhen die Zufälligkeit. Das top_p Parameter kombinieren, der Tokens nach kumulativer Wahrscheinlichkeit filtert.
Diese Parameter funktionieren genau wie die OpenAI API. Sie können sie kombinieren, um eine präzise Kontrolle über den Stil zu erhalten.
Streaming-Antworten und Token-Nutzung
Aktivieren Sie Streaming, indem Sie stream: true. Die API gibt Server-Sent Events (SSE) zurück. Jeder Chunk enthält teilweise Text.
Das letzte Chunk enthält die Token-Nutzungsstatistiken. Dies ermöglicht es Ihnen, die Kosten genau zu berechnen. Sie können Tokens verarbeiten, sobald sie eintreffen.
Streaming reduziert die wahrgenommene Latenz. Es ist ideal für Chat-Schnittstellen. Der Server sendet Daten, bis die Antwort vollständig ist.
Limits, Fehler und Kontextfenster
Das Context-Window umfasst 100.000 Tokens. Dies umfasst sowohl Input- als auch Output-Tokens. Sie können bis zu 16.000 Tokens pro Anfrage generieren. Die Standard-Maximalausgabe beträgt 2.048 Tokens.
Die Ratenbegrenzung beträgt 300 Anfragen pro Minute. Sie können 8 gleichzeitige Anfragen haben. Die Größe des Anfragekörpers ist auf 8 MB begrenzt.
Zu den Fehlern zählen 401 für ungültige Schlüssel und 429 für Ratenbegrenzungen. Fehler beim Guthaben geben 402 zurück. Diese Fehler sind klar und handhabbar.
cURL
curl https://api.ollamaapidocumentation.com/v1/chat/completions \
-H "Authorization: Bearer $API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "uncensored",
"messages": [{"role": "user", "content": "list files in the current directory"}]
}'Python
from openai import OpenAI
client = OpenAI(base_url="https://api.ollamaapidocumentation.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)Node.js
import OpenAI from "openai";
const client = new OpenAI({ baseURL: "https://api.ollamaapidocumentation.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);Streaming
stream = 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)Häufige Fragen
Was ist die Base-URL für die Ollama-API-Dokumentation?
Die Basis-URL ist HTTPS://api.ollamaapidocumentation.com/v1. Sie müssen dies in Ihrer SDK-Konfiguration festlegen, um die uncensored-LLM-API zu verwenden.
Wie gehe ich mit Fehlern wie 401 oder 402 um?
Ein 401-Fehler bedeutet, dass Ihr API-Schlüssel ungültig oder fehlt. Ein 402-Fehler zeigt an, dass Sie kein vorgeladenes Guthaben haben. Laden Sie mit Kryptowährungen auf, um fortzufahren.
Wie groß ist die Kontextfenstergröße?
Das Context-Window umfasst 100.000 Tokens. Dieses Limit umfasst sowohl den Prompt als auch das Completion. Sie können max_tokens bis zu 16.000 setzen.
Holen Sie sich Ihren Schlüssel in Sekunden.
Registrieren Sie sich, holen Sie sich den Schlüssel und tauschen Sie die Basis-URL. Fertig.
