Rivya AI-dokumentation
Modellsidor för API

Z-Image API-integration

Använd Z-Image via Rivyas publika API v1 med modell-ID z-image, stödda inmatningar, parametrar, Files API-regler, krediter och svarsexempel.

Tillgänglig via APITextinmatning klarBild
API-modell-ID

z-image

Inmatningar

text

Files API

Krävs inte för minimal begäran

Baskrediter

1

Förmåga

Bild

Fakturering

FIXED

Promptgräns

1000 tecken

Kontrakt för begäran

Skicka modell-ID:t på toppnivå. Modellspecifika kontroller hör hemma i params.

NyckelTypObligatorisktStandardBeskrivning
modelstringJaz-imageAnvänd API-modell-ID:t z-image.
promptstringJa-Högst 1000 tecken för den här modellen.
paramsobjectNej-Modellspecifikt parameterobjekt. Använd raderna nedan för tillåtna nycklar.
client_request_idstringNej-Valfritt klient-ID för att spåra begäranden i ditt system.

Modellparametrar

NyckelTypObligatorisktStandardIntervallAlternativBeskrivning
aspect_ratioselectNej1:1-1:1, 4:3, 3:4, 16:9, 9:16Bildförhållande

Minimal begäran

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

Skapa-svar

Create-endpointen returnerar ett publikt uppgifts-ID. Kontrollera status-endpointen tills uppgiften lyckas eller misslyckas.

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

Vanliga fel

validation_failed, insufficient_credits, idempotency_conflict, rate_limited, not_found

Create-endpointen returnerar ett publikt uppgifts-ID. Kontrollera status-endpointen tills uppgiften lyckas eller misslyckas.