API-dokumentation

Autentisering och bas-URL

Bas-URL:en för alla förfrågningar är https://api.grokapiplatform.com/v1. Autentisera genom att skicka din unika API-nyckel i Authorization header. Varje begäran måste inkludera denna header för att verifiera din kontobalans och tillämpa hastighetsbegränsningar.

Slutpunkt för chattkomplettering

Skicka textförfrågningar till POST /v1/chat/completions. Modell-ID:t att använda är "uncensored". Denna slutpunkt hanterar standardtext-in, text-ut-interaktioner utan att kräva extra konfiguration för grundläggande användning.

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 arbetar med ett kontextfönster på 100,000 tokens. Inmatnings- och utmatningstokens delar denna gräns. Förfrågningar som överskrider kontextfönstret misslyckas omedelbart.

Strömsvar med SSE

Aktivera strömning genom att ställa in stream: true i din förfrågningskropp. Servern returnerar Server-Sent Events (SSE) med inkrementella tokenuppdateringar. Använd detta för realtidsvisningar eller för att minska den upplevda latensen.

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)

Tokenanvändningsdetaljer visas i den sista delen av strömmen. Du kan spåra total förbrukning per begäran utan att parsas varje intermediär delta.

Funktionsanrop och verktyg

Definiera verktyg i tools array och ange tool_choice för att utlösa specifika beteenden. Modellen stöder standardmönster för verktygsanvändning som är kompatibla 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);

Använd tool_choice: "auto" för automatiskt val eller ange ett verktygsnamn för tvingad körning. Detta fungerar sömlöst med den obegränsade modellen för komplexa resonemandsuppgifter.

JSON-läge för strukturerat output

Ställ in response_format för {"type": "json_object"} för att tvinga fram strikt JSON-utdata. Detta minskar parsningsfel vid integration med frontend-applikationer eller datapipelines.

Parameters and limits

Justera temperature, top_p, och seed för att styra slumpmässighet. Maximal utmatning per begäran är 16 000 tokens. Fel som 401 indikerar ogiltiga nycklar, 402 betyder otillräcklig förbetald kredit, och 429 signalerar hastighetsbegränsningar. Gränsen är 300 begäranden per minut per nyckel. Krediten löper aldrig ut, så du kan fylla på med USDT eller USDC när som helst.

Strömning

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)