Документація API

Автентифікація та базовий URL

Базовий URL для всіх запитів є https://api.grokapiplatform.com/v1. Аутентифікуйтеся, передавши свій унікальний API-ключ в Authorization header. Кожен запит повинен містити цей заголовок для перевірки балансу вашого облікового запису та встановлення лімітів швидкості.

Ендпоінт Chat Completions

Надсилайте текстові запити до POST /v1/chat/completions. Ідентифікатор моделі, який слід використовувати, — "uncensored". Цей ендпоінт обробляє стандартні взаємодії "текст вхідний, текст вихідний" без необхідності додаткової конфігурації для базового використання.

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

Модель працює з контекстним вікном на 100,000 токенів. Вхідні та вихідні токени ділять це обмеження. Запити, що перевищують контекстне вікно, будуть негайно відхилені.

Потокова передача відповідей з SSE

Увімкніть потокову передачу, встановивши stream: true у тілі вашого запиту. Сервер повертає події, надіслані сервером (SSE) з поступовими оновленнями токенів. Використовуйте це для відображення в реальному часі або для зменшення сприйнятої затримки.

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)

Деталі використання токенів з'являються у фінальному чанку потоку. Ви можете відстежувати загальне споживання на один запит, не парсячи кожен проміжний дельта-дані.

Виклик функцій та інструменти

Визначте інструменти в tools масив та встановити tool_choice для виклику специфічних поведінок. Модель підтримує стандартні шаблони використання інструментів, сумісні з 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);

Використовувати tool_choice: "auto" для автоматичного вибору або вкажіть назву інструмента для примусового виконання. Це безперервно працює з uncensored моделлю для завдань складного міркування.

Режим JSON для структурованого виводу

Встановити response_format до {"type": "json_object"} для примусового суворого виводу JSON. Це зменшує помилки парсингування при інтеграції з фронтенд-додатками або конвеєрами даних.

Parameters and limits

Налаштувати temperature, top_p, а також seed для контролю випадковості. Максимальний вивід за запит становить 16 000 токенів. Помилки, такі як 401, вказують на недійсні ключі, 402 означає недостатній попередньо оплачений кредит, а 429 сигналізує про ліміти швидкості. Ліміт становить 300 запитів на хвилину на ключ. Кредит ніколи не закінчується, тому ви можете поповнити рахунок USDT або USDC у будь-який час.

Потокова передача

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)