API-Dokumentation

Schnellstart Ihrer ersten Anfrage

Beginnen Sie sofort mit der Generierung von Text, indem Sie Ihren Client auf unsere Basis-URL zeigen und sich mit einem generierten API-Schlüssel authentifizieren. Die Schnittstelle folgt Standardkonventionen, sodass Sie vorhandene SDKs verwenden können, ohne ein neues Protokoll zu lernen. Sie senden Prompts an die uncensored Modell und erhalten Sie Textantworten, die keine typischen Inhaltsfilter für legale erwachsene Nutzung anwenden.

Konfigurieren Sie die Basis-URL und den Schlüssel

Legen Sie Ihre Umgebungsvariablen fest, um Anfragen an unseren spezifischen Endpunkt weiterzuleiten. Ersetzen Sie den Platzhalter-Schlüssel durch den bei der Anmeldung generierten Schlüssel. Dies stellt sicher, dass alle nachfolgenden Aufrufe die richtige Uncensored-Modellinstanz verwenden.

• Base URL: https://api.nsfwlocalllm.com/v1
• Auth-Header: Authorization: Bearer YOUR_API_KEY

Sie können überprüfen, ob Ihr Schlüssel funktioniert, indem Sie den Modelle-Endpunkt prüfen. Ein gültiger Schlüssel gibt die verfügbare Modell-ID sofort zurück.

Sende eine Chat-Vervollständigungsanfrage

Senden Sie eine Standard-Chat-Vervollständigungs-Payload, um Text zu generieren. Das System verarbeitet Ihre Eingabe und gibt die Antwort des Modells zurück. Verwenden Sie den uncensored Modell-ID, um sicherzustellen, dass Sie die ungefilterte Instanz treffen.

Die Antwort enthält den generierten Text und die Token-Nutzungsstatistiken. Sie können dies direkt in Ihre Anwendungslogik analysieren.

Copycurl https://api.nsfwlocalllm.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Send me the server uptime stats"}]
  }'

Prüfen Sie auf Standard-HTTP-Statuscodes, um Erfolgs- oder Fehlerfälle zu behandeln.

Aktivieren Sie Streaming für Echtzeitausgabe

Streamen Sie Antworten, um die wahrgenommene Latenz für Ihre Benutzer zu reduzieren. Aktivieren Sie das Streaming, indem Sie stream: true in Ihrem Anfragekörper. Die API gibt eine Reihe von Server-Sent Events (SSE) zurück, die teilweise Tokens enthalten.

Aggregieren Sie diese Tokens clientseitig, um die vollständige Nachricht zu rekonstruieren. Dieser Ansatz ist ideal für Chat-Schnittstellen, bei denen sofortiges Feedback wichtig ist. Das letzte SSE-Ereignis enthält die gesamte Token-Nutzung für die Anfrage.

Copyfrom openai import OpenAI

client = OpenAI(base_url="https://api.nsfwlocalllm.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 Verbindungsfehler korrekt, um ein reibungsloses Nutzererlebnis zu gewährleisten.

Verwenden Sie den JSON-Modus für strukturierte Daten

Zwingen Sie das Modell dazu, gültiges JSON für die programmatische Verarbeitung auszugeben. Setzen Sie response_format zu {"type": "json_object"} in Ihrer Anfrage. Dies reduziert Parsing-Fehler und stellt konsistente Datenstrukturen sicher.

Verwenden Sie dies zum Generieren strukturierter Prompts, zum Extrahieren von Entitäten oder zum Erstellen dynamischer Inhalte. Das Modell hält sich an die Formatbeschränkungen, die in Ihren Systemanweisungen angegeben sind. Dies ist entscheidend für eine zuverlässige Integration mit anderen Diensten.

Copyimport OpenAI from "openai";

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

Stellen Sie die JSON-Ausgabe auf Ihrer Seite sicher, um Randfälle abzufangen.

Implementieren Sie Function Calling

Definieren Sie Tools, um die Fähigkeiten des Modells zu erweitern. Übergeben Sie ein tools array mit Funktionsdefinitionen an die Anfrage. Das Modell kann entscheiden, diese Funktionen basierend auf dem Kontext aufzurufen.

Dies ermöglicht komplexe Workflows, bei denen das LLM entscheidet, wann Daten abgerufen oder Aktionen ausgeführt werden sollen. Sie erhalten die Funktionsargumente in der Antwort und führen diese auf Ihrer Seite aus. Übergeben Sie die Ergebnisse zurück an das Modell für weitere Überlegungen.

Festlegen tool_choice zu auto für flexible Entscheidungsfindung. Diese Funktion unterstützt fortgeschrittene Roleplay-Szenarien, die externen Datenzugriff erfordern.

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)