Документация API, совместимого с OpenAI

Быстрый старт: Подключение с SDK OpenAI

Начните аутентификацию с помощью ключа и укажите клиенту наш базовый URL. Эта настройка работает с официальными SDK OpenAI для Python и Node.js, что гарантирует возможность запуска одного и того же клиентского кода против нашего сервиса. Вам нужен действительный API-ключ из панели управления и правильная конфигурация эндпоинта.

Copycurl https://api.openaiapicompatible.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Return the current UTC timestamp in ISO 8601 format"}]
  }'

Copyfrom openai import OpenAI

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

Copyimport OpenAI from "openai";

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

Эндпоинт Chat Completions

Отправьте текст в наш единственный эндпоинт чата для прямого текстового вывода. Мы используем POST /v1/chat/completions для обработки ваших запросов и возврата сгенерированного текста. Это основное взаимодействие для большинства приложений LLM, не требующее сложной маршрутизации или дополнительных вызовов сервисов.

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)

Потоковая передача с SSE

Получайте токены в реальном времени с использованием Server-Sent Events для снижения задержки. Включите потоковую передачу, установив параметр stream в true в вашем запросе. Последний фрагмент включает данные об использовании токенов, позволяя точно отслеживать расходы по мере генерации текста моделью. Этот подход поддерживает отзывчивость вашего пользовательского интерфейса даже для длинных выводов.

Вызов функций & JSON Mode

Интегрируйте инструменты и обеспечьте структурированный вывод для надежного программно-ориентированного взаимодействия. Используйте параметр tools для определения схем функций и установите response_format в json_object для строгого соответствия JSON. Наша модель без цензуры обрабатывает сложные инструкции и пограничные случаи без отказа от валидных функциональных запросов.

Лимиты и параметры

Отслеживайте использование в рамках строгих лимитов на ключ, чтобы избежать прерывания сервиса. Вам разрешено 300 запросов в минуту и восемь одновременных запросов на ключ, с лимитом тела 8 МБ. Ошибки, такие как 401 (неверный ключ), 402 (нет кредита) и 429 (превышен лимит скорости), указывают на конкретное состояние аккаунта.

Контекстное окно и ограничения

Максимизируйте обработку контекста с помощью окна в 100 000 токенов для объединенного ввода и вывода. Установите max_tokens для контроля длины генерации, по умолчанию используется значение 2 048, если не указано иное. Наша модель работает на проприетарных серверах, а не в качестве прокси для других поставщиков, что обеспечивает стабильную производительность для вашего конкретного сценария использования.