Швидкий старт: Перший запит
Почніть з того, щоб вказати клієнту на нашу базову URL-адресу. Використовуйте https://api.grockapi.com/v1 та встановити ваш API-ключ у заголовку. Ідентифікатор моделі завжди uncensored. Це працює з будь-яким OpenAI-compatible SDK.
Аутентифікація вимагає дійсний токен Bearer. Передайте його як Authorization: Bearer YOUR_API_KEY. Якщо ключ відсутній або недійсний, ви одразу отримуєте помилку 401.
Зробіть свій перший запит для перевірки з’єднання. Тіло запиту має містити назву моделі та масив messages.
Підтримувані параметри та режими
Налаштуйте поведінку генерації за допомогою стандартних параметрів. Ви можете регулювати temperature для креативності або top_p для nucleus-вибірки. Використовуйте параметр stop для визначення конкретних послідовностей, які зупиняють генерацію.
Встановіть seed для детермінованих виводів під час налагодження. Штрафи за наявність та частоту допомагають зменшити повторення. Модель підтримує до 100,000 токенів у вікні контексту.
Максимальний обсяг виводу обмежено 16 000 токенів за запит. Залиште max_tokens невстановленим, щоб використовувати типовий ліміт виводу 2 048. Помилки та відмови не споживають кредит.
Потокова передача та використання токенів
Увімкніть потокову передачу, встановивши stream: true. API повертає чанки через події, що надсилаються сервером (SSE). Кожен чанк містить частковий вміст та метадані.
Деталі використання токенів з'являються у фінальному чанку. Це дозволяє точно відстежувати витрати в реальному часі. Останній чанк містить повну статистику використання для запиту.
Правильно обробляйте закриття потоку, щоб уникнути витоків ресурсів. Завжди обробляйте останній чанк, щоб отримати точні дані про білінг.
Виклик функцій (Інструменти)
Визначте інструменти в тілі запиту. Вкажіть назви інструментів, описи та схеми параметрів. Модель відповідає викликами інструментів, коли це доречно.
Використовуйте параметр tool_choice, щоб примусово або дозволити певну поведінку. Ви можете встановити його в auto, required або конкретні ідентифікатори інструментів.
Обробляйте виклики інструментів у логіці вашого додатка. Надсилайте вивід інструмента назад моделі, щоб продовжити розмову. Це дозволяє створювати складні багатокрокові робочі процеси без зовнішнього парсингу.
Режим JSON та обмеження
Примусовий структурований вивід шляхом встановлення response_format на json_object. Модель повертатиме валідний JSON без блоків коду markdown.
Цей режим ідеально підходить для парсингу даних у додатки. Переконайтеся, що ваша схема чітка, щоб підвищити точність. Невірні структури JSON можуть викликати помилки парсингу на стороні клієнта.
Поєднуйте режим JSON із контролем температури для послідовного форматування. Використовуйте послідовності зупинки, щоб запобігти появі зайвих символів після закриваючої фігурної дужки.
Ліміти частоти та квоти
Кожний API-ключ обмежено 300 запитами на хвилину. Ви можете одночасно виконувати до 8 паралельних запитів. Максимальний розмір тіла запиту становить 8 МБ.
Помилка 429 вказує на перевищення ліміту швидкості. Зачекайте перед повторною спробою або зменшіть паралелізм. Один активний ключ існує на акаунт; генерація нового ключа замінює старий.
Відстежуйте своє використання через останній потік даних або заголовки відповіді. Помилки, такі як 402 (недостатньо коштів) або 401 (недійсний ключ), є безкоштовними і не враховуються у вашій квоті.
cURL
curl https://api.grockapi.com/v1/chat/completions \
-H "Authorization: Bearer $API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "uncensored",
"messages": [{"role": "user", "content": "calculate the sum of two and three"}]
}'Python
from openai import OpenAI
client = OpenAI(base_url="https://api.grockapi.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)Node.js
import OpenAI from "openai";
const client = new OpenAI({ baseURL: "https://api.grockapi.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);Потокова передача
stream = 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)