Быстрый старт: Интеграция API AI-девушки

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

Наш API следует стандарту OpenAI chat-completions, что делает интеграцию простой для существующих клиентов. Вы должны включить свой API-ключ в заголовок Authorization каждого запроса. Базовый URL для всех эндпоинтов — https://api.roleplayapi.com/v1. При использовании официальных SDK обновите конфигурацию base_url, чтобы она указывала на этот адрес, и укажите свой ключ как api_key. Эта настройка гарантирует, что ваши запросы достигнут нашего выделенного эндпоинта без цензуры без изменения вашей стандартной логики.

Отправить Completion-запрос

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

Copycurl https://api.roleplayapi.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."}]
  }'

Интеграция Python SDK

Используйте официальную библиотеку openai для Python для взаимодействия с API с минимальным количеством шаблонного кода. Настройте клиент с нашим базовым URL и вашим API-ключом. Затем вызовите chat.completions.create с ID модели uncensored. Этот подход использует существующие подсказки типов и механизмы обработки ошибок, позволяя вам сосредоточиться на логике вашего приложения, а не на разборе HTTP. Объект ответа предоставляет прямой доступ к сгенерированному содержимому.

Copyfrom openai import OpenAI

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

Интеграция Node SDK

Для проектов на JavaScript и TypeScript Node SDK от OpenAI предоставляет чистый интерфейс для вызовов API. Инициализируйте клиент с пользовательским базовым URL и вашим секретным ключом. Вызовите эндпоинт завершения чата, используя модель uncensored. Этот метод идеален для веб-серверов или edge-функций, где вам нужно эффективно управлять асинхронными запросами. SDK автоматически обрабатывает сериализацию и десериализацию полезной нагрузки JSON.

Copyimport OpenAI from "openai";

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

Включение потоковой передачи

Снизьте воспринимаемую задержку, включив серверные события (SSE). Установите параметр stream в значение true в вашем запросе. 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 запросов в минуту на один API-ключ. При превышении этого лимита API возвращает статус 429. Ошибки аутентификации приводят к ошибке 401, а недостаточный предоплаченный баланс вызывает ошибку 402. Контекстное окно поддерживает до 100 000 токенов для суммарного промпта и ответа модели. Если вам нужно проверить доступные модели, отправьте GET-запрос по адресу /v1/models. Убедитесь, что тело вашего запроса не превышает 8 МБ.