Base URL und Authentifizierung
Unsere API folgt der Standard-OpenAI-Chat-Completions-Schnittstelle. Aktualisiere zur Integration die Client-Konfiguration mit unserer Basis-URL und einem gültigen codex api-Schlüssel. Erzeuge diesen Schlüssel im Dashboard. Der Endpunkt akzeptiert Standard- und Streaming-Anfragen und ist ein sofort einsetzbarer Ersatz für die meisten Coding-Agents.
Die Authentifizierung basiert auf dem Authorization Header. Füge deinen Schlüssel als Bearer-Token ein. Wenn du einen Proxy oder ein benutzerdefiniertes Agent-Framework verwendest, stelle sicher, dass er Standard-HTTP-Header respektiert. Der Dienst ist unabhängig; er leitet Anfragen nicht über andere Anbieter weiter oder aggregiert Modelle. Du verbindest dich direkt mit unserem unzensierten LLM.
Chat-Vervollständigung senden
Beginne mit dem Testen einer einfachen Textanfrage. Dies bestätigt, dass deine Authentifizierung und Base URL korrekt sind. Der Endpunkt akzeptiert eine Liste von Nachrichten mit Rollen wie user oder assistant. Die Modell-ID ist immer uncensored. Diese Anfrage gibt eine Standard-Vervollständigungsantwort zurück. Verwende dies, um zu überprüfen, ob dein Agent die JSON-Struktur parsen kann, bevor du zu komplexeren Prompts übergehst.
Stelle sicher, dass dein Anfragetext die 8-MB-Grenze nicht überschreitet. Große Kontextfenster werden unterstützt, aber die Gesamtzahl der Token (Input plus Output) muss unter 100.000 Token bleiben. Wenn du diese Grenzen überschreitest, gibt der Server einen Fehler zurück. Beginne mit einem kleinen Test, um die Verbindung zu bestätigen.
curl https://api.getcodexapi.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."}]
}'Streaming (SSE) aktivieren
Aktiviere für Coding-Agents, die Echtzeit-Token-Generierung benötigen, das Streaming. Setze den Parameter stream in deinem Anfragekörper auf true. Der Server gibt eine Sequenz von Server-Sent Events (SSE) zurück, anstatt eines einzelnen JSON-Objekts. Jedes Ereignis enthält einen Teil der Antwort. Dies reduziert die wahrgenommene Latenz für deine Benutzer und ermöglicht es deinem Agent, Token zu verarbeiten, sobald sie eintreffen.
Streaming ändert nicht die Preisgestaltung oder die Token-Zählung. Du zahlst weiterhin für die Gesamtzahl der Eingabe- und Ausgabetoken. Verarbeite den SSE-Stream in deinem Client-Code, um die endgültige Antwort zu akkumulieren oder inkrementell zu verarbeiten. Dies ist ideal für die Codegenerierung, bei der Zwischenergebnisse nützlich sind.
stream = 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)Function Calling verwenden
Unser Modell unterstützt Function Calling, wodurch dein Agent externe Tools ausführen kann. Definiere deine Funktionen im Parameter tools. Das Modell gibt eine Antwort mit einem Tool-Aufruf zurück, anstatt normalen Text, wenn es bestimmt, dass eine Funktion benötigt wird. Dein Agent muss diese Antwort parsen und das Tool ausführen, dann das Ergebnis zurück in den Konversationsverlauf einspeisen.
Diese Fähigkeit ist entscheidend für Coding-Agents, die Code ausführen, Datenbanken abfragen oder Live-Daten abrufen müssen. Das Tool-Schema folgt dem Standard-OpenAI-Format. Stelle sicher, dass dein Agent den Round-Trip zwischen dem Modell und deiner Tool-Ausführungslogik korrekt verarbeitet. Dies erhält das Kontextfenster effizient, indem roher Text durch strukturierte Tool-Ergebnisse ersetzt wird.
from openai import OpenAI
client = OpenAI(base_url="https://api.getcodexapi.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)Verfügbare Modelle prüfen
Verwende den Endpunkt GET /v1/models, um die verfügbaren Modelle zu überprüfen. Dieser Endpunkt gibt eine Liste von Modellobjekten zurück, einschließlich ihrer IDs und Erstellungsdaten. Unsere API bedient ein einzelnes Modell: uncensored. Im Gegensatz zu Proxy-Relays, die mehrere Anbieter aggregieren, bieten wir einen dedizierten Endpunkt für ein optimiertes LLM. Dies gewährleistet konsistentes Verhalten und vorhersehbare Leistung für deine Coding-Aufgaben.
Führe eine Abfrage dieses Endpunkts durch, um zu bestätigen, dass dein Client mit dem richtigen Dienst verbunden ist. Er gibt Standard-Metadatenfelder zurück. Du musst die Modellauswahl nicht manuell verwalten. Der Client fordert einfach die Modell-ID uncensored in allen Chat-Vervollständigungen an. Dies vereinfacht die Integration und vermeidet Routing-Fehler.
import OpenAI from "openai";
const client = new OpenAI({ baseURL: "https://api.getcodexapi.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);Ratenlimits und Einschränkungen
Überwache deine Nutzung, um Unterbrechungen zu vermeiden. Die API erzwingt ein Limit von 300 Anfragen pro Minute pro Schlüssel. Wenn du dieses überschreitest, erhältst du einen 429 Too Many Requests-Fehler. Die Größe des Anfragekörpers ist auf 8 MB begrenzt. Diese Einschränkungen gewährleisten eine stabile Leistung für Hochdurchsatz-Agents. Passe die Anfragehäufigkeit deines Clients an, wenn du große Batches verarbeitest.
Authentifizierungsfehler geben einen 401-Status zurück, wenn der Schlüssel ungültig ist. Unzureichendes Guthaben führt zu einem 402-Status. Stelle sicher, dass dein Prepaid-Guthaben positiv ist, bevor du Anfragen sendest. Guthaben verfallen nie, sodass du aufladen kannst, wenn es dir passt. Der codex api Schlüssel kann jederzeit neu generiert werden, wodurch der alte sofort widerrufen wird. Halte deinen Schlüssel sicher.
