Codex-API-Schlüssel für Entwickler erklärt

Verständnis des API-Schlüssel-Formats

Wenn du dich bei einem Dienst anmeldest, der einen codex api key bereitstellt, erhältst du einen einzigartigen alphanumerischen String. Dieser Schlüssel fungiert als deine Anmeldeinformationen für jede Anfrage, die an das Backend gesendet wird. Das Format folgt in der Regel einem Standardmuster, wie sk-... oder ähnlichen Präfixen, je nach Implementierung des Anbieters. Da du jedoch einen unabhängigen Proxy verwendest, kann das genaue Präfix variieren. Der entscheidende Faktor ist nicht das Format selbst, sondern die korrekte Übergabe des Schlüssels im HTTP-Header Authorization als Bearer <your_key>.

Dein API-Schlüssel ist mit einem bestimmten Konto und einer bestimmten Nutzungsebene verknüpft. Im Gegensatz zu einigen Diensten, die mehrere Schlüssel für verschiedene Umgebungen generieren (dev vs. prod), ist unsere Einrichtung unkompliziert: ein Konto, ein Schlüssel. Wenn du deinen Schlüssel verlierst oder vermutest, dass er kompromittiert wurde, kannst du ihn sofort über dein Dashboard neu generieren. Dadurch wird der alte Schlüssel sofort widerrufen, sodass kein unbefugter Zugriff mehr möglich ist. Denke daran, deine Umgebungsvariablen oder Konfigurationsdateien zu aktualisieren, wenn du Schlüssel rotierst.

Sicherheits-Best-Practices

• Speichere deinen Schlüssel in Umgebungsvariablen, nicht in deinem Quellcode.
• Checke deinen codex api key niemals in öffentliche Repositories ein.
• Verwende die Regenerieren-Funktion, wenn du eine Exposition vermutest.

Häufiger Fehler: 401 Unauthorized

Ein 401 Unauthorized-Fehler ist das häufigste Problem bei der Integration eines neuen API-Schlüssels. Er bedeutet, dass der Server die Authentifizierung abgelehnt hat. Bei einem claude code proxy oder einem OpenAI-kompatiblen Endpunkt bedeutet dies meist, dass der Schlüssel fehlt, falsch oder abgelaufen ist.

Zur Fehlerbehebung überprüfe zunächst, ob du den Schlüssel exakt so kopierst, wie er angegeben ist. Schlüssel sind oft groß- und kleinschreibungssensitiv und können Leerzeichen enthalten, wenn sie falsch kopiert wurden. Stelle sicher, dass du die korrekte Base-URL für deine Region oder Service-Tier verwendest. Wenn du deinen Schlüssel kürzlich neu generiert hast, stelle sicher, dass dein Client den neuen Wert verwendet. Ein 401-Fehler hat nichts mit deinem Nutzungsguthaben oder Ratenlimits zu tun; es handelt sich ausschließlich um einen Authentifizierungsfehler.

Checkliste zur Lösung

1. Bestätige, dass der API-Schlüssel-String exakt mit dem Dashboard übereinstimmt.
2. Überprüfe das Format des Authorization-Headers: Authorization: Bearer YOUR_KEY.
3. Überprüfe, ob die Base URL für deinen Kontotyp korrekt ist.
4. Stelle sicher, dass beim Kopieren und Einfügen keine zusätzlichen Leerzeichen hinzugefügt wurden.

Ratenlimit überschritten: 429-Fehler

Wenn du dein erlaubtes Anfragevolumen überschreitest, gibt die API einen 429 Too Many Requests-Fehler zurück. Für unseren Dienst ist das Limit auf 300 Anfragen pro Minute pro Schlüssel festgelegt. Dieses Limit wird durchgesetzt, um eine faire Nutzung zu gewährleisten und eine niedrige Latenz für alle Benutzer aufrechtzuerhalten. Wenn du Codierungssessions mit hohem Volumen ausführst, kannst du dieses Limit schnell erreichen, insbesondere wenn dein Code mehrere interne Anfragen auslöst.

Wenn ein 429-Fehler auftritt, enthält die Antwort normalerweise einen Retry-After-Header, der angibt, wie viele Sekunden du warten solltest, bevor du es erneut versuchst. Die Implementierung von Exponential Backoff im Client-Code ist der Standardweg, um diese Fehler elegant zu behandeln. Warte anstatt sofort erneut zu versuchen eine kurze Zeit und verdopple dann die Wartezeit für nachfolgende Versuche. Dies verhindert, dass deine Anwendung den Server mit Anfragen überflutet, während das Limit zurückgesetzt wird.

Es ist wichtig zu beachten, dass Ratenlimits pro Schlüssel und nicht pro Konto gelten. Wenn du mehrere Geräte oder Prozesse hast, die denselben Schlüssel verwenden, teilen sie sich das Budget von 300 Anfragen/Minute. Erwäge, separate Schlüssel für verschiedene Umgebungen zu verwenden, wenn du einen höheren aggregierten Durchsatz benötigst.

Base URL korrekt konfigurieren

Die Base URL ist die Grundlage jeder API-Integration. Für einen OpenAI-kompatiblen Dienst bestimmt die Base URL, wohin deine Anfragen gesendet werden. Unsere Base URL ist https://api.claudecodeapikey.com/v1. Diese URL muss in deiner Client-Bibliothek oder deinem SDK konfiguriert werden, bevor Anfragen gesendet werden. Wenn du die falsche Base URL verwendest, erhältst du Verbindungsfehler oder unerwartete Antworten.

Viele Entwickler verwenden das offizielle OpenAI-SDK für Python, Node.js oder andere Sprachen. Um zu unserem Proxy zu wechseln, aktualisierst du einfach die Base URL-Konfiguration. Zum Beispiel kannst du in Python base_url='https://api.claudecodeapikey.com/v1' setzen. Stelle sicher, dass das Protokoll (https) und der Pfad (/v1) korrekt sind. Das Weglassen des /v1-Pfads ist ein häufiger Fehler, der zu 404-Fehlern führt.

Überprüfe immer, ob dein Client Anfragen an den richtigen Endpunkt sendet. Dies kannst du tun, indem du deine Netzwerkprotokolle überprüfst oder ein Tool wie curl verwendest, um die Verbindung zu testen. Eine erfolgreiche Verbindung zur Base URL bestätigt, dass deine Konfiguration korrekt ist.

Streaming-Antworten verarbeiten

Streaming-Antworten ermöglichen es dir, Teile der API-Antwort zu empfangen, während sie generiert werden, anstatt auf die vollständige Antwort zu warten. Dies ist entscheidend für Coding-Agents, die Code-Snippets in Echtzeit anzeigen. Unsere API unterstützt Streaming über Server-Sent Events (SSE). Wenn du Streaming in deinem Client aktivierst, erhältst du einen Stream von Chunks, die jeweils eine Teilantwort enthalten.

Um Streaming zu aktivieren, setze den stream-Parameter auf true in deiner Anfrage. Die Client-Bibliothek verarbeitet dann das SSE-Protokoll automatisch. Du kannst jeden Chunk verarbeiten, sobald er eintrifft, und deine Benutzeroberfläche aktualisieren oder den Fortschritt protokollieren. Dies bietet eine bessere Benutzererfahrung, insbesondere für lange Codegenerierungen.

Streaming ändert nicht das zugrunde liegende Modell oder seine Fähigkeiten. Es ist rein ein Transportmechanismus. Das Modell verarbeitet weiterhin den gesamten Prompt und generiert die vollständige Antwort; der Unterschied liegt darin, wie die Ausgabe an deinen Client übermittelt wird.

Copyfrom openai import OpenAI

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

Probleme bei der Tool-Calling-Konfiguration

Tool Calling (oder Function Calling) ermöglicht es dem LLM, spezifische Aktionen anzufordern, wie das Ausführen eines Code-Snippets oder das Abfragen einer Datenbank. Unsere API unterstützt Tool Calling, was bedeutet, dass du Funktionen in deiner Anfrage definieren und strukturierte JSON-Antworten vom Modell erhalten kannst. Dies ist entscheidend für fortgeschrittene Coding-Agents, die mit externen Systemen interagieren müssen.

Um Tool Calling zu konfigurieren, musst du eine Liste von Funktionsdefinitionen im tools-Parameter angeben. Jedes Tool sollte einen Namen, eine Beschreibung und ein Parameterschema haben. Das Modell entscheidet dann basierend auf dem Prompt, wann es ein Tool aufrufen soll. Wenn das Modell sich entscheidet, ein Tool aufzurufen, enthält die Antwort ein tool_calls-Array mit dem Funktionsnamen und den Argumenten.

Häufige Probleme ergeben sich aus falschen JSON-Schema-Definitionen. Stelle sicher, dass deine Parametertypen und erforderlichen Felder genau angegeben sind. Wenn das Schema ungültig ist, kann das Modell das Tool möglicherweise nicht korrekt aufrufen. Teste deine Tool-Definitionen mit einfachen Prompts, um zu überprüfen, ob das Modell das erwartete Verhalten versteht.

Kontextfenster-Grenzen

Das Kontextfenster definiert die maximale Menge an Text, die das Modell in einer einzelnen Anfrage verarbeiten kann, einschließlich sowohl des Prompts (Input) als auch der Completion (Output). Unser Modell hat ein Kontextfenster von 100.000 Token. Dies ist eine erhebliche Menge an Text, aber sie ist nicht unendlich. Wenn dein Prompt plus die erwartete Ausgabe dieses Limit überschreitet, gibt die API einen Fehler zurück.

Um den Kontext effizient zu verwalten, überwache die Token-Nutzung deiner Prompts. Lange Dateien oder umfangreiche Gesprächsverläufe können die verfügbaren Token schnell verbrauchen. Wenn du dich dem Limit näherst, erwäge, ältere Nachrichten zu kürzen oder frühere Interaktionen zusammenzufassen. Einige Clients verarbeiten dies automatisch durch Verschieben des Fensters, aber es ist am besten, sich des Limits bewusst zu sein, um unerwartete Fehler zu vermeiden.

Denke daran, dass das Kontextfenster alle Token umfasst, die an das Modell gesendet werden, einschließlich Systemnachrichten, Benutzernachrichten und Assistentennachrichten. Plane dein Token-Budget entsprechend, um einen reibungslosen Betrieb während langer Codierungssessions zu gewährleisten.

Deinen Schlüssel neu generieren

Das Erneuern deines API-Schlüssels ist ein einfacher Vorgang, der die Sicherheit gewährleistet. Wenn du vermutest, dass dein Schlüssel freigegeben wurde oder du deine Anmeldedaten regelmäßig rotieren möchtest, kannst du einen neuen Schlüssel in deinem Dashboard generieren. Der alte Schlüssel wird sofort ungültig, sodass alle laufenden Anfragen mit dem alten Schlüssel fehlschlagen.

Wenn du einen Schlüssel erneuerst, stelle sicher, dass du alle deine Clients und Konfigurationen mit dem neuen Wert aktualisierst. Dazu gehören Umgebungsvariablen, Konfigurationsdateien und alle hartcodierten Werte in deinem Code. Wenn du nicht alle Stellen aktualisierst, kann dies zu Authentifizierungsfehlern in einigen Teilen deiner Anwendung führen.

Unser Dienst ermöglicht unbegrenzte Schlüssel-Erneuerungen. Es gibt keine Strafe dafür, deinen Schlüssel häufig zu rotieren. Dies ist eine gute Praxis zur Aufrechterhaltung der Sicherheit, insbesondere in gemeinsam genutzten Umgebungen oder wenn Schlüssel an Teammitglieder verteilt werden.

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