Rivya API

Будуйте на multimodal model layer Rivya

Rivya API дає product teams публічний account-based спосіб викликати Rivya models із власних apps. Почніть з asynchronous image, video й audio jobs, додайте Chat API turns з optional SSE streaming, коли model підтримує chat, і тримайте billing у тому самому Rivya credit wallet.
Читати API docsСтворити API key

Quickstart shape

Шар моделей

Dynamic catalog

Billing

Shared credits

Перша версія

Jobs + Chat

Доступ

API keys

MethodPOST
Endpoint/api/v1/generations

Реальний request потребує Rivya API key і доступних account credits. Public examples використовують placeholder secrets і не викликають models anonymously.

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
}

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

Public API layer, що лишається узгодженим із продуктом Rivya

API задуманий як продуктова surface Rivya. Він використовує Rivya model IDs, Rivya credits, public task states і docs, які лишаються пов'язаними з model catalog.

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

Надсилайте image jobs із prompt і supported model parameters, потім poll-іть public results.

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

Запускайте asynchronous video jobs із тими самими task і credit controls, що використовує Studio.

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

Використовуйте API-accessible audio models через той самий account, balance і history boundary.

Спільний гаманець credits

API calls і Studio usage списуються з того самого Rivya balance, з reserved credits і failure handling.

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

Від акаунта до першого API request

01

Створіть key

Увійдіть, відкрийте API Keys у Settings, створіть scoped key і негайно збережіть full secret.

02

Виберіть model

Читайте API model reference або викликайте /api/v1/models, щоб перевірити model IDs, parameters, chat capabilities і input readiness перед submit.

03

Submit, poll або subscribe

Надішліть idempotent generation request, poll-іть public task endpoint, використовуйте signed webhooks для generation callbacks або надішліть Chat API turn з optional SSE streaming.

Межа версії

Чіткий scope без прихованих promises

Landing page може згадувати future surfaces, але поточна product copy не має натякати, що unfinished APIs уже live.

Chat API

Available

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

Files API

Available

Доступний для reference image, video й audio uploads. Використовуйте його перед generation, коли model page просить params.referenceMediaItems.

Користувацькі webhooks

Available

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

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

Preview request, а потім запустіть його зі своїм API key

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

Account state

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

Active key prefix

Спершу створіть key

Поточні credits

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

Mock previewLive Public APIНемає active API key

Mock mode ніколи не викликає model і ніколи не споживає credits.

Вставте key лише для цього request. Debugger не зберігає його після refresh.

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

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

Mock-режим нічого не завантажуєLive використовує /api/v1/files

Selected model контролює allowed MIME types, size і duration rules. Live uploads потребують temporary API key і можуть викликати реальний upload service.

Створити API keyЧитати API docs
Request preview
{
  "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
}
Відповідь 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
}
Generation params
{
  "params": {
    "referenceMediaItems": [
      {
        "url": "https://media.example/reference.png",
        "kind": "image",
        "name": "reference.png",
        "mimeType": "image/png"
      }
    ]
  }
}

Task state

Оцінка base credits

1

Status

queued

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

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

Відкрити docs

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

Створюйте, copy once, revoke і rotate API keys із protected Settings area.

Керувати keys

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

Спочатку використовуйте mock examples; real debugging потребує login, API key і account credits.

Попередній перегляд flow