KiApi Документация: интеграция за 5 минут

Начало работы: базовый URL и аутентификация

KiApi полностью совместима с OpenAI API. Вы можете использовать существующую экосистему SDK и клиентов, изменив base_url. Базовый URL для всех запросов: https://api.kiapis.com/v1. Аутентификация осуществляется исключительно с помощью API-ключа, который вы получите после регистрации на странице панели управления. Этот ключ должен передаваться в HTTP-заголовке Authorization: Bearer <IHR_API_SCHLÜSSEL>. Вы можете сгенерировать новый ключ в любое время, после чего старый станет недействительным.

В отличие от других сервисов, мы не предлагаем сложные эндпоинты для эмбеддингов или дообучения. Наш фокус — на чистой генерации текста. KiApi — это ваше прямое подключение к модели, оптимизированной для ответов без цензуры. Убедитесь, что вы правильно настроили окружение перед отправкой первого запроса.

POST /v1/chat/completions: генерация текста

Сердце API — эндпоинт POST /v1/chat/completions. Здесь вы отправляете список сообщений (системные, пользователь, ассистент) и получаете текстовый ответ. Параметр ID модели должен быть установлен в uncensored. Ответ синхронный и сразу содержит сгенерированный фрагмент текста и метаданные об использовании токенов.

Структура запроса соответствует стандартному формату. Вы можете определить роли, чтобы четко структурировать контекст. Система обрабатывает ввод и генерирует ответ на основе изученного поведения модели. Это основной метод для почти всех текстовых приложений, от чат-ботов до анализа текста.

Kopierencurl https://api.kiapis.com/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."}]
  }'

Ответ содержит объект JSON с сгенерированным содержимым. Убедитесь, что вы извлекаете область content из ответа для дальнейшего использования в вашем приложении. Дополнительные метаданные, такие как стоимость запроса, в стандартном ответе не возвращаются; они доступны в панели управления.

Потоковая передача через Server-Sent Events (SSE)

Для приложений, требующих мгновенного вывода, KiApi поддерживает потоковую передачу через Server-Sent Events (SSE). Активируйте это, установив в теле запроса "stream": true. Вместо ожидания полного ответа вы получаете поток JSON-патчей, постепенно содержащих сгенерированный текст.

Это особенно полезно для интерфейсов чатов, где мгновенная обратная связь улучшает пользовательский опыт. Использование KiApi как streaming api позволяет снизить задержку и создать ощущение разговора в реальном времени. Клиент должен распарсить поток и собрать фрагменты, пока не будет сигнализирован конец потока.

Kopierenstream = 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)

При потоковой передаче статистика использования токенов часто возвращается в конце потока в последнем событии. Это позволяет точно начислять оплату на основе фактической длины генерации. Убедитесь, что ваш клиентский код корректно обрабатывает конец потока, чтобы освободить ресурсы.

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

Модель поддерживает вызов инструментов, также известный как вызов функций. Это позволяет LLM возвращать структурированные данные JSON, представляющие конкретные функции или действия в вашем приложении. Вы определяете доступные инструменты в теле запроса, а модель решает на основе ввода пользователя, когда следует вызвать инструмент.

Структура определений инструментов соответствует стандарту OpenAI. Вы можете указать несколько инструментов, и модель выберет наиболее подходящий. Ответ содержит список вызовов инструментов, которые вы затем можете выполнить в своей бэкенд-логике. Это значительно расширяет возможности KiApi за пределы чистой генерации текста.

Kopierenfrom openai import OpenAI

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

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

GET /v1/models: доступные модели

Эндпоинт GET /v1/models перечисляет доступные модели, к которым можно обратиться через API. Это полезно для динамической проверки доступных моделей или подтверждения ID модели. Обычно вы получаете список с моделью uncensored.

Ответ содержит метаданные о модели, такие как ID, владелец и дата создания. В отличие от некоторых других API, стандартный ответ не содержит напрямую максимальную длину контекста или конкретные цены. Эту информацию необходимо получить из документации или панели управления. Однако этот эндпоинт незаменим для автоматической настройки клиентов.

Kopierenimport OpenAI from "openai";

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

Используйте этот эндпоинт, чтобы адаптировать ваше приложение к будущим изменениям. Если добавляются новые модели, они автоматически появляются в этом списке. Текущая модель uncensored — единственная доступная модель, которая характеризуется описанием как большая языковая модель, оптимизированная для нецензурного контента.

Лимит запросов и коды ошибок

Для обеспечения стабильности сервиса действуют определенные лимиты. На один API-ключ разрешено 300 запросов в минуту. Максимальный размер тела запроса составляет 8 МБ. При превышении этих лимитов вы получите код состояния HTTP 429 Too Many Requests. Спланируйте ваше приложение соответствующим образом, чтобы реализовать повторные попытки с экспоненциальной задержкой.

Другие распространенные коды ошибок: 401 Unauthorized, если API-ключ недействителен, и 402 Payment Required, если ваш баланс исчерпан. KiApi использует предоплаченную модель, поэтому запросы без баланса сразу отклоняются. Убедитесь, что вы регулярно проверяете баланс своего счета.

Размер контекстного окна составляет 100 000 токенов для ввода и вывода вместе. При превышении этого лимита возвращается сообщение об ошибке. KiApi — надежное решение для разработчиков, которые ценят четкие правила и прозрачные лимиты.