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

Базова URL-адреса та аутентифікація

Підключіться до API, використовуючи надану базову URL-адресу та ключ попередньо оплаченого токену. Аутентифікація здійснюється шляхом передачі вашого API-ключа в заголовку запиту, що гарантує доступ до ваших кредитів лише вашому обліковому запису. Зареєструйтеся через Google або електронну пошту, щоб отримати ключ миттєво без верифікації телефоном.

Copycurl https://api.kimicodeapi.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "What is the current rate limit for free tier users?"}]
  }'

Ваші запити спрямовані на стандартний OpenAI-сумісний endpoint. Така архітектура дозволяє підключити наш сервіс без переписування існуючого клієнтського коду, якщо ви оновите базовий URL та облікові дані.

Ендпоінт Chat Completions

Надсилайте повідомлення до моделі за допомогою POST /v1/chat/completions endpoint. Ви повинні вказати ідентифікатор моделі як uncensored для доступу до оптимізованої великої мовної моделі, що працює на наших серверах. Система приймає стандартні ролі повідомлень, такі як user або assistant, для багатозадачних розмов.

Copyfrom openai import OpenAI

client = OpenAI(base_url="https://api.kimicodeapi.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 в запиті. API повертає фрагменти подій, надсиланих сервером (SSE), що дозволяє вашому додатку відображати текст у міру його генерації. Останній фрагмент містить повну статистику використання токенів для билінгу.

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)

Потокова передача зменшує сприйнятну затримку для кінцевих користувачів. Ви можете обробляти кожен токен по мірі його надходження, що ідеально підходить для чат-інтерфейсів. Пам’ятайте, що потокова передача не змінює поведінку базової моделі або цінування токенів.

Function Calling та інструменти

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

Copyimport OpenAI from "openai";

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

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

Режим JSON та параметри

Примусовий суворий вивід JSON шляхом встановлення response_format до {"type": "json_object"}. Це забезпечує, що модель повертає дійсний JSON, що є вирішальним для програмного парсингу. Ви також можете регулювати параметри, такі як temperature, top_p та послідовності стопу, щоб контролювати креативність та довжину виводу.

Модель підтримує вікно контексту на 100,000 токенів. Це дозволяє передавати великі обсяги контексту за один запит. Максимальний вивід становить 16,000 токенів за запит або 2,048, якщо ви не вказали max_tokens.

Ліміти, помилки та контекст

Моніторьте ліміти запитів, щоб уникнути переривання служби. API дозволяє 300 запитів на хвилину на ключ та до 8 одночасних запитів. Ваше тіло запиту має бути меншим за 8 МБ. Якщо ви перевищите ці ліміти, ви отримаєте помилку ліміту швидкості 429.

Збої автентифікації повертають помилку 401, якщо ключ недійсний. Помилка 402 вказує на недостатність попередньо оплаченого кредиту. Помилки під час генерації не споживають ваші токени. Контекстне вікно включає токени запиту та завершення. Невикористаний кредит ніколи не прострочується, гарантуючи, що ваш попередньо оплачений баланс залишається доступним для майбутніх проектів.