KiApi Dokumentation: Integration in 5 Minuten

Erste Schritte: Basis-URL und Authentifizierung

Die KiApi ist vollständig mit der OpenAI API konform. Sie können das bestehende Ökosystem von SDKs und Clients nutzen, indem Sie die base_url anpassen. Die Basis-URL für alle Anfragen lautet https://api.kiapis.com/v1. Die Authentifizierung erfolgt ausschließlich über einen API-Schlüssel, den Sie nach der Registrierung auf Ihrer Dashboard-Seite erhalten. Dieser Schlüssel muss im HTTP-Header Authorization: Bearer <IHR_API_SCHLÜSSEL> übermittelt werden. Sie können jederzeit einen neuen Schlüssel generieren, wodurch der alte ungültig wird.

Im Gegensatz zu anderen Diensten bieten wir keine komplexen Endpunkte für Embeddings oder Fine-Tuning. Unser Fokus liegt auf der reinen Textgenerierung. Die KiApi ist Ihre direkte Verbindung zu einem Modell, das für unzensierte Antworten optimiert ist. Stellen Sie sicher, dass Sie Ihre Umgebung korrekt konfigurieren, bevor Sie Ihre erste Anfrage senden.

POST /v1/chat/completions: Textgenerierung

Das Herzstück der API ist der Endpunkt POST /v1/chat/completions. Hier senden Sie eine Liste von Nachrichten (System, Benutzer, Assistent) und erhalten eine textuelle Antwort. Das Modell-ID-Parameter muss auf uncensored gesetzt werden. Die Antwort ist synchron und enthält sofort das generierte Textfragment sowie Metadaten zur Token-Nutzung.

Die Struktur der Anfrage folgt dem Standard-Format. Sie können Rollen definieren, um den Kontext klar zu strukturieren. Das System verarbeitet die Eingabe und generiert eine Antwort basierend auf dem gelernten Verhalten des Modells. Dies ist die primäre Methode für fast alle Textanwendungen, von Chatbots bis zur Textanalyse.

Kopierencurl https://api.kiapis.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Write a blunt product review of a cheap VPN."}]
  }'

Die Antwort enthält ein JSON-Objekt mit den generierten Inhalten. Stellen Sie sicher, dass Sie den content Bereich aus der Antwort extrahieren, um ihn in Ihrer Anwendung weiterzuverwenden. Es werden keine zusätzlichen Metadaten wie Kosten pro Anfrage in der Standardantwort zurückgegeben, diese finden Sie im Dashboard.

Streaming mit Server-Sent Events (SSE)

Für Anwendungen, die eine sofortige Ausgabe benötigen, unterstützt die KiApi Streaming über Server-Sent Events (SSE). Aktivieren Sie dies, indem Sie im Request-Body "stream": true setzen. Anstatt auf eine vollständige Antwort zu warten, erhalten Sie einen Datenstrom von JSON-Patches, die schrittweise den generierten Text enthalten.

Dies ist besonders nützlich für Chat-Oberflächen, wo sofortiges Feedback die Nutzererfahrung verbessert. Die KiApi als streaming api ermöglicht es Ihnen, Latenz zu reduzieren und das Gefühl einer Echtzeit-Konversation zu erzeugen. Der Client muss den Datenstrom parsen und die Fragmente zusammenfügen, bis das Stream-Ende signalisiert wird.

Kopierenstream = 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)

Beim Streaming werden die Token-Nutzungsstatistiken oft am Ende des Streams im letzten Event zurückgegeben. Dies erlaubt eine genaue Abrechnung basierend auf der tatsächlichen Generierungslänge. Stellen Sie sicher, dass Ihr Client-Code mit dem Stream-Ende umgeht, um Ressourcen korrekt freizugeben.

Tool Calling und Funktionsaufrufe

Das Modell unterstützt Tool Calling, auch bekannt als Function Calling. Dies ermöglicht es dem LLM, strukturierte JSON-Daten zurückzugeben, die spezifische Funktionen oder Aktionen in Ihrer Anwendung repräsentieren. Sie definieren die verfügbaren Tools im Request-Body, und das Modell entscheidet basierend auf der Benutzereingabe, wann ein Tool aufgerufen werden soll.

Die Struktur der Tool-Definitionen folgt dem OpenAI-Standard. Sie können mehrere Tools angeben, und das Modell wählt das am besten geeignete aus. Die Antwort enthält eine Liste von Tool-Aufrufen, die Sie dann in Ihrer Backend-Logik ausführen können. Dies erweitert die Möglichkeiten der KiApi weit über reine Textgenerierung hinaus.

Kopierenfrom openai import OpenAI

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

Nutzen Sie Tool Calling, um komplexe Workflows zu automatisieren. Das Modell liefert die Parameter für das Tool direkt im JSON-Format. Sie müssen keine externen Parser für die Antwort verwenden, da die Struktur direkt vom Modell stammt. Dies macht die Integration in bestehende Systeme erheblich einfacher und zuverlässiger.

GET /v1/models: Verfügbare Modelle

Der Endpunkt GET /v1/models listet die verfügbaren Modelle auf, die über die API angesprochen werden können. Dies ist nützlich, um dynamisch zu prüfen, welche Modelle verfügbar sind, oder um die ID des Modells zu bestätigen. In der Regel erhalten Sie eine Liste mit dem Modell uncensored.

Die Antwort enthält Metadaten zum Modell, wie ID, Eigentümer und Erstellungsdatum. Im Gegensatz zu einigen anderen APIs enthält die Standardantwort nicht direkt die maximale Kontextlänge oder spezifische Preise. Diese Informationen müssen aus der Dokumentation oder dem Dashboard entnommen werden. Dieser Endpunkt ist jedoch unverzichtbar für die automatische Konfiguration von Clients.

Kopierenimport OpenAI from "openai";

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

Verwenden Sie diesen Endpunkt, um Ihre Anwendung an zukünftige Änderungen anzupassen. Wenn neue Modelle hinzugefügt werden, erscheinen sie automatisch in dieser Liste. Das aktuelle Modell uncensored ist das einzige verfügbare Modell und wird durch die Beschreibung als großes Sprachmodell charakterisiert, das für unzensierte Inhalte optimiert ist.

Ratenbegrenzungen und Fehlercodes

Um die Stabilität des Dienstes zu gewährleisten, gelten bestimmte Limits. Pro API-Schlüssel sind 300 Anfragen pro Minute erlaubt. Der maximale Request-Body beträgt 8 MB. Wenn Sie diese Limits überschreiten, erhalten Sie den HTTP-Statuscode 429 Too Many Requests. Planen Sie Ihre Anwendung entsprechend, um Wiederholungsversuche mit exponentiellem Backoff zu implementieren.

Weitere häufige Fehlercodes sind 401 Unauthorized, wenn der API-Schlüssel ungültig ist, und 402 Payment Required, wenn Ihr Guthaben aufgebraucht ist. Die KiApi verwendet ein Prepaid-Modell, sodass Anfragen ohne Guthaben sofort abgelehnt werden. Stellen Sie sicher, dass Sie Ihre Kontostände regelmäßig überprüfen.

Das Kontextfenster beträgt 64.000 Token für Eingabe und Ausgabe zusammen. Überschreiten Sie dieses Limit, wird eine Fehlermeldung zurückgegeben. Die KiApi ist eine zuverlässige Lösung für Entwickler, die klare Regeln und transparente Limits schätzen.