API-dokumentaatio

Todennus ja base URL

API vaatii bearer-tokenin jokaiseen pyyntöön. Luo avain Get API key -sivulla kirjautumalla Google-tilillä tai sähköpostin salasanalla. Avain näkyy välittömästi ilman puhelinverifikaatiota. Käytä base URL -osoitetta https://api.uncensoredaigithub.com/v1 virallisilla OpenAI-SDK:lla päivittämällä base_url ja api_key arvoja. Tämä kokoonpano toimii minkä tahansa OpenAI-yhteensopivan asiakkaan kanssa.

Päätepiste: https://api.uncensoredaigithub.com/v1

Auth-otsake: Authorization: Bearer YOUR_API_KEY

Jokaiselle tilille tuetaan yhtä aktiivista avainta. Uuden avaimen antaminen mitätöi automaattisesti edellisen. Tämä estää tokenien hajaantumisen, kun vaihdat tunnuksia eri ympäristöissä.

Chat Completions Endpoint

Lähetä tekstipyyntöjä osoitteeseen /v1/chat/completions päätepiste käyttäen mallin ID:tä uncensored. API hyväksyy standardit viestit ja palauttaa tekstimääritykset ilman sisältösuodattimia lailliseen aikuis käyttöön. Voit määrittää parametreja kuten temperature, top_p, ja stop hallita luovuutta ja lähdön pituutta.

Kontekstiluukko tukee jopa 100 000 tokenia yhdistettynä promptiin ja completioniin. Aseta max_tokens hallitsemaan tuotosta, oletusarvo on 2 048 tokeniä, jos tätä ei määritetä. Virheet ja hylkäykset eivät kuluta luottopäiviä, joten voit testata turvallisesti.

Streamausvastaukset ja käyttö

Ota streamaus käyttöön asettamalla stream: true pyynnössäsi. API palauttaa palvelimen lähettämiä tapahtumia (SSE), jotka sisältävät osittaisia tekstipaloja. Tokenien käyttödata näkyy vain streamin viimeisessä palasessa. Tämä mahdollistaa vastausten reaaliaikaisen renderöinnin ja kulutuksen tarkan seurannan.

Streamaus on ihanteellinen roolipelisovelluksiin tai pitkän sisällön luomiseen. Voit jäsentää SSE-streamia päivittääksesi käyttöliittymää askel askeleelta. API varmistaa, että käyttötilastot pysyvät tarkkoina, vaikka yhteys katkeaisi ennenaikaisesti.

Funktikutsut ja työkalut

Tuki funktiokutsuille tarjoamalla tools taulukko pyynnössä. Malli voi palauttaa rakenteellisia työkalukutsuja argumentteineen. Käytä tool_choice pakottaa tiettyjä käyttäytymismalleja, kuten automaattista funktion suorittamista. Tämä ominaisuus mahdollistaa integroinnin ulkoisiin palveluihin tai mukautettuun logiikkaan.

Määritä funktiot nimillä, kuvauksilla ja parametrikaavoilla. API palauttaa funktion nimen ja argumentit vastauksessa. Jäsentele nämä argumentit suorittaaksesi mukautetun koodisi. Tämä ominaisuus tekee uncensored LLM API:sta sopivan monimutkaisiin agenttityövuorokuvauksiin.

JSON-tila ja parametrit

Pakota rakenteellinen tuloste asettamalla response_format vastaan {"type": "json_object"}. Malli palauttaa kelvollisen JSON-muodon tavallisen tekstin sijasta. Tämä on hyödyllistä tietojen erotteluun tai konfiguraatiogenerointiin. Yhdistä tämä työkalukutsuihin vahvojen API-integraatioiden luomiseksi.

Muut tuetut parametrit sisältävät seed deterministisiin tuloksiin, presence_penalty, ja frequency_penalty. Käytä seed toistaa tiettyjä vastauksia vianmääritystä varten. Säädä rangaistuksia vähentämään toistoa tai edistämään monipuolista sanastoa tuloksissasi.

Virheenkäsittely ja rajat

API rajoittaa nopeutta 300 pyyntöön minuutissa ja sallii 8 samanaikaista pyyntöä avainta kohti. Pyyntöjen rungon koko ei saa ylittää 8 Mt. Jos ylität nämä rajat, saat HTTP-virhekoodin 429. Tunnistautumisvirheet palauttavat virhekoodin 401. Riittämätön saldo aiheuttaa virhekoodin 402.

Luotto lasketaan todellisen token-käytön perusteella. Esimaksuluotto vanhenee koskaan, joten sinun ei tarvitse huolehtia kuukausittaisista uusimisista. Käytä Tuki-sivua ratkaisemaan ongelmia kuten kaksoislaskut.

cURL

Copycurl https://api.uncensoredaigithub.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Run the unit tests for the new auth module."}]
  }'

Python

Copyfrom openai import OpenAI

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