Dokumentace a endpointy API Codex

Základní URL a ověření

Odesílejte požadavky na základní URL https://api.codexapipricing.com/v1 pomocí vašeho API klíče. Tento endpoint je kompatibilní se standardními SDK pro OpenAI, takže stačí aktualizovat základní URL a zadat svůj klíč. Autentizujte se předáním hlavičky Authorization: Bearer YOUR_API_KEY s každým požadavkem. Klíč můžete vygenerovat okamžitě přihlášením přes Google nebo e-mail a heslo. Klíč se zobrazí jednou po vytvoření, takže si jej bezpečně uložte. Vaše prompty nejsou používány pro trénování, což zajišťuje soukromí vašich dat.

Endpoint Chat completions

Použijte POST /v1/chat/completions endpoint pro generování textu. Toto je primární rozhraní pro odesílání promptů a přijímání odpovědí. ID modelu je vždy uncensored, bez ohledu na verzi modelu běžící na našich serverech. Dostupné modely můžete zkontrolovat přes GET /v1/models. Pošlete historii zpráv v messages

Podporované parametry a režim JSON

Ovládejte generování pomocí parametrů jako temperature, top_p, a stop. Použijte response_format nastaveno na {"type": "json_object"} abyste vynutili výstup JSON. To je užitečné pro extrakci strukturovaných dat nebo volání funkcí. Můžete také nastavit max_tokens omezit délku výstupu, výchozí hodnota je 2 048, pokud není uvedeno jinak. Okno kontextu podporuje až 100 000 tokenů pro prompt a dokončení dohromady. Předložte seed pro deterministické výsledky nebo presence_penalty a frequency_penalty k úpravě opakování. Tyto parametry umožňují jemné ladění chování modelu bez složité konfigurace. Režim JSON zajišťuje přísné formátování pro spolehlivé parsování ve vaší aplikaci.

Streamované odpovědi přes SSE

Povolte streamování nastavením stream: true ve vaší žádosti. API vrací Server-Sent Events (SSE), jak jsou generovány tokeny. To snižuje vnímanou latenci u dlouhých odpovědí. Statistiky využití tokenů se zobrazí v posledním bloku streamu. Tokeny můžete zpracovávat inkrementálně pro reálné zobrazení textu. Tato funkce funguje se všemi OpenAI-kompatibilními SDK. Streamování je ideální pro chatová rozhraní, kde uživatelé očekávají okamžitou zpětnou vazbu. Poslední blok obsahuje celkový počet tokenů pro přesnost fakturace. Použijte tuto metodu k elegantnímu zpracování velkých výstupů bez čekání na kompletní odpověď.

Limitu rychlosti a těla požadavku

Každý API klíč je omezen na 300 požadavků za minutu a 8 souběžných požadavků. Maximální velikost těla požadavku je 8 MB. Pokud tyto limity překročíte, obdržíte chybu 429. Můžete vygenerovat nové klíče a nahradit tak existující, ale na účet je aktivní pouze jeden klíč. Chyby a odmítnutí se nezapočítávají do vašeho limitu rychlosti. Kontextové okno o 100 000 tokenů umožňuje rozsáhlou historii konverzací. Udržujte těla požadavků stručná, abyste se vešli do limitů velikosti. Sledujte své využití, abyste předešli přerušení během špičkových dob. Tyto limity zajišťují férové využití pro všechny předplacené zákazníky.

Zpracování chyb a řešení problémů

Zpracujte chyby kontrolou HTTP status kódu. Chyba 401 označuje neplatný nebo chybějící API klíč. Chyba 402 znamená, že je vyčerpán váš předplacený kredit. Chyba 429 signalizuje, že jste překročili limity rychlosti. Použijte error pole v odpovědi pro získání podrobností. Chyby jako dvojí účtování jsou opraveny na stránce Podpora. Kredit nevyprší, takže můžete doplnit později. Odmítnutí kvůli porušení politiky obsahu jsou zdarma. Tato předvídatelná struktura chyb vám pomáhá rychle ladit integrační problémy bez hádání příčiny.

cURL

Copycurl https://api.codexapipricing.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "List the hourly rates for the large model."}]
  }'

Python

Copyfrom openai import OpenAI

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

Node.js

Copyimport OpenAI from "openai";

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

Streamování

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)