Send inn asynkrone Rivya API-genereringsjobber med model, prompt, params, Idempotency-Key og offentlige responsfelt.

Bruk POST /api/v1/generations for å sende inn en asynkron bilde-, video- eller lydgenereringsjobb.

For chatmodeller bruker du Chat API. POST /api/v1/generations oppretter ikke chatøkter eller assistentmeldinger.

Endepunkt

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

Påkrevde headers:

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

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

Felter:

model: påkrevd offentlig modell-ID
prompt: prompttekst, påkrevd av mange modeller
params: modellspesifikt parameterobjekt
client_request_id: valgfri trace ID fra systemet ditt

Les modell-API-referanse for modellspesifikke params.

For modeller som godtar opplastede referansemedier, kall først Files API. Send deretter opplastingsresultatet gjennom modellens params; ikke legg til et toppnivåfelt kalt files i genereringsforespørselen.

Bruk params.referenceMediaItems for nye integrasjoner:

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

For lyd- eller videoinput som krever varighetsverifisering, inkluder duration_token returnert av /api/v1/files som durationToken på den relaterte referenceMediaItems-oppføringen.

curl-eksempel

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

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

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

Respons

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

Lagre id og poll genereringsstatus. Hvis du konfigurerer API-webhooks, kan Rivya også sende en signert generation.succeeded- eller generation.failed-hendelse når oppgaven når en terminal tilstand.

Idempotens

Bruk Idempotency-Key for retries. Hvis samme nøkkel og samme request body spilles av på nytt, kan Rivya returnere den lagrede offentlige responsen i stedet for å opprette en duplikatoppgave.

Hvis den samme nøkkelen gjenbrukes med andre inndata, returnerer API-et idempotency_conflict.

Opprett generering