Küldj be aszinkron Rivya API generálási feladatokat modellel, prompttal, params mezővel, Idempotency-Key headerrel és nyilvános válaszmezőkkel.

Használd a POST /api/v1/generations endpointot aszinkron kép-, videó- vagy hanggenerálási feladat beküldéséhez.

Chatmodellekhez használd a Chat API oldalt. A POST /api/v1/generations nem hoz létre chatmunkameneteket vagy asszisztensüzeneteket.

Endpoint

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

Szükséges headerek:

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

Ajánlott header:

Idempotency-Key: your-unique-request-key

Request body

{
  "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"
}

Mezők:

model: kötelező nyilvános modellazonosító
prompt: promptszöveg, sok modellnél kötelező
params: modell-specifikus paraméterobjektum
client_request_id: opcionális trace ID a saját rendszeredből

Modell-specifikus params mezőkhöz olvasd a Modell API referenciát.

Referenciafájlok a params mezőben

Azoknál a modelleknél, amelyek feltöltött referenciamédiát fogadnak, először hívd meg a Files API oldalt. Ezután add át a feltöltés eredményét a modell params mezőin keresztül; ne adj felső szintű files mezőt a generálási kéréshez.

Új integrációknál használd a params.referenceMediaItems mezőt:

{
  "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 ellenőrzést igénylő hang- vagy videóbemeneteknél add meg a /api/v1/files által visszaadott duration_token értéket durationToken néven a kapcsolódó referenceMediaItems elemben.

curl példa

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 példa

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 példa

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"])

Válasz

{
  "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
}

Mentsd el az id értéket, és kérdezd le a Generálási állapot oldalon. Ha beállítod az API webhookokat, a Rivya aláírt generation.succeeded vagy generation.failed eseményt is küldhet, amikor a feladat végállapotba ér.

Idempotencia

Újrapróbálkozásokhoz használj Idempotency-Key headert. Ha ugyanazt a kulcsot és ugyanazt a request body-t játszod vissza, a Rivya a tárolt nyilvános választ adhatja vissza ahelyett, hogy duplikált feladatot hozna létre.

Ha ugyanazt a kulcsot más bemenettel használod újra, az API idempotency_conflict választ ad.

Generálás létrehozása