Документація API: Сумісні з OpenAI ендпоінти

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

Отримайте доступ до API, встановивши свій унікальний ключ та базовий URL у змінних середовища. Ендпоінт знаходиться за адресою https://api.apikeykimi.com/v1. Ви повинні включити заголовок Authorization: Bearer YOUR_API_KEY з кожним запитом. Цей ключ генерується миттєво під час реєстрації через Google або електронну пошту. Це єдина облікова дана, необхідна для автентифікації. Не потрібно налаштовувати області дії або дозволи.

Copycurl https://api.apikeykimi.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "convert this json object to python dictionary syntax"}]
  }'

Ендпоінт Chat Completions

Надсилайте повідомлення до моделі за допомогою стандартного /v1/chat/completions endpoint. endpoint. Вкажіть ідентифікатор моделі як uncensored у тілі запиту. API повертає згенерований текст на основі історії ваших промптів. Ви можете налаштувати параметри, такі як temperature та top_p, щоб контролювати креативність. Модель підтримує виклик функцій та режим JSON для структурованих виводів.

Copyfrom openai import OpenAI

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

Потокові відповіді (SSE)

Увімкнути доставку токенів у реальному часі, встановивши stream: true у вашому запиті. Сервер повертає потік подій, що генеруються сервером. Кожен чанк містить частковий текст, доки відповідь не буде завершена. Це ідеально підходить для чат-інтерфейсів та дисплеїв живого коду. Деталі використання токенів з'являються в останньому чанку потоку.

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)

Виклик функцій & Режим JSON

Визначте інструменти або вимусьте вивід у форматі JSON за допомогою response_format параметр. Встановіть json_object щоб забезпечити валідні відповіді у форматі JSON. Ви також можете передати визначення інструментів для виклику функцій. Модель суворо дотримується цих обмежень. Це дозволяє надійно інтегруватися з зовнішніми службами. Використовуйте tool_choice для контролю того, як інструменти викликаються.

Ліміти токенів та обмеження

Вікно контексту підтримує до 100 000 токенів для вхідних та вихідних даних разом. Максимальний об’єм відповіді за один запит становить 16 000 токенів. Якщо ви не встановите max_tokens, ліміт за замовчуванням становить 2048 токенів. Розмір тіла запиту обмежений 8 МБ. Ви обмежені 300 запитами на хвилину. Одночасно може виконуватися лише 8 запитів на ключ.

Обробка помилок та обмеження використання

Обробляйте помилки, перевіряючи код HTTP-статусу. Статус 401 вказує на недійсний або прострочений API-ключ. Помилка 402 означає, що ваш попередньо оплачений кредит вичерпано. Відповідь 429 сигналізує про перевищення ліміту швидкості — 300 запитів на хвилину. Помилки та відмови не споживають токени. Перевіряйте баланс на панелі керування, щоб уникнути перерв.

Node.js

Copyimport OpenAI from "openai";

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