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

Быстрый старт: Первый запрос на Python или JS

Отправьте первый запрос и сразу получите сырой текстовый вывод. API принимает стандартные полезный груз chat-completion, поэтому вы можете подставить наш базовый URL и ключ, чтобы начать генерировать контент без ограничений, не переписывая логику. Используйте следующую команду cURL для проверки подключения и доступности модели перед интеграцией в ваш код.

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

Copycurl https://api.chatunrestricted.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "List the three main endpoints for user authentication"}]
  }'

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

Аутентификация путем передачи вашего API-ключа в HTTP-заголовке. Все запросы должны направляться на базовый URL https://api.chatunrestricted.com/v1 для обеспечения совместимости с SDK OpenAI. Вы можете мгновенно сгенерировать свой ключ через панель управления с использованием учётных данных Google или электронной почты, без необходимости указания номера телефона.

Ключ API идентифицирует вашу учетную запись и отслеживает использование токенов против вашего предоплаченного баланса. Храните этот ключ в безопасности, так как он обеспечивает прямой доступ к вашим кредитам. На одну учетную запись допускается только один активный ключ; генерация нового ключа автоматически делает предыдущий недействительным.

POST /v1/chat/completions

Генерируйте текст, отправив POST-запрос на эндпоинт chat completions. Идентификатор модели — uncensored, что запускает модель с открытыми весами, настроенную на ответы без отказов по содержанию для законного использования для взрослых. Вы можете контролировать длину вывода, случайность и условия остановки с помощью стандартных параметров.

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

Copyfrom openai import OpenAI

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

GET /v1/models

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

Используйте этот эндпоинт для отладки проблем с подключением перед отправкой дорогих запросов на генерацию. Он возвращает стандартные метаданные модели, совместимые с OpenAI, включая идентификатор модели и тип объекта.

Copyimport OpenAI from "openai";

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

Параметры: Temperature, Top P, Seed

Управляйте случайностью и детерминированностью ваших выходов с помощью стандартных параметров сэмплирования. Установите temperature между 0 и 2 для настройки креативности и используйте top_p чтобы ограничить nucleus sampling. Значение seed parameter позволяет воспроизводить конкретные результаты для отладки или сценариев ролевой игры.

Эти параметры напрямую влияют на то, как модель генерирует текст. Более высокие температуры дают более разнообразные ответы, в то время как низкие температуры делают вывод более сфокусированным и предсказуемым. Используйте stop последовательности для остановки генерации в определенных маркерах.

Стриминг, инструменты и JSON-режим

Потоковая передача ответов в реальном времени с использованием Server-Sent Events (SSE) для снижения задержки. Включите режим JSON, установив response_format для json_object для извлечения структурированных данных. Поддерживается вызов инструментов для выполнения функций, что позволяет модели вызывать внешние API.

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

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)

Лимиты и тарификация

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

Выставление счетов предоплачено и основано на фактическом использовании токенов. Ошибки и отказы не расходуют кредит. Если вы получаете ошибку 401, ваш API-ключ недействителен. Ошибка 402 указывает на недостаточный кредит, а ошибка 429 означает превышение лимита частоты запросов. Контекстное окно поддерживает 100,000 токенов для промпта и завершения в сумме.