Ollama API-Schnellstart-Leitfaden

Basis-URL- und Authentifizierungseinrichtung

Konfigurieren Sie Ihren Client so, dass er auf unseren gehosteten Endpunkt zeigt. Legen Sie den base_url zu https://api.apiollama.com/v1 und geben Sie Ihren Schlüssel in den Authorization header. Die Authentifizierung verwendet den Standard Bearer Schema. Sie können einen Schlüssel über Google oder E-Mail im Dashboard generieren. Das System erstellt einen aktiven Schlüssel pro Konto.

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

Halten Sie Ihren Schlüssel sicher. Wenn Sie einen frischen Schlüssel benötigen, generieren Sie einen neuen im Dashboard, und der alte wird sofort inaktiv. Für die Einrichtung ist keine Telefonnummer erforderlich. Dieses Setup funktioniert mit jedem OpenAI-kompatiblen Client.

POST /v1/chat/completions: Anfragen senden

Senden Sie Ihre erste Chat-Vervollständigungsanfrage über den standardmäßigen Endpunkt. Geben Sie die Modell-ID als uncensored im Anfragekörper. Die API akzeptiert Standard-Nachrichtenarrays, die System-, Benutzer- und Assistentenrollen enthalten. Dies funktioniert mit jedem SDK, das das OpenAI-Format unterstützt. Stellen Sie sicher, dass Sie den model field in every request.

Copyfrom openai import OpenAI

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

Anfragen werden über unsere Server verarbeitet. Das Modell antwortet mit generiertem Text basierend auf Ihrem Prompt. Sie können Parameter wie temperature oder top_p um Zufälligkeit zu steuern. Das System gibt ein vollständiges Antwortobjekt zurück, das den generierten Inhalt enthält.

GET /v1/models: Verfügbare Modelle auflisten

Fragen an den Models-Endpunkt stellen, um verfügbare Optionen zu überprüfen. Senden Sie eine GET-Anfrage an /v1/models gehostete Modelle aufzulisten. Die Antwort enthält die id field set to uncensored. Dieser Endpunkt bestätigt, dass Ihr API-Schlüssel über gültige Berechtigungen verfügt. Er gibt Metadaten zur Modellkonfiguration zurück.

Copyimport OpenAI from "openai";

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

Nutzen Sie diesen Aufruf, um Verbindungsprobleme zu debuggen. Wenn das Endpunkt einen Fehler zurückgibt, überprüfen Sie Ihren Authentifizierungsheader. Der Endpunkt liefert eine einfache Liste verfügbarer Modelle. Sie können den Dienststatus überprüfen, ohne eine vollständige Chat-Anfrage zu senden.

Streaming-Antworten mit Server-Sent Events

Aktivieren Sie das Streaming, indem Sie den stream Parameter auf true setzen. Die API gibt Server-Sent Events (SSE) für die Echtzeit-Token-Bereitstellung zurück. Jeder Chunk enthält teilweise Inhaltsaktualisierungen. Der letzte Chunk enthält die vollständigen Token-Nutzungsstatistiken. Dies reduziert die wahrgenommene Latenz für lange Antworten.

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)

Verarbeiten Sie den SSE-Stream in Ihrem Client-Code. Verarbeiten Sie jedes Ereignis, sobald es eintrifft. Das letzte Ereignis enthält das usage Objekt mit Eingabe- und Ausgabetoken-Anzahlen. Streaming funktioniert mit allen unterstützten Parametern. Es bietet sofortiges Feedback für interaktive Anwendungen.

Konfigurationsparameter: Temperatur, Top-p und mehr

Passen Sie das Generierungsverhalten mit Standardparametern an. Legen Sie temperature für Zufälligkeit und top_p für Nucleus-Sampling. Verwenden Sie stop Sequenzen, um die Generierung frühzeitig zu stoppen. Der seed Parameter sorgt für reproduzierbare Ergebnisse. Sie können ihn auch presence_penalty und frequency_penalty für Stilsteuerung.

Der JSON-Modus ist verfügbar über response_format. Legen Sie dies auf json_object für strukturierte Ausgaben. Das Modell hält sich an das angegebene Format. Diese Parameter gelten für alle Anfragen. Verwenden Sie sie, um den Antwortstil fein abzustimmen.

Fehlerbehandlung und Token-Nutzungsberichterstellung

Behandeln Sie gängige HTTP-Statuscodes in Ihrer Anwendung. Ein 401-Status weist auf einen ungültigen API-Schlüssel hin. Ein 402-Status bedeutet, dass Ihr vorausbezahltes Guthaben aufgebraucht ist. Ein 429-Status signalisiert, dass Sie das Rate Limit überschritten haben. Prüfen Sie den Antwort-Body auf detaillierte Fehlermeldungen. Ablehnungen aufgrund der Inhaltsrichtlinie sind kostenlos.

Das Kontextfenster unterstützt insgesamt 100.000 Tokens. Die Ausgabe ist auf 16.000 Tokens pro Anfrage begrenzt. Die Standardausgabe beträgt 2.048 Tokens, wenn max_tokens ist nicht festgelegt. Die Token-Nutzung wird im letzten Stream-Chunk gemeldet. Fehler verbrauchen kein Guthaben.