API-Dokumentation: Schnellstart

Base URL und Authentifizierung

Die serverless llm API verwendet die Standardstruktur der OpenAI-kompatiblen Endpunkte. Um zu beginnen, benötigst du zwei Informationen: deine Base URL und deinen API-Schlüssel.

Verwende die folgende Base URL für alle Anfragen:

https://api.serverlessllmapi.com/v1

Die Authentifizierung erfolgt über den Authorization-Header. Erstelle ein Konto auf der Seite API-Schlüssel abrufen, um deinen Schlüssel zu erhalten. Du kannst diesen Schlüssel jederzeit neu generieren, wodurch der alte sofort ungültig wird. Behalte deinen Schlüssel sicher aufbewahrt, da er direkten Zugriff auf deine Prepaid-Guthaben gewährt.

Erste Anfrage: Chat-Vervollständigungen

Sende eine Standard-Chat-Vervollständigungsanfrage an den Endpunkt /v1/chat/completions. Die API akzeptiert eine Modell-ID, eine Liste von Nachrichten und optionale Parameter. Unsere Standard-Modell-ID ist uncensored, die für hochwertige, uneingeschränkte Antworten optimiert ist.

Hier ist ein einfaches Beispiel mit curl zur Generierung einer Antwort:

Copycurl https://api.serverlessllmapi.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 folgt dem Standard-OpenAI-JSON-Format. Bei erfolgreicher Anfrage erhältst du ein Completion-Objekt, das den generierten Text enthält. Diese Einfachheit ermöglicht es dir, unseren Endpunkt in bestehende OpenAI-SDK-Konfigurationen einzufügen, indem du einfach die Base URL und den Schlüssel änderst.

Python-SDK-Integration

Die Verwendung des offiziellen OpenAI Python SDK ist der schnellste Weg zur Integration. Da unsere API openai compatible api ist, musst du nur die Base URL und den API-Schlüssel überschreiben. Dies stellt sicher, dass dein bestehender Code ohne Änderungen funktioniert.

Copyfrom openai import OpenAI

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

Dieser Ansatz ermöglicht es dir, vertraute Python-Bibliotheken zu nutzen und gleichzeitig von unserem unzensierten Modell zu profitieren. Das Kontextfenster unterstützt bis zu 100.000 Token, was erhebliche Eingabe- und Ausgabelängen innerhalb einer einzigen Anfrage ermöglicht. Stelle sicher, dass dein Nachrichten-Array die erforderlichen System- und User-Prompts enthält, um das Modell effektiv zu steuern.

Node.js-SDK-Integration

Für JavaScript- und TypeScript-Entwickler bietet das OpenAI Node SDK einen straightforward Integrationspfad. Konfiguriere den Client mit unserer Base URL und deinem API-Schlüssel, um sofort Anfragen zu stellen.

Copyimport OpenAI from "openai";

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

Dieses Setup ist ideal für serverless Functions oder Backend-Dienste, die Echtzeit-LLM-Interaktionen erfordern. Die Pay as you go-Preisgestaltung bedeutet, dass du nur für das zahlst, was du nutzt, ohne monatliche Abonnements. Guthaben verfällt nie, sodass du die Nutzung zwischen Projekten pausieren kannst, ohne deinen Saldo zu verlieren.

Streaming-Antworten (SSE)

Aktiviere Streaming, indem du stream: true in deiner Anfrage setzt. Die API gibt einen Server-Sent Events (SSE)-Stream zurück, der es dir ermöglicht, Token in Echtzeit anzuzeigen, während sie generiert werden. Dies reduziert die wahrgenommene Latenz für Endbenutzer und verbessert das Erlebnis für Chat-Anwendungen.

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)

Verarbeite die Stream-Ereignisse in deinem Client-Code, um die finale Antwort zu akkumulieren. Streaming funktioniert mit sowohl dem Python- als auch dem Node-SDK, wenn es korrekt konfiguriert ist. Diese Funktion ist besonders nützlich für die Generierung von Langtext, wo sofortiges Feedback wertvoll ist.

Ratenlimits und Einschränkungen

Verstehe die Einschränkungen, um eine reibungslose Integration zu gewährleisten. Die API erzwingt ein Ratenlimit von 300 Anfragen pro Minute pro API-Schlüssel. Jeder Anfragekörper darf 8 MB nicht überschreiten. Wenn du das Ratenlimit überschreitest, erhältst du einen 429-Statuscode.

Authentifizierungsfehler geben einen 401-Status zurück, der einen ungültigen oder widerrufenen Schlüssel anzeigt. Wenn dein Prepaid-Guthaben aufgebraucht ist, geben Anfragen einen 402-Status zurück. Die Modell-ID uncensored unterstützt keine Embeddings, Bildgenerierung oder Fine-Tuning. Bleibe bei textbasierten Chat-Vervollständigungen für optimale Leistung.