API-dokumentaatio

Todennus ja base URL

Kaikkien pyyntöjen base URL on https://api.grokapiplatform.com/v1. Todenna välittämällä ainutlaatuinen API-avaimesi Authorization header. Jokaisen pyynnön on sisällettävä tämä header varmistaaksesi tilisi saldon ja soveltaaksesi nopeusrajoituksia.

Chat completions endpoint

Lähetä tekstikyselyjä osoitteeseen POST /v1/chat/completions. Käytettävä mallin tunnus on "uncensored". Tämä päätepiste käsittelee standarditekstinsyötteen ja -tulosteen vuorovaikutusta ilman, että peruskäyttöön tarvitaan lisäasetuksia.

Copycurl https://api.grokapiplatform.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Check my current token usage balance."}]
  }'

Malli toimii 100,000 tokenin kontekstiikkunalla. Syöttö- ja tulostokenit jakavat tämän rajan. Kontekstiikkunaa ylittävät pyynnöt epäonnistuvat välittömästi.

Strimausvastaukset SSE:n kautta

Ota streamaus käyttöön asettamalla stream: true pyyntörunkossa. Palvelin palauttaa palveluntason tapahtumia (SSE) sisältäviä tokenpäivityksiä. Käytä tätä reaaliaikaisiin näyttöihin tai koetun viiveen vähentämiseen.

Copyfrom openai import OpenAI

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

Token-käyttötiedot ilmestyvät streamin viimeisessä palasessa. Voit seurata kokonaiskulutusta pyyntöä kohden ilman, että sinun tarvitsee jäsentää jokaista väliinputoa.

Toimintokutsut ja työkalut

Määritä työkalut tools taulukko ja aseta tool_choice laukaista tiettyjä käyttäytymisiä. Malli tukee standardia työkalukäyttöä, joka on yhteensopiva OpenAI-SDK:n kanssa.

Copyimport OpenAI from "openai";

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

Käyttö tool_choice: "auto" automaattista valintaa varten tai määritä työkalun nimi pakotettua suoritusta varten. Tämä toimii saumattomasti uncensored-mallin kanssa monimutkaisissa päättelytehtävissä.

JSON-tila rakenteiseen tulokseen

Aseta response_format vastaan {"type": "json_object"} pakottaa tiukan JSON-tulosteen. Tämä vähentää jäsentamisvirheitä integroitessa etusivun sovelluksiin tai dataputkistoihin.

Parameters and limits

Säädä temperature, top_p, ja seed hallitsemaan satunnaisuutta. Maksimituotos pyyntöä kohden on 16 000 tokeniä. Virheet kuten 401 viittaavat virheellisiin avaimiin, 402 tarkoittaa riittämätöntä esimaksusaldoa ja 429 merkitsee nopeusrajoituksia. Rajoitus on 300 pyyntöä minuutissa avainta kohden. Luottopäivät vanhenevat, joten voit täydentää saldoa USDT:llä tai USDC:llä milloin tahansa.

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)