Skicka asynkrona Rivya API-genereringsjobb med model, prompt, params, Idempotency-Key och offentliga svarsfält.

Använd POST /api/v1/generations för att skicka ett asynkront bild-, video- eller ljudgenereringsjobb.

För chattmodeller, använd Chat API. POST /api/v1/generations skapar inte chattsessioner eller assistentmeddelanden.

Endpoint

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

Nödvändiga headers:

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

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

Fält:

model: obligatoriskt offentligt modell-ID
prompt: prompttext, krävs av många modeller
params: modellspecifikt parameterobjekt
client_request_id: valfritt trace-ID från ditt system

Läs modellreferensen för API för modellspecifika params.

Referensfiler i params

För modeller som accepterar uppladdad referensmedia, anropa först Files API. Skicka sedan uppladdningsresultatet via modellens params; lägg inte till ett toppnivåfält files i genereringsbegäran.

Använd params.referenceMediaItems för nya integrationer:

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

För ljud- eller videoinput som kräver durationsverifiering, inkludera duration_token som returneras av /api/v1/files som durationToken på den relaterade referenceMediaItems-posten.

curl-exempel

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-exempel

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-exempel

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

Svar

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

Spara id och polla genereringsstatus. Om du konfigurerar API-webhooks kan Rivya också skicka en signerad generation.succeeded- eller generation.failed-händelse när uppgiften når ett terminalt tillstånd.

Idempotens

Använd Idempotency-Key för retries. Om samma nyckel och samma request body spelas upp igen kan Rivya returnera det sparade offentliga svaret i stället för att skapa en duplicerad uppgift.

Om samma nyckel återanvänds med annan indata returnerar API:et idempotency_conflict.

Skapa generation