Codex API -dokumentaatio ja päätepisteet

Perus-URL ja todennus

Lähetä pyynnöt perus-URL:iin https://api.codexapipricing.com/v1 API-avaimellasi. Tämä päätepiste on yhteensopiva standardien OpenAI-SDK:ien kanssa, joten sinun tarvitsee vain päivittää base URL ja toimittaa avaimesi. Todennus tapahtuu välittämällä otsikko Authorization: Bearer YOUR_API_KEY jokaista pyyntöä kohti. Voit luoda avaimen välittömästi kirjautumalla sisään Google-tilillä tai sähköpostilla ja salasanalla. Avain näytetään luomisen jälkeen kerran, joten tallenna se turvallisesti. Kysymyksiäsi ei käytetä koulutukseen, mikä varmistaa tietojen yksityisyyden.

Chat completions endpoint

Käytä POST /v1/chat/completions päätepiste tekstin generointiin. Tämä on ensisijainen käyttöliittymä syötteiden lähettämiseen ja vastausten vastaanottamiseen. Mallin ID on aina uncensored, riippumatta palvelimillamme ajettavasta malliversiosta. Voit tarkistaa saatavilla olevat mallit GET /v1/models. Lähetä viestihistoriasi kenttään messages

Tuetut parametrit ja JSON-tila

Säädä tuotantoa käyttämällä parametreja kuten temperature, top_p, ja stop. Käytä response_format asetettuna {"type": "json_object"} pakottaa JSON-tuloksen. Tämä on hyödyllistä rakenteellisen tiedon erottelussa tai funktiokutsuissa. Voit myös asettaa max_tokens rajoittamaan tulosteen pituutta, oletusarvo on 2 048, jos sitä ei määritetä. Kontesttilaajuus tukee jopa 100 000 tokenia sekä promptille että täydennykselle yhdessä. Lähetä seed deterministisiin tuloksiin tai presence_penalty ja frequency_penalty säätämään toistoa. Nämä parametrit mahdollistavat mallin käyttäytymisen hienosäätämisen ilman monimutkaista kokoonpanoa. JSON-tila varmistaa tiukan muotoilun luotettavaan jäsentämiseen sovelluksessa.

Streamausvastaukset SSE:n kautta

Ota streamaus käyttöön asettamalla stream: true pyynnössäsi. API palauttaa palvelimen lähettämiä tapahtumia (SSE) tokenien tuotannon aikana. Tämä vähentää koettua viivettä pitkissä vastauksissa. Tokenien käyttötilastot näkyvät streamin viimeisessä palasessa. Voit käsitellä tokenia porrastetusti näyttääksesi tekstin reaaliajassa. Tämä toiminto toimii kaikkien OpenAI-yhteensopivien SDK:iden kanssa. Streamaus on ihanteellinen keskusteluliittymiin, joissa käyttäjät odottavat välitöntä palautetta. Viimeinen palanen sisältää kokonaistokenimäärän laskutustarkkuuden varmistamiseksi. Käytä tätä menetelmää käsitelläksesi suuria tulosteita joustavasti odottamatta koko vastausta.

Nopeusrajoitukset ja pyyntöruumiit

Jokaisella API-avaimella on rajoitus 300 pyyntöä minuutissa ja 8 samanaikaista pyyntöä. Pyynnön rungon enimmäiskoko on 8 Mt. Jos ylität nämä rajat, saat 429-virheen. Voit luoda uusia avaimia korvaamaan olemassa olevat, mutta tiliä kohti on vain yksi aktiivinen avain. Virheet ja hylkäykset eivät laske nopeusrajoitukseen. 100 000 tokenin kontesttilaakko mahdollistaa laajan keskusteluhistorian. Pidä pyynnön runko tiiviinä pysyäksesi kokorajojen sisällä. Seuraa käyttöäsi välttääksesi keskeytykset ruuhkan aikana. Nämä rajat varmistavat reilun käytön kaikille esimaksuasiakkaille.

Virheenkäsittely ja vianmääritys

Käsittele virheet tarkistamalla HTTP-tilakoodin. Virhekoodi 401 tarkoittaa virheellistä tai puuttuvaa API-avainta. Virhekoodi 402 tarkoittaa, että esimaksusaltonsi on loppu. Virhekoodi 429 ilmoittaa, että olet ylittänyt nopeusrajoitukset. Käytä error kenttä vastauksesta saadaksesi tiedot. Virheet kuten kaksoislaskut korjataan Tuki-sivun kautta. Krediitti ei vanhene, joten voit ladata sitä myöhemmin. Sisältökäytäntöjen rikkomisten hylkäykset ovat ilmaisia. Tämä ennustettava virkerakenne auttaa sinua vianmäärityksessä nopeasti ilman arvaamista.

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);

Virtaus

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)