Dokumentacja Rivya AI
Strony API modeli

Integracja API Z-Image

Używaj Z-Image przez Rivya Public API v1 z identyfikatorem modelu z-image, obsługiwanymi wejściami, parametrami, regułami Files API, kredytami i przykładami odpowiedzi.

Dostępne przez APIWejście tekstowe gotoweObraz
Identyfikator modelu API

z-image

Wejścia

text

Files API

Niewymagane dla żądania minimalnego

Kredyty bazowe

1

Możliwość

Obraz

Rozliczenia

FIXED

Limit promptu

1000 znaków

Kontrakt żądania

Wyślij identyfikator modelu na najwyższym poziomie. Kontrolki specyficzne dla modelu należą do params.

KluczTypWymaganeDomyślnieOpis
modelstringTakz-imageUżyj z-image jako identyfikatora modelu API.
promptstringTak-Maksymalnie 1000 znaków dla tego modelu.
paramsobjectNie-Obiekt parametrów specyficznych dla modelu. Dozwolone klucze znajdziesz w wierszach poniżej.
client_request_idstringNie-Opcjonalny identyfikator po stronie klienta do śledzenia żądań w Twoim systemie.

Parametry modelu

KluczTypWymaganeDomyślnieZakresOpcjeOpis
aspect_ratioselectNie1:1-1:1, 4:3, 3:4, 16:9, 9:16Proporcje obrazu

Żądanie minimalne

{
  "model": "z-image",
  "prompt": "A clean editorial product image on a soft studio background",
  "params": {
    "aspect_ratio": "1:1"
  }
}

Odpowiedź tworzenia

Endpoint tworzenia zwraca publiczny identyfikator zadania. Odpytuj endpoint statusu, aż zadanie zakończy się sukcesem albo błędem.

{
  "id": "task_z_image_example",
  "status": "queued",
  "model": "z-image",
  "reserved_credits": 1,
  "final_credits": 0,
  "created_at": "2026-05-11T00:00:00.000Z",
  "updated_at": "2026-05-11T00:00:00.000Z",
  "result": null,
  "error": null
}

Typowe błędy

validation_failed, insufficient_credits, idempotency_conflict, rate_limited, not_found

Endpoint tworzenia zwraca publiczny identyfikator zadania. Odpytuj endpoint statusu, aż zadanie zakończy się sukcesem albo błędem.