Dokumentacja API

Uwierzytelnianie i URL bazowy

Podstawowy adres URL dla wszystkich żądań to https://api.grokapiplatform.com/v1. Uwierzytelnij się, przekazując unikalny klucz API w Authorization Nagłówek. Każde żądanie musi zawierać ten nagłówek, aby zweryfikować saldo konta i zastosować limity szybkości.

Punkt końcowy uzupełnień czatu

Wyślij zapytania tekstowe do POST /v1/chat/completions. ID modelu do użycia to "uncensored". To endpoint obsługuje standardowe interakcje tekst-w-wejściu, tekst-w-wyjściu bez konieczności dodatkowej konfiguracji do podstawowego użycia.

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 operuje w oknie kontekstowym o pojemności 100,000 tokenów. Tokeny wejściowe i wyjściowe dzielą ten limit. Żądania przekraczające okno kontekstowe zostaną odrzucone natychmiast.

Strumieniowanie odpowiedzi z SSE

Włącz strumieniowanie, ustawiając stream: true w ciele żądania. Serwer zwraca zdarzenia wysłane przez serwer (SSE) z inkrementalnymi aktualizacjami tokenów. Użyj tego dla wyświetleń w czasie rzeczywistym lub aby zmniejszyć postrzeganą opóźnienie.

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)

Szczegóły zużycia tokenów pojawiają się w ostatnim fragmencie strumienia. Możesz śledzić całkowite zużycie dla każdego żądania, nie parsując każdego pośredniego delta.

Wywoływanie funkcji i narzędzia

Zdefiniuj narzędzia w tools tablica i ustaw tool_choice do wywołania konkretnych zachowań. Model obsługuje standardowe wzorce używania narzędzi kompatybilne z 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);

Użyj tool_choice: "auto" dla automatycznego wyboru lub podaj nazwę narzędzia dla wymuszonego wykonania. Działa to płynnie z modelem bez cenzury w zadaniach wymagających złożonego rozumowania.

Tryb JSON dla danych wyjściowych strukturalnych

Ustaw response_format do {"type": "json_object"} do wymuszenia ścisłego wyjścia JSON. Zmniejsza to błędy parsowania podczas integracji z aplikacjami frontendowymi lub potokami danych.

Parametry i limity

Dostosuj temperature, top_p, a także seed do kontrolowania losowości. Maksymalne wyjście w jednym żądaniu to 16 000 tokenów. Błędy takie jak 401 oznaczają nieprawidłowe klucze, 402 oznacza niewystarczający z góry opłacony kredyt, a 429 sygnalizuje limity szybkości. Limit to 300 żądań na minutę na klucz. Kredyt nigdy nie wygasa, więc możesz doładować USDT lub USDC w dowolnym momencie.

Strumieniowanie

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)