Быстрый старт для пользователей Grok NSFW

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

Наш API реализует протокол, совместимый с openai. Вы аутентифицируетесь, передавая свой уникальный API-ключ в заголовке Authorization. Базовый URL для всех запросов — https://api.groknsfw.cc/v1. В отличие от стандартных провайдеров, нам не требуется определенный идентификатор организации. Просто сгенерируйте ключ через панель управления или страницу быстрой регистрации. Храните ключ в безопасности; он обеспечивает полный доступ к вашему предоплаченному балансу. Нет ежемесячных платежей или подписок, только оплата по факту использования токенов без срока действия.

Каждый запрос должен содержать идентификатор модели uncensored. Эта модель — большая языковая модель с открытыми весами, размещённая на нашей инфраструктуре, отдельная от других поставщиков. Она настроена на предоставление неограниченных ответов для законного контента для взрослых при сохранении высокой фактологической точности. Вам не нужно менять версию библиотеки клиента; стандартные SDK OpenAI работают сразу.

Базовое завершение чата

Отправьте стандартный запрос на завершение чата для генерации текста. Эндпоинт принимает список сообщений, включая роли system, user и assistant. Эта структура позволяет определять контекст, инструкции и историю разговора. Модель возвращает текстовый ответ на основе предоставленного промпта. Вы можете контролировать креативность вывода с помощью таких параметров, как temperature и top_p. Если не указан max_tokens, лимит вывода по умолчанию составляет 2 048 токенов. Вы можете увеличить его до 32 000 токенов на запрос в рамках общего контекстного окна на 100 000 токенов.

Ошибки возвращаются в стандартном формате JSON. Распространенные проблемы включают недействительные ключи или недостаточный баланс. API не выполняет токенизацию за вас; вы отправляете текст, а модель обрабатывает его внутренне. Вы получаете сгенерированный текст или частичные потоки, если они включены.

Потоковые ответы

Вызов функций и инструменты

API поддерживает вызов функций, позволяя модели выводить структурированные данные вместо обычного текста. Определите свои инструменты в параметре tools, указав имя функции, описание и схему параметров. Когда модель определяет, что вызов инструмента необходим, она возвращает имя функции и аргументы в формате JSON. Ваше приложение затем выполняет функцию и возвращает результат в разговор. Это позволяет создавать сложные рабочие процессы, извлекать данные и выполнять автоматические действия. Установите tool_choice, чтобы контролировать, должна ли модель использовать инструмент или может выбирать свободно.

JSON-режим

Для приложений, требующих строгих форматов вывода, используйте JSON-режим. Установите параметр response_format в значение {"type": "json_object"}. Модель ограничит свой вывод допустимым JSON. Это идеально подходит для разбора данных в ваших бэкенд-системах или генерации структурированных конфигураций. Обратите внимание, что JSON-режим может немного снизить гибкость рассуждений модели по сравнению со свободным текстом. Убедитесь, что ваш промпт чётко указывает модели выводить только JSON. Эта функция работает вместе с вызовом функций, но предоставляет более простой интерфейс, когда вам нужны только структурированные данные без определений инструментов.

Использование токенов и лимиты

Ваш аккаунт ограничен 300 запросами в минуту и 8 параллельными запросами на ключ. Максимальный размер тела запроса составляет 8 МБ. Если вы превысите эти лимиты, API вернёт код статуса 429. Ошибки аутентификации возвращают 401, а недостаточный кредит возвращает 402. Тарификация составляет $0,25 за миллион входных токенов и $1,00 за миллион выходных токенов. Ошибки и отказы не расходуют кредит. Контекстное окно составляет 100 000 токенов в сумме, включая промпт и завершение. Тщательно управляйте использованием токенов, чтобы избежать неожиданных расходов. Кредит никогда не сгорает, и вы можете пополнить его в любое время с помощью криптовалюты.

cURL

Copycurl https://api.groknsfw.cc/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Write a blunt product review of a cheap VPN."}]
  }'

Python

Copyfrom openai import OpenAI

client = OpenAI(base_url="https://api.groknsfw.cc/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)

Node.js

Copyimport OpenAI from "openai";

const client = new OpenAI({ baseURL: "https://api.groknsfw.cc/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);

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

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)