Zum Hauptinhalt springen

API-Schnellstart

/ API-Doku

Als Markdown anzeigen

OpenCheese AI ist ein KI-Gateway mit OpenAI-kompatiblen und Anthropic-kompatiblen APIs. Mit einem einzigen OpenCheese-API-Schlüssel erreichst du jedes Modell, das für dein Konto freigeschaltet ist, auch die kostenlosen. Jede Anfrage wird mit ihrem Tokenverbrauch und ihren Kosten im Dashboard erfasst.

Jede Seite dieser Dokumentation gibt es auch als Markdown: Hänge .md an ihre Adresse an, zum Beispiel /de/docs.md für diese Seite.

01API-Schlüssel erstellen

Melde dich auf opencheese.dev an, öffne API-Schlüssel und erstelle einen Schlüssel. Bewahre ihn auf dem Server auf: Ein privilegierter Schlüssel hat in öffentlichem Frontend-Code nichts zu suchen.

02API-Host und Basis-URLs

Das Gateway läuft unter https://api.opencheese.dev, einem anderen Host als die Website. Anfragen an opencheese.dev liefern die Website, keine API-Antwort.

Client Basis-URL
OpenAI-SDKs und OpenAI-kompatible Clients (OpenCode, Codex, Harness AI, Zed, Chatbox, RikkaHub) https://api.opencheese.dev/v1
Anthropic-SDKs und Anthropic-kompatible Clients (Claude Code, Claude Desktop) https://api.opencheese.dev

Anthropic-SDKs hängen /v1/messages selbst an, deshalb darf ihre Basis-URL nicht auf /v1 enden. Einige Apps verlangen auch im Anthropic-Modus die Adresse bis einschließlich /v1; welche Form eine App braucht, steht in ihrer Anleitung weiter unten.

03Authentifizierung

Sende den Schlüssel als Bearer-Token:

text
Authorization: Bearer YOUR_OPENCHEESE_API_KEY

Clients im Anthropic-Stil können ihn stattdessen als x-api-key: YOUR_OPENCHEESE_API_KEY senden.

Die Beispiele lesen den Schlüssel aus OPENCHEESE_API_KEY. Der Schlüssel enthält $-Zeichen. Setze die Variable deshalb in einfache Anführungszeichen, die diese Zeichen unverändert lassen (doppelte Anführungszeichen würden sie expandieren und den Schlüssel unbrauchbar machen):

bash
export OPENCHEESE_API_KEY='YOUR_OPENCHEESE_API_KEY'

In PowerShell: $env:OPENCHEESE_API_KEY = 'YOUR_OPENCHEESE_API_KEY'.

04Modelle auflisten, die dein Schlüssel nutzen kann

bash
curl https://api.opencheese.dev/v1/models \
  -H "Authorization: Bearer $OPENCHEESE_API_KEY"

Verwende eine id aus dieser Liste. Der Zugriff hängt von deinem Tarif und den Modellbeschränkungen des Schlüssels ab; kopiere also keine Modell-IDs aus alten Beispielen. Die Seite Modell-API erklärt jedes Feld.

05Eine erste Anfrage senden

OpenAI Chat Completions:

bash
curl https://api.opencheese.dev/v1/chat/completions \
  -H "Authorization: Bearer $OPENCHEESE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"model": "MODEL_ID", "messages": [{"role": "user", "content": "Hello"}]}'

Anthropic Messages:

bash
curl https://api.opencheese.dev/v1/messages \
  -H "x-api-key: $OPENCHEESE_API_KEY" \
  -H "anthropic-version: 2023-06-01" \
  -H "Content-Type: application/json" \
  -d '{"model": "MODEL_ID", "max_tokens": 1024, "messages": [{"role": "user", "content": "Hello"}]}'

Mit dem Python-SDK von OpenAI:

python
from openai import OpenAI

client = OpenAI(base_url="https://api.opencheese.dev/v1", api_key="YOUR_OPENCHEESE_API_KEY")
reply = client.chat.completions.create(
    model="MODEL_ID",
    messages=[{"role": "user", "content": "Hello"}],
)
print(reply.choices[0].message.content)

06Eine Unterhaltung zusammenhalten

Sende bei jeder Anfrage einer Unterhaltung denselben Header opencheese-session-uuid, damit das Dashboard sie als eine Sitzung anzeigt. Eine Anfrage ohne diesen Header ist eine eigene Sitzung. Wann du ihn senden solltest, steht unter Sitzungen.

Endpunkte

Endpunkt Protokoll Zweck
GET /v1/models OpenAI Modelle, die der Schlüssel nutzen kann
POST /v1/chat/completions OpenAI Chat, Streaming und Tools
POST /v1/responses OpenAI Responses Responses-Clients wie Codex
POST /v1/messages Anthropic Claude Code und Anthropic-SDKs
POST /v1/messages/count_tokens Anthropic Tokens zählen, ohne Berechnung
POST /v1/images/generations OpenAI Images Bilder erzeugen
POST /v1/images/edits OpenAI Images (multipart) Bilder bearbeiten
GET /v1/images/capabilities OpenCheese Parameter der Bildmodelle
GET /v1/key OpenCheese Ausgabenlimit und Verbrauch des Schlüssels
GET /v1/plan OpenCheese Zeitfenster des Tarifs und Guthaben-Optionen
GET /v1/balance OpenCheese Guthaben und Verbrauch in diesem Monat

Fähigkeiten wie Streaming, Tools, Bildeingabe und Reasoning-Stufen hängen vom Modell ab: Prüfe das Modell in /v1/models, bevor du dich auf eine davon verlässt.

Alle Seiten

Erste Schritte

  • Sitzungen: Eine Unterhaltung, eine Sitzung: der Header opencheese-session-uuid.

API-Referenz

  • Modelle: GET /v1/models und was jedes Feld bedeutet.
  • Chat Completions: POST /v1/chat/completions: Streaming, Tools, Bilder, Reasoning-Stufe.
  • Responses: POST /v1/responses: Eingabe, Streaming-Events, Tools.
  • Messages: POST /v1/messages und /v1/messages/count_tokens.
  • Bilder: Bilder mit der Images-API von OpenAI erzeugen und bearbeiten.
  • Schlüssel, Tarif und Guthaben: GET /v1/key, /v1/plan und /v1/balance.
  • Fehler und Limits: Fehlerformate, Codes, Ratenlimits und erneute Versuche.

Entwicklertools

  • Claude Code: ANTHROPIC_BASE_URL, API-Schlüssel und Modell-Aliase in der settings.json.
  • Claude Desktop: Drittanbieter-Inferenzmodus mit einer importierten Konfigurationsdatei.
  • Codex: Ein Modellanbieter in der config.toml auf der Responses-API.
  • OpenCode: Auto-Sync oder ein OpenAI-kompatibler Anbieter in opencode.json.
  • Harness AI: Ein benutzerdefinierter Anbieter, dazu Reasoning-Stufen in settings.yaml.
  • Zed: Ein openai_compatible-Anbieter in settings.json.
  • VS Code und JetBrains: Die Erweiterungen für Claude Code und Codex mit den CLI-Einstellungen.

Chat-Apps

  • RikkaHub: Ein OpenAI- oder Claude-Anbieter in der Android-App.
  • Chatbox: Ein OpenAI-API-kompatibler Anbieter, auf Smartphone oder Desktop.
  • LobeHub: Ein Anbietereintrag mit der richtigen Adresse für jedes Format.

Fehler

Die meisten Fehler kommen als HTTP-Status mit einem JSON-Fehlerobjekt zurück. Bei /v1/chat/completions kommen Probleme, um die du dich kümmern musst (ein ungültiger Schlüssel, ein Tariflimit, ein leeres Guthaben), als Antwort des Assistenten, damit Chat-Apps dir die Meldung anzeigen. Fehler und Ratenlimits listet jeden Code auf.

Tarife und Preise

Die Tarife findest du auf der Startseite. Die Preise pro Modell stehen nach der Anmeldung auf der Seite Preise im Dashboard.

Weitere Hilfe

Der Käse hat Löcher. Deine Infrastruktur sollte keine haben.