Dokumentace API

Ověření a základní URL

Základní URL pro všechny požadavky je https://api.grokapiplatform.com/v1. Ověřte se předáním svého unikátního API klíče v Authorization hlavička. Každý požadavek musí obsahovat tuto hlavičku pro ověření zůstatku vašeho účtu a aplikaci limitů rychlosti.

Endpoint Chat completions

Odesílejte textové dotazy na POST /v1/chat/completions. ID modelu, které použijete, je "uncensored". Tento endpoint zpracovává standardní interakce text-v-text-bez vyžadování další konfigurace pro základní použití.

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

Model pracuje s kontextovým oknem o velikosti 100,000 tokenů. Tokeny vstupu a výstupu sdílejí toto omezení. Požadavky přesahující kontextové okno okamžitě selžou.

Streamované odpovědi pomocí SSE

Povolte streamování nastavením stream: true ve vašem těle požadavku. Server vrací události odeslané serverem (SSE) s inkrementálními aktualizacemi tokenů. Použijte to pro reálná zobrazení nebo pro snížení vnímané latence.

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)

Podrobnosti o použití tokenů se objeví ve finálním chunku streamu. Můžete sledovat celkovou spotřebu na požadavek bez parsování každého mezilehlého delta.

Volání funkcí a nástroje

Definujte nástroje v tools pole a nastavte tool_choice pro vyvolání specifických chování. Model podporuje standardní vzorce používání nástrojů kompatibilní s SDK OpenAI.

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

Použít tool_choice: "auto" pro automatický výběr nebo zadejte název nástroje pro vynucené spuštění. To bezproblémově funguje s modelem bez omezení pro složité úkoly logického uvažování.

Režim JSON pro strukturovaný výstup

Nastavit response_format na {"type": "json_object"} pro vynucení přísného výstupu JSON. To snižuje chyby parsování při integraci s frontendovými aplikacemi nebo datovými pipeline.

Parametry a limity

Upravit temperature, top_p, a seed pro ovládání náhodnosti. Maximální výstup na požadavek je 16 000 tokenů. Chyby jako 401 znamenají neplatný klíč, 402 znamená nedostatek předplaceného kreditu a 429 signalizuje limity rychlosti. Limit je 300 požadavků za minutu na klíč. Kredit nevyprší, takže jej můžete kdykoli doplnit pomocí USDT nebo USDC.

Streamování

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)