Dokumentacja Rivya AI

Utwórz generowanie

Wysyłaj asynchroniczne zadania generowania Rivya API z modelem, promptem, params, Idempotency-Key i publicznymi polami odpowiedzi.

Ostatni przegląd: 2026/05/10

Użyj POST /api/v1/generations, aby wysłać asynchroniczne zadanie generowania obrazu, wideo albo audio.

Dla modeli czatu użyj Chat API. POST /api/v1/generations nie tworzy sesji czatu ani wiadomości asystenta.

Endpoint

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

Wymagane nagłówki:

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

Zalecany nagłówek:

Idempotency-Key: your-unique-request-key

Body Żądania

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

Pola:

  • model: wymagany publiczny ID modelu
  • prompt: tekst promptu, wymagany przez wiele modeli
  • params: obiekt parametrów specyficznych dla modelu
  • client_request_id: opcjonalny ID śledzenia z Twojego systemu

Przeczytaj Referencję modeli API, aby poznać params specyficzne dla modelu.

Pliki Referencyjne w Params

Dla modeli, które akceptują przesłane media referencyjne, najpierw wywołaj Files API. Następnie przekaż wynik uploadu przez params modelu; nie dodawaj pola files na najwyższym poziomie żądania generowania.

Dla nowych integracji używaj 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"
      }
    ]
  }
}

Dla wejść audio albo wideo, które wymagają weryfikacji czasu trwania, dołącz duration_token zwrócony przez /api/v1/files jako durationToken w powiązanym wpisie referenceMediaItems.

Przykład 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"
    }
  }'

Przykład 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);

Przykład 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"])

Odpowiedź

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

Zapisz id i odpytuj status generowania. Jeśli skonfigurujesz API Webhooks, Rivya może też wysłać podpisane zdarzenie generation.succeeded albo generation.failed, gdy zadanie osiągnie stan końcowy.

Idempotencja

Używaj Idempotency-Key przy ponowieniach. Jeśli ten sam klucz i ta sama treść żądania zostaną odtworzone, Rivya może zwrócić zapisaną publiczną odpowiedź zamiast tworzyć duplikat zadania.

Jeśli ten sam klucz zostanie ponownie użyty z innymi danymi wejściowymi, API zwraca idempotency_conflict.

Powiązane Strony

Spis treści