Rivya API

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

Rivya API дает продуктовым командам публичный, account-based способ вызывать модели Rivya из собственных приложений. Начните с асинхронных jobs для изображений, видео и аудио, добавьте Chat API turns с optional SSE streaming для chat-capable моделей и держите биллинг в том же кошельке кредитов Rivya.
Читать API docsСоздать API key

Форма quickstart

Слой моделей

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

Биллинг

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

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

Jobs + Chat

Доступ

API keys

МетодPOST
Endpoint/api/v1/generations

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

Request
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"
  }'
Response
{
  "id": "task_public_id",
  "status": "queued",
  "model": "z-image",
  "reserved_credits": 20,
  "result": null,
  "error": null
}

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

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

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

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

Отправляйте image jobs с prompt и поддерживаемыми параметрами модели, затем опрашивайте публичные results.

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

Запускайте асинхронные video jobs с теми же task и credit controls, что использует Studio.

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

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

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

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

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

От аккаунта до первого API request

01

Создайте key

Войдите, откройте API Keys в Settings, создайте scoped key и сразу сохраните полный secret.

02

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

Читайте API model reference или вызовите /api/v1/models, чтобы проверить model IDs, параметры, chat capabilities и input readiness перед отправкой.

03

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

Отправьте idempotent generation request, опрашивайте публичный task endpoint, используйте signed webhooks для callbacks генерации или отправьте Chat API turn с optional SSE streaming.

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

Четкий scope, без скрытых обещаний

Landing page может упоминать будущие поверхности, но текущий product copy не должен создавать впечатление, что незавершенные API уже live.

Chat API

Доступно

Доступен для non-streaming и SSE streaming turns с API-created sessions, account credits и optional Files API image attachments.

Files API

Доступно

Доступен для загрузки reference image, video и audio. Используйте его перед генерацией, когда страница модели просит params.referenceMediaItems.

Пользовательские webhooks

Доступно

Доступны для production integrations, которым нужны signed callbacks для succeeded или failed generation tasks.

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

Сначала preview request, затем запустите его со своим API key

Debugger для каждого посетителя стартует в mock mode. Generation selector показывает non-chat модели, которые можно тестировать без загрузки файлов, а Files panel позволяет signed-in users тестировать /api/v1/files с временным API key. Chat examples находятся в API docs.

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

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

Prefix активного key

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

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

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

Тестовый предпросмотрПубличный API в live-режимеНет активного API key

Mock mode никогда не вызывает модель и не расходует кредиты.

Вставляйте key только для этого request. Debugger не хранит его после refresh.

Тест upload через Files API

Загрузите reference media через POST /api/v1/files, затем скопируйте returned URL и duration token в params.referenceMediaItems для модели, поддерживающей reference inputs.

Mock никогда не загружает файлыLive использует /api/v1/files

Выбранная модель определяет allowed MIME types, size и duration rules. Live uploads требуют временный API key и могут вызвать реальный upload service.

Создать API keyЧитать API docs
Предпросмотр запроса
{
  "model": "z-image",
  "prompt": "Редакционное фото продукта на чистом студийном сетапе",
  "params": {
    "aspect_ratio": "1:1"
  }
}
Response
{
  "id": "mock_task_001",
  "status": "queued",
  "model": "z-image",
  "reserved_credits": 1,
  "final_credits": 0,
  "result": null,
  "error": null
}
Response 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"
      }
    ]
  }
}

Состояние задачи

Оценка base credits

1

Статус

queued

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

Читайте authentication, request bodies, responses, idempotency, model parameters и error codes.

Открыть docs

Управление API key

Создавайте, копируйте один раз, отзывайте и ротируйте API keys из защищенной зоны Settings.

Управлять keys

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

Сначала используйте mock examples; реальная отладка требует login, API key и кредиты аккаунта.

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