Rivya AI-dokumentasjon
Modell-API-sider

Z-Image API-integrasjon

Bruk Z-Image via Rivya Public API v1 med modell-ID z-image, støttede inndata, parametere, Files API-regler, kreditter og svareksempler.

Tilgjengelig via APITekstinndata klareBilde
API-modell-ID

z-image

Inndata

text

Files API

Kreves ikke for minimal forespørsel

Basiskreditter

1

Egenskap

Bilde

Fakturering

FIXED

Promptgrense

1000 tegn

Forespørselskontrakt

Send modell-ID-en på toppnivå. Modellspesifikke kontroller hører hjemme i params.

NøkkelTypePåkrevdStandardBeskrivelse
modelstringJaz-imageBruk API-modell-ID-en z-image.
promptstringJa-Maksimalt 1000 tegn for denne modellen.
paramsobjectNei-Modellspesifikt parameterobjekt. Bruk radene nedenfor for tillatte nøkler.
client_request_idstringNei-Valgfri klient-ID for sporing av forespørsler i systemet ditt.

Modellparametere

NøkkelTypePåkrevdStandardOmrådeAlternativerBeskrivelse
aspect_ratioselectNei1:1-1:1, 4:3, 3:4, 16:9, 9:16Sideforhold

Minimal forespørsel

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

Opprettelsessvar

Create-endepunktet returnerer en offentlig oppgave-ID. Poll statusendepunktet til oppgaven lykkes eller mislykkes.

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

Vanlige feil

validation_failed, insufficient_credits, idempotency_conflict, rate_limited, not_found

Create-endepunktet returnerer en offentlig oppgave-ID. Poll statusendepunktet til oppgaven lykkes eller mislykkes.