Rivya API

Встраивайте мультимодальный слой моделей Rivya в свой продукт

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

Форма быстрого старта

Слой моделей

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

Биллинг

Общие кредиты

Первая версия

Задания + чат

Доступ

API-ключи

МетодPOST
Эндпоинт/api/v1/generations

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

Запрос
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": "Editorial product photo on a clean studio set"
  }'
Ответ
{
  "id": "task_public_id",
  "status": "queued",
  "model": "z-image",
  "reserved_credits": 1,
  "result": null,
  "error": null
}

Что выходит первым

Публичный слой API, который остается согласованным с продуктом Rivya

API является частью продукта Rivya. Он использует ID моделей и кредиты Rivya, публичные состояния задач и документацию, связанную с каталогом моделей.

API генерации изображений

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

API генерации видео

Запускайте асинхронные задания генерации видео с теми же механизмами управления задачами и кредитами, что использует Studio.

API генерации аудио

Используйте аудиомодели, доступные через API, в рамках того же аккаунта, баланса и истории.

Общий кошелек кредитов

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

Стартовый путь

От аккаунта до первого API-запроса

01

Создайте ключ

Войдите, откройте API-ключи в настройках, создайте ключ с нужной областью доступа и сразу сохраните полный секрет.

02

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

Читайте справочник API-моделей или вызовите /api/v1/models, чтобы проверить ID моделей, параметры, возможности чата и готовность входных данных перед отправкой.

03

Отправьте, опросите или подпишитесь

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

Граница версии

Четкая область версии, без скрытых обещаний

На этой странице доступные возможности API отделены от будущих дополнений, чтобы вы могли планировать интеграцию с учетом того, что работает уже сейчас.

Chat API

Доступно

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

Files API

Доступно

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

Пользовательские вебхуки

Доступно

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

Онлайн-отладчик

Сначала просмотрите запрос, затем запустите его со своим API-ключом

Отладчик для каждого посетителя стартует в тестовом режиме. Селектор генерации показывает нечатовые модели, которые можно тестировать без загрузки файлов, а панель Files позволяет пользователям после входа тестировать /api/v1/files с временным API-ключом. Примеры Chat находятся в документации API.

Состояние аккаунта

Проверяем аккаунт

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

Сначала создайте ключ

Текущие кредиты

Войдите, чтобы проверить

Тестовый предпросмотрПубличный 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-ключа и кредитов аккаунта.

Предпросмотр потока