Rivya API

Створюйте продукти на мультимодальному шарі моделей Rivya

Rivya API дає продуктовим командам публічний спосіб викликати моделі Rivya зі своїх застосунків через власний акаунт. Почніть з асинхронних завдань для зображень, відео й аудіо, додайте чат-запити через Chat API з необов'язковим потоковим передаванням SSE для сумісних моделей і використовуйте той самий гаманець кредитів Rivya.
Читати документацію APIСтворити API-ключ

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

Шар моделей

Динамічний каталог

Оплата

Спільні кредити

Перша версія

Завдання + чат

Доступ

API-ключі

МетодPOST
Ендпоїнт/api/v1/generations

Для справжнього запиту потрібні API-ключ Rivya та доступні кредити акаунта. У публічних прикладах використано секрети-заповнювачі, і вони не викликають моделі анонімно.

Запит
curl https://rivya.ai/api/v1/generations \
  -H "Authorization: Bearer rvya_sk_..." \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: demo-job-001" \
  -d '{
    "model": "z-image",
    "prompt": "Редакційне фото продукту на чистій студійній сцені"
  }'
Відповідь
{
  "id": "task_public_id",
  "status": "queued",
  "model": "z-image",
  "reserved_credits": 1,
  "result": null,
  "error": null
}

Що виходить першим

Публічний API, узгоджений із продуктом Rivya

API є частиною продукту Rivya. Він використовує ідентифікатори моделей Rivya, кредити Rivya, публічні стани завдань і документацію, пов'язану з каталогом моделей.

API генерації зображень

Надсилайте завдання для зображень із промптом і підтримуваними параметрами моделі, а потім перевіряйте публічні результати.

API генерації відео

Запускайте асинхронні відеозавдання з тими самими налаштуваннями завдань і кредитів, що й у Studio.

API генерації аудіо

Використовуйте доступні через API аудіомоделі в тому самому акаунті зі спільним балансом та історією.

Спільний гаманець кредитів

Виклики API й використання Studio списують кошти з того самого балансу Rivya з резервуванням кредитів та обробкою помилок.

Стартовий шлях

Від акаунта до першого API-запиту

01

Створіть ключ

Увійдіть, відкрийте API-ключі в налаштуваннях, створіть ключ із потрібними областями доступу й одразу збережіть повний секрет.

02

Виберіть модель

Перегляньте довідник моделей API або викличте /api/v1/models, щоб перед надсиланням перевірити ідентифікатори моделей, параметри, підтримку чату й готовність вхідних даних.

03

Надішліть, перевіряйте або підпишіться

Надішліть ідемпотентний запит на генерацію, перевіряйте публічний ендпоїнт завдання, використовуйте вебхуки з підписом для сповіщень про генерацію або надішліть чат-запит через Chat API з необов'язковим потоковим передаванням SSE.

Межа версії

Чіткі межі без прихованих обіцянок

Ця сторінка відокремлює доступні можливості API від майбутніх доповнень, щоб ви могли планувати на основі того, що працює сьогодні.

Chat API

Доступно

Доступний для звичайних і потокових SSE-запитів із сесіями, створеними через API, кредитами акаунта й необов'язковими вкладеннями зображень через Files API.

Files API

Доступно

Доступний для завантаження референсних зображень, відео й аудіо. Використовуйте його перед генерацією, коли сторінка моделі вимагає params.referenceMediaItems.

Користувацькі вебхуки

Доступно

Доступні для робочих інтеграцій, яким потрібні сповіщення з підписом про успішні або невдалі завдання генерації.

Онлайн-налагоджувач

Перегляньте запит, а потім запустіть його зі своїм API-ключем

Налагоджувач відкривається для кожного відвідувача в режимі симуляції. У списку генерації показано моделі без чату, які можна тестувати без завантаження файлів, а панель файлів дає авторизованим користувачам перевірити /api/v1/files за допомогою тимчасового API-ключа. Приклади чату наведено в документації API.

Стан акаунта

Перевірка акаунта

Префікс активного ключа

Спершу створіть ключ

Поточні кредити

Увійдіть, щоб перевірити

СимуляціяРеальний Public APIНемає активного API-ключа

Режим симуляції не викликає модель і не витрачає кредити.

Вставте ключ лише для цього запиту. Налагоджувач не зберігає його після оновлення сторінки.

Тестове завантаження через Files API

Завантажте референсні медіа через POST /api/v1/files, а потім скопіюйте отримані URL і токен тривалості в params.referenceMediaItems для моделі, яка підтримує референсні вхідні дані.

Режим симуляції нічого не завантажуєСправжнє завантаження використовує /api/v1/files

Вибрана модель визначає дозволені MIME-типи, розмір і правила тривалості. Для справжнього завантаження потрібен тимчасовий API-ключ, і воно може звернутися до реального сервісу завантажень.

Створити API-ключЧитати документацію API
Попередній перегляд запиту
{
  "model": "z-image",
  "prompt": "Редакційне фото продукту на чистій студійній сцені",
  "params": {
    "aspect_ratio": "1:1"
  }
}
Відповідь
{
  "id": "mock_task_001",
  "status": "queued",
  "model": "z-image",
  "reserved_credits": 1,
  "final_credits": 0,
  "result": null,
  "error": null
}
Відповідь Files API
{
  "id": "file_mock_001",
  "object": "file",
  "kind": "image",
  "file_name": "reference.png",
  "mime_type": "image/png",
  "size_bytes": 245760,
  "url": "https://media.example/reference.png",
  "duration_seconds": null,
  "duration_token": null,
  "created_at": "2026-05-11T00:00:00.000Z",
  "expires_at": null
}
Параметри генерації
{
  "params": {
    "referenceMediaItems": [
      {
        "url": "https://media.example/reference.png",
        "kind": "image",
        "name": "reference.png",
        "mimeType": "image/png"
      }
    ]
  }
}

Стан завдання

Орієнтовна базова вартість у кредитах

1

Стан

queued

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

Читайте про автентифікацію, тіла запитів, відповіді, ідемпотентність, параметри моделей і коди помилок.

Відкрити документацію

Керування API-ключами

Створюйте, одноразово копіюйте, відкликайте й замінюйте API-ключі в захищеному розділі налаштувань.

Керувати ключами

Онлайн-налагодження

Спочатку використовуйте симульовані приклади; для справжнього налагодження потрібні вхід в акаунт, API-ключ і кредити.

Переглянути процес