API-dokumentation

Autentificering og base URL

Base-URL'en til alle anmodninger er https://api.grokapiplatform.com/v1. Autentificer ved at sende din unikke API-nøgle i Authorization header. Hver anmodning skal indeholde denne header for at verificere din kontobalance og anvende hastighedsbegrænsninger.

Chat completions endpoint

Send tekstforespørgsler til POST /v1/chat/completions. Model-ID'et, der skal bruges, er "uncensored". Denne endpoint håndterer standard tekst-ind, tekst-ud interaktioner uden at kræve ekstra konfiguration til grundlæggende brug.

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."}]
  }'

Modellen opererer med et kontekstvindue på 100,000 tokens. Input- og output-tokens deler denne grænse. Anmodninger, der overstiger kontekstvinduet, vil fejle med det samme.

Streaming-respons med SSE

Aktivér streaming ved at indstille stream: true i din anmodningskrop. Serveren returnerer Server-Sent Events (SSE) med inkrementelle tokenopdateringer. Brug dette til realtidsvisninger eller for at reducere den opfattede latens.

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)

Tokenforbrugsdetaljer vises i den sidste chunk af streamet. Du kan spore det samlede forbrug pr. anmodning uden at parse hver mellemstående delta.

Funktionssamtaler og værktøjer

Definer værktøjer i tools array og indstil tool_choice til at udløse specifikke adfærdsmønstre. Modellen understøtter standard værktøjsbrugsmønstre kompatible med OpenAI SDK'er.

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

Brug tool_choice: "auto" for automatisk selection eller angiv et værktøjsnavn for tvungen eksekvering. Dette fungerer sømløst med den ubegrænsede model til komplekse ræsonnementopgaver.

JSON-mode til struktureret output

Indstil response_format til {"type": "json_object"} til at håndhæve streng JSON-output. Dette reducerer parsingfejl, når du integrerer med frontend-applikationer eller datapipelines.

Parameters and limits

Juster temperature, top_p, og seed til at kontrollere tilfældighed. Det maksimale output pr. anmodning er 16,000 tokens. Feil som 401 indikerer ugyldige nøgler, 402 betyder utilstrækkelig forudbetalt kredit, og 429 signalerer satsgrænser. Grænsen er 300 anmodninger i minuttet pr. nøgle. Kredit udløber aldrig, så du kan toppede op med USDT eller USDC, når det passer dig.

Streaming

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)