Open API

Reverie надає ендпоінт Chat Completions, сумісний з OpenAI. Спрямуй на нього будь-який клієнт OpenAI, передай API-ключ Reverie і використовуй поле model, щоб указати персонажа або сценарій замість LLM. Reverie зберігає розмову, спогади й підсумки на своєму боці, тож кожному запиту потрібне лише твоє нове повідомлення.

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

Базова URL-адреса та автентифікація

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

Налаштування → Більше → API-ключі показує точну базову URL-адресу на картці API-ендпоінт разом із кнопкою копіювання.

Швидкий старт

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, мовного обмеження за мовою твого акаунта та стількох нещодавніх повідомлень, скільки вміщує контекстне вікно моделі. Інструменти пам'яті працюють, якщо модель підтримує інструменти.

Оскільки історію зберігає сервер, повторно надсилати її не потрібно.

Яка LLM відповідає

Це вирішує персонаж, а не запит — хіба що ти вкажеш LLM. Пріоритет, від найнижчого до найвищого: типова модель чату, потім власне налаштування моделі персонажа, потім 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 моделей і множники кредитів
• Ліміти — інші обмеження в продукті
• Кредити — як тарифікуються запити