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

Быстрый старт: Ваш первый запрос

Отправьте первое сообщение в uncensored-модель сразу. Используйте стандартный конечный пункт chat-completions для генерации текста. Модель отвечает на запросы естественным языком без отказов по содержанию для законного использования взрослыми. Эта настройка работает с любым клиентом, совместимым с OpenAI.

Начните с установки SDK для предпочитаемого языка. Затем настройте ваш API-ключ. Следующий пример показывает базовый запрос curl для проверки подключения.

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

Copycurl https://api.apiaicharacter.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 API rate limit status?"}]
  }'

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

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

Сгенерируйте ключ через панель управления. Передавайте его в заголовке Authorization как Bearer-токен. Этот метод совместим со стандартными SDK OpenAI. Вы можете сменить провайдера, изменив только базовый URL и ключ.

Храните ваш ключ в безопасности. Он предоставляет полный доступ к вашему предоплаченному кредиту. Ключ немедленно заменяет любой предыдущий активный ключ при генерации.

Конечные точки: Завершение диалога

Взаимодействие с моделью через конечную точку chat completions. Это единственная доступная конечная точка для генерации текста. Она принимает сообщения и возвращает сгенерированный текст. Поддержка встраиваний, изображений или аудио не предусмотрена.

Отправьте POST-запрос на маршрут chat. Включите системные и пользовательские сообщения в тело. Модель обрабатывает контекст и генерирует ответ. Вы можете использовать режим JSON для структурированного вывода.

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

Copyfrom openai import OpenAI

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

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

Управляйте стилем вывода с помощью стандартных параметров. Настройте temperature для изменения креативности. Низкие значения делают ответы более детерминированными. Высокие значения добавляют больше разнообразия.

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

Параметр seed позволяет получать воспроизводимые результаты. Используйте его при отладке ваших промптов. Эти параметры дают вам точный контроль над поведением модели. Настройте их в соответствии с потребностями вашего приложения.

Copyimport OpenAI from "openai";

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

Потоковая передача и использование токенов

Получайте ответы в реальном времени, используя server-sent events. Потоковая передача снижает воспринимаемую задержку для пользователей. 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)

Лимиты запросов и ограничения

Понимание лимитов, чтобы избежать прерывания сервиса. Вы можете выполнять 300 запросов в минуту на один ключ. Параллельные запросы ограничены восемью одновременно. Тело запроса не должно превышать 8 МБ.

Корректная обработка ошибок. Статус 401 означает, что ваш ключ недействителен. Статус 402 указывает на недостаток средств. Статус 429 сигнализирует о достижении лимита запросов.

Окно контекста поддерживает до 100,000 токенов суммарно. Это включает как промпт, так и генерацию. Максимальный объем вывода — 16,000 токенов за запрос. Установите max_tokens для контроля длины вывода. Ошибки бесплатны, поэтому повторные попытки безопасны.