Открытый API

Reverie предоставляет эндпоинт Chat Completions, совместимый с OpenAI. Направьте на него любой клиент OpenAI, передайте ключ API Reverie и в поле model укажите персонажа или сценарий вместо большой модели. Разговор, воспоминания и сводки Reverie хранит у себя, поэтому в каждом запросе нужно только ваше новое сообщение.

Пользоваться им может любой вошедший аккаунт. Никаких уровней подписки и списков ожидания — нужен ключ API, и всё. Создать →

Базовый URL и авторизация

https://reverie.im/api/device/v1
Authorization: Bearer rk_...

Настройки → Ещё → Ключи API показывают точный базовый URL в карточке API Endpoint, рядом кнопка копирования.

Быстрый старт

curl --no-buffer https://reverie.im/api/device/v1/chat/completions \
  -H "Authorization: Bearer $REVERIE_API_KEY" \
  -H "Content-Type: application/json" \
  --data-binary '{
  "model": "Luna [abc12345]",
  "messages": [
    {
      "role": "user",
      "content": "Hi"
    }
  ],
  "stream": true,
  "temperature": 0.8
}'

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

Поле model называет персонажа

От чего зависит, разрешится ли короткий ID:

• [...] должно стоять в конце строки.
• Суффикс длиной 8 символов или меньше сверяется только с персонажами, с которыми у вас уже есть чат — в вебе или через API. Короткий ID персонажа, которого вы ни разу не открывали, тихо не срабатывает.
• Поиск сценария выполняется, только когда ключ закреплён за персонажем. С глобальным ключом короткий ID сценария не разрешится никогда.
• Больше 8 символов считается полным ID.

Как узнать, с кем можно говорить

curl https://reverie.im/api/device/v1/models \
  -H "Authorization: Bearer $REVERIE_API_KEY"

Глобальный ключ возвращает ваших недавних персонажей. Ключ, закреплённый за персонажем, возвращает сценарии этого персонажа, а если их нет — самого персонажа. Каждая запись выглядит так:

{
	"id": "Luna [abc12345]",
	"object": "model",
	"created": 1759200000,
	"owned_by": "character",
	"permission": [],
	"root": "<full character id>",
	"parent": null
}

Скопируйте id прямо в model. Ошибки этого эндпоинта приходят в простом виде, а не в оболочке OpenAI.

Что читается в теле запроса

Читаются четыре поля. Всё остальное принимается и молча отбрасывается.

Молча игнорируются: max_tokens, top_p, n, stop, presence_penalty, frequency_penalty, logit_bias, seed, user, response_format, tools, tool_choice, logprobs, stream_options.

Как обрабатывается messages:

• Сообщения system отбрасываются. Личность и поведение берутся из полей самого персонажа, а не из запроса. Поля промпта →
• Работы с изображениями нет. Содержимое может быть строкой или массивом частей, но читаются только части text; части-картинки игнорируются.
• В разговор добавляется только последнее сообщение user. Более ранние сообщения пользователя игнорируются.
• Сообщения ассистента используются лишь для синхронизации истории (см. ниже).
• Пустое или состоящее из пробелов последнее сообщение пользователя вернёт missing_user_message.

Ответы

Непотоковый ответ — это обычный объект chat.completion. finish_reason всегда stop — внутренние вызовы инструментов наружу не показываются, — а счётчики usage нулевые, поэтому считайте токены по статистике использования на странице ключей API, а не по ответу.

Потоковый ответ — это text/event-stream:

1. Блоки содержимого: объекты chat.completion.chunk с delta.content. Начальный блок delta: {"role": "assistant"} не отправляется.
2. Завершающий блок с finish_reason stop, length или content_filter. Завершения из-за вызова инструмента сообщаются как stop.
3. Блок использования с пустым массивом choices.
4. data: [DONE].

Если генерация срывается посреди потока, поток выдаёт data: {"error": {...}}, а затем [DONE].

Состояние разговора

Разговор хранит Reverie. На каждую пару «ключ и персонаж» приходится один чат, он появляется в веб-приложении рядом с остальными вашими чатами, и каждый ход собирается из системного промпта и сценария персонажа, канона книг мира, долговременных воспоминаний, накапливающихся сводок, манеры повествования персонажа, длины ответа и настроек NSFW, языковой привязки из языка вашего аккаунта и такого объёма недавней истории, какой вмещает контекстное окно модели. Инструменты памяти работают, когда модель поддерживает инструменты.

Поскольку историю держит сервер, повторять её не нужно.

Какая модель отвечает

Решает персонаж, а не запрос, — если только вы не назвали модель сами. Приоритет от низшего к высшему: модель чата по умолчанию, затем собственная настройка модели у персонажа, затем ID модели Reverie, переданный в model, и, наконец, выбор модели для этого чата, сделанный вами в веб-приложении, — он побеждает всё остальное. Модели →

Ошибки

Ошибки /chat/completions приходят в оболочке OpenAI: {"error": {"message", "type", "param": null, "code"}}.

Два случая выпадают из этой оболочки: ошибки GET /models и тела запросов, отклонённые проверкой (например, temperature вне диапазона) — и те и другие возвращают простой вид ошибки.

Лимиты и квоты

У этого API нет лимита частоты на ключ, нет потолка по параллельным запросам и нет квоты на запросы. Ограничивают вас всего две вещи:

Окно бесплатных моделей общее с веб-чатом, историями, романами и ботами — это один лимит на аккаунт, а не по одному на каждую площадку. Бесплатные модели →

Reverie не отправляет исходящих вебхуков; подписаться на события о завершении генерации не на что.

Импорт персонажей

Есть и второй эндпоинт, POST /api/v1/characters/import, — он создаёт персонажа из карточки персонажа. Ему нужен ключ с правом импорта, а страница настроек такие ключи не создаёт. Ключи API → и Импорт персонажей →

Смежное

• Ключи API — создание, закрепление, срок действия и расход ключей
• Модели — ID моделей и кредитные множители
• Ограничения — остальные потолки в продукте
• Кредиты — как считается стоимость запросов