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

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

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

Эндпоинт 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 массив и set 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. Это снижает ошибки парсинга при интеграции с фронтенд-приложениями или конвейерами данных.

Параметры и лимиты

Настроить 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)