Schnellstart: Integriere die AI-Girlfriend-API

Base URL und Authentifizierung

Unsere API folgt dem OpenAI-Standard für Chat-Vervollständigungen, was die Integration für bestehende Clients einfach macht. Du musst deinen API-Schlüssel in den Authorization-Header jeder Anfrage aufnehmen. Die Base URL für alle Endpunkte ist https://api.roleplayapi.com/v1. Wenn du offizielle SDKs verwendest, aktualisiere die base_url-Konfiguration, um auf diese Adresse zu verweisen, und gib deinen Schlüssel als api_key an. Diese Einrichtung stellt sicher, dass deine Anfragen unseren dedizierten unzensierten Endpunkt ohne Änderung deiner Standardlogik erreichen.

Vervollständigung senden

Starte eine Konversation, indem du eine POST-Anfrage an /v1/chat/completions sendest. Die Modell-ID ist uncensored. Du kannst eine beliebige Anzahl von Nachrichten im messages-Array übergeben, um Kontext herzustellen oder einen neuen Dialog zu starten. Die Antwort enthält die Textausgabe des Modells, die du streamen oder als JSON-Objekt parsen kannst. Dieser Endpunkt verarbeitet die für charaktergetriebene Apps erforderliche Text-in/Text-out-Interaktion.

Copycurl https://api.roleplayapi.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."}]
  }'

Python SDK-Integration

Verwende die offizielle openai Python-Bibliothek, um die API mit minimalem Gerüstcode zu nutzen. Konfiguriere den Client mit unserer Basis-URL und deinem API-Schlüssel. Rufe dann chat.completions.create mit der Modell-ID uncensored auf. Dieser Ansatz nutzt bestehende Typangaben und Fehlerbehandlungsmechanismen, sodass du dich auf die Anwendungslogik konzentrieren kannst, statt HTTP-Parsing zu betreiben. Das Antwortobjekt gibt den generierten Inhalt direkt frei.

Copyfrom openai import OpenAI

client = OpenAI(base_url="https://api.roleplayapi.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 SDK-Integration

Für JavaScript- und TypeScript-Projekte bietet das OpenAI Node SDK eine saubere Schnittstelle für API-Aufrufe. Initialisiere den Client mit der benutzerdefinierten Basis-URL und deinem Geheimschlüssel. Rufe den Chat-Vervollständigungs-Endpunkt mit dem Modell uncensored auf. Diese Methode ist ideal für Webserver oder Edge-Funktionen, in denen du asynchrone Anfragen effizient verwalten musst. Das SDK übernimmt automatisch die Serialisierung und Deserialisierung der JSON-Payloads.

Copyimport OpenAI from "openai";

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

Reduziere die wahrgenommene Latenz, indem du Server-Sent Events (SSE) aktivierst. Setze den Parameter stream in deiner Anfrage auf true. Die API gibt einen Stream von Chunks zurück, anstatt eine einzelne vollständige Antwort. Dies ist besonders nützlich für Chat-Schnittstellen, bei denen Benutzer sofortige Charakterantworten erwarten. Du kannst jeden Chunk verarbeiten, sobald er eingeht, und die Benutzeroberfläche schrittweise aktualisieren. Der Stream endet, wenn das Modell die Token-Sequenz generiert hat.

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)

Grenzwerte, Fehler und Kontext

Deine Anfragen unterliegen einem Ratenlimit von 300 Anfragen pro Minute pro Schlüssel. Wenn du dieses überschreitest, gibt die API einen 429-Statuscode zurück. Authentifizierungsfehler führen zu einem 401-Fehler, während unzureichendes Prepaid-Guthaben einen 402-Fehler auslöst. Das Kontextfenster unterstützt bis zu 100.000 Token für die kombinierte Anfrage und Vervollständigung. Wenn du verfügbare Modelle prüfen möchtest, sende eine GET-Anfrage an /v1/models. Stelle sicher, dass dein Anfragetext 8 MB nicht überschreitet.