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

Создание генерации

Отправляйте асинхронные задачи генерации Rivya API с model, prompt, params, Idempotency-Key и публичными полями ответа.

Последняя проверка: 2026/05/10

Используйте POST /api/v1/generations, чтобы отправить асинхронную задачу генерации изображения, видео или аудио.

Для моделей чата используйте API чата. POST /api/v1/generations не создает чаты, сессии или сообщения ассистента.

Конечная точка

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: текст промпта, требуется многими моделями
  • params: объект параметров конкретной модели
  • client_request_id: необязательный ID трассировки из вашей системы

Модельные params описаны в справочнике Model API.

Справочные файлы в 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-вебхуки, Rivya также может отправить подписанное событие generation.succeeded или generation.failed, когда задача достигнет конечного состояния.

Идемпотентность

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

Если тот же ключ используется с другим вводом, API возвращает idempotency_conflict.

Связанные страницы

Содержание