Basis-URL en authenticatie
Onze API volgt de standaard OpenAI chat-completions-interface. Om te integreren, pas je clientconfiguratie aan met onze specifieke basis-URL en een geldige codex api sleutel. Je genereert deze sleutel tijdens de registratie op het dashboard. Het endpoint accepteert zowel standaard- als streamingverzoeken, waardoor het een directe vervanging is voor de meeste codingagents die een OpenAI-compatibele structuur verwachten.
Authenticatie is afhankelijk van de Authorization header. Voeg je sleutel toe als Bearer-token. Als je een proxy of een aangepaste agentframework gebruikt, zorg er dan voor dat deze standaard HTTP-koppen respecteert. De dienst is onafhankelijk; hij routeert niet via andere leveranciers of aggregateert modellen. Je maakt direct verbinding met ons ongecensureerde LLM.
Stuur een chatcompletie
Begin met het testen van een eenvoudig tekstverzoek. Dit bevestigt dat je authenticatie en basis-URL correct zijn. De endpoint accepteert een lijst van berichten met rollen zoals user of assistant. De model-id is altijd uncensored. Dit verzoek retourneert een standaard voltooiingsrespons. Gebruik dit om te verifiëren of je agent de JSON-structuur kan parseren voordat je naar complexe prompts gaat.
Zorg ervoor dat je payload binnen de limiet van 8 MB blijft. Grote contextvensters worden ondersteund, maar het totale tokenaantal (input plus output) moet onder de 100.000 tokens blijven. Als je deze limieten overschrijdt, retourneert de server een fout. Begin met een kleine test om de verbinding te bevestigen.
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."}]
}'Schakel streaming (SSE) in
Voor coding agents die tokengeneratie in real-time nodig hebben, schakel je streaming in. Stel de parameter stream in op true in je request body. De server retourneert een reeks Server-Sent Events (SSE) in plaats van een enkel JSON-object. Elk evenement bevat een gedeeltelijk stuk van het antwoord. Dit vermindert de waargenomen latentie voor je gebruikers en stelt je agent in staat tokens te verwerken zodra ze aankomen.
Streaming verandert de prijs of het tokenaantal niet. Je betaalt nog steeds voor het totale input- en outputtokens. Verwerk de SSE-stream in je clientcode om de definitieve respons te accumuleren of deze incrementeel te verwerken. Dit is ideaal voor codegeneratie waar tussenresultaten nuttig zijn.
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)Gebruik function calling
Ons model ondersteunt function calling, waardoor je agent externe tools kan uitvoeren. Definieer je functies in de parameter tools. Het model retourneert een respons met een tool call in plaats van platte tekst als het beslist dat een functie nodig is. Je agent moet deze respons parseren en de tool uitvoeren, en het resultaat vervolgens terugvoeren in het gesprek.
Deze mogelijkheid is essentieel voor codingagents die code moeten uitvoeren, databases moeten bevragen of live data moeten ophalen. Het toolschema volgt de standaard OpenAI-indeling. Zorg dat je agent de round-trip tussen het model en je tool-executielogica correct afhandelt. Dit houdt het contextvenster efficiënt door ruwe tekst te vervangen door gestructureerde toolresultaten.
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)Controleer beschikbare modellen
Gebruik de GET /v1/models endpoint om de beschikbare modellen te verifiëren. Deze endpoint retourneert een lijst van modelobjecten, inclusief hun IDs en creatiedata. Onze API biedt één model aan: uncensored. In tegenstelling tot proxy-relays die meerdere leveranciers aggregeren, bieden we een dedicated endpoint voor één geoptimaliseerde LLM. Dit zorgt voor consistent gedrag en voorspelbare prestaties voor je coding taken.
Query deze endpoint om te bevestigen dat je client verbonden is met de juiste service. Het retourneert standaard metadatavelden. Je hoeft modelselectie niet handmatig te beheren. De client vraagt eenvoudigweg de model-ID uncensored op in alle chatcompleties. Dit vereenvoudigt de integratie en voorkomt routeringsfouten.
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);Rate limits en beperkingen
Houd je gebruik bij om onderbrekingen te voorkomen. De API handhaaft een limiet van 300 verzoeken per minuut per sleutel. Als je deze overschrijdt, ontvang je een 429 Too Many Requests-fout. De grootte van de request body is beperkt tot 8 MB. Deze beperkingen zorgen voor stabiele prestaties voor high-throughput agents. Pas de frequentie van de verzoeken van je client aan als je grote batches verwerkt.
Authenticatiefouten retourneren een 401-status als de sleutel ongeldig is. Onvoldoende tegoed resulteert in een 402-status. Zorg dat je prepaid tegoed positief is voordat je verzoeken verstuurt. Credits vervallen niet, dus je kunt opwaarderen wanneer het jou schikt. De codex api sleutel kan op elk moment worden geregend, waardoor de oude sleutel direct ongeldig wordt. Houd je sleutel veilig.
