Надсилайте асинхронні задачі генерації Rivya API з model, prompt, params, ключем ідемпотентності та публічними полями відповіді.

Використовуйте POST /api/v1/generations, щоб надіслати асинхронну задачу генерації зображення, відео або аудіо.

Для chat-моделей використовуйте Chat API. POST /api/v1/generations не створює чат-сесії або повідомлення асистента.

Endpoint

POST https://rivya.ai/api/v1/generations

Обов'язкові заголовки:

Authorization: Bearer rvya_sk_...
Content-Type: application/json

Рекомендований заголовок:

Idempotency-Key: your-unique-request-key

Тіло запиту

{
  "model": "z-image",
  "prompt": "A clean editorial product image on a soft studio background",
  "params": {
    "aspect_ratio": "1:1"
  },
  "client_request_id": "order-123-preview"
}

Поля:

model: обов'язковий публічний ID моделі
prompt: текст prompt, потрібний багатьом моделям
params: об'єкт параметрів, специфічних для моделі
client_request_id: необов'язковий trace ID із вашої системи

Читайте Model API Reference для params, специфічних для моделі.

Для моделей, які приймають завантажені референс-медіа, спочатку викличте Files API. Потім передайте результат завантаження через params моделі; не додавайте поле верхнього рівня files до запиту генерації.

Для нових інтеграцій використовуйте params.referenceMediaItems:

{
  "model": "nano-banana-2",
  "prompt": "Restyle this product photo for a clean editorial catalog page",
  "params": {
    "referenceMediaItems": [
      {
        "url": "https://...",
        "kind": "image",
        "name": "reference.png",
        "mimeType": "image/png"
      }
    ]
  }
}

Для аудіо- або відеовхідних даних, які потребують перевірки тривалості, додайте duration_token, повернений /api/v1/files, як durationToken у відповідний елемент referenceMediaItems.

Приклад curl

curl https://rivya.ai/api/v1/generations \
  -H "Authorization: Bearer rvya_sk_..." \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: product-preview-001" \
  -d '{
    "model": "z-image",
    "prompt": "A clean editorial product image on a soft studio background",
    "params": {
      "aspect_ratio": "1:1"
    }
  }'

Приклад JavaScript

const response = await fetch("https://rivya.ai/api/v1/generations", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.RIVYA_API_KEY}`,
    "Content-Type": "application/json",
    "Idempotency-Key": "product-preview-001"
  },
  body: JSON.stringify({
    model: "z-image",
    prompt: "A clean editorial product image on a soft studio background",
    params: { aspect_ratio: "1:1" }
  })
});

const generation = await response.json();
console.log(generation.id, generation.status);

Приклад Python

import os
import requests

response = requests.post(
    "https://rivya.ai/api/v1/generations",
    headers={
        "Authorization": f"Bearer {os.environ['RIVYA_API_KEY']}",
        "Content-Type": "application/json",
        "Idempotency-Key": "product-preview-001",
    },
    json={
        "model": "z-image",
        "prompt": "A clean editorial product image on a soft studio background",
        "params": {"aspect_ratio": "1:1"},
    },
    timeout=30,
)

generation = response.json()
print(generation["id"], generation["status"])

Відповідь

{
  "id": "task_public_id",
  "status": "queued",
  "model": "z-image",
  "reserved_credits": 1,
  "final_credits": 0,
  "created_at": "2026-05-10T00:00:00.000Z",
  "updated_at": "2026-05-10T00:00:00.000Z",
  "result": null,
  "error": null
}

Збережіть id і опитуйте статус генерації. Якщо ви налаштуєте API Webhooks, Rivya також може надіслати підписану подію generation.succeeded або generation.failed, коли задача досягне термінального стану.

Ідемпотентність

Використовуйте Idempotency-Key для повторних спроб. Якщо той самий ключ і те саме тіло запиту відтворюються повторно, Rivya може повернути збережену публічну відповідь замість створення дубліката задачі.

Якщо той самий ключ повторно використовується з іншими вхідними даними, API повертає idempotency_conflict.

Створення генерації