Базовый URL и аутентификация
Подключитесь к API, используя предоставленный базовый URL и предоплаченный ключ API. Аутентификация осуществляется путем передачи вашего API-ключа в заголовке запроса, что гарантирует доступ к вашим кредитам только вашей учетной записи. Зарегистрируйтесь через Google или электронную почту, чтобы получить ключ мгновенно без проверки по номеру телефона.
curl 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. Такая архитектура позволяет подключить наш сервис без переписывания существующего клиентского кода, при условии обновления базового URL и учетных данных.
Эндпоинт Chat Completions
Отправляйте сообщения модели с помощью POST /v1/chat/completions endpoint. Вы должны указать идентификатор модели как uncensored для доступа к оптимизированной большой языковой модели, работающей на наших серверах. Система принимает стандартные роли сообщений, такие как пользователь или ассистент, для многошаговых разговоров.
from 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 возвращает чанки Server-Sent Events (SSE), позволяя вашему приложению отображать текст по мере его генерации. Последний чанк содержит полную статистику использования токенов для биллинга.
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)Потоковая передача снижает воспринимаемую задержку для конечных пользователей. Вы можете обрабатывать каждый токен по мере его поступления, что идеально подходит для чат-интерфейсов. Помните, что потоковая передача не изменяет поведение базовой модели или стоимость токенов.
Function Calling и инструменты
Определите инструменты в запросе, чтобы позволить модели возвращать структурированные вызовы функций. API поддерживает параметры tool_choice, позволяя принудительно заставить модель использовать конкретный инструмент или предоставить ей автономное решение. Эта функция работает со стандартными форматами инструментов OpenAI, что упрощает интеграцию.
import 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 указывает на недостаточный предоплаченный кредит. Ошибки во время генерации не потребляют ваши токены. Контекстное окно включает токены как запроса, так и завершения. Непотребленный кредит никогда не истекает, обеспечивая доступность вашего предоплаченного баланса для будущих проектов.
