Rivya AI -dokumentaatio
Mallien API-sivut

Z-Image API -integraatio

Käytä mallia Z-Image Rivya Public API v1:n kautta malli-ID:llä z-image; mukana ovat tuetut syötteet, parametrit, Files API -säännöt, krediitit ja vastausesimerkit.

Saatavilla API:n kauttaTekstisyöte valmisImage
API-malli-ID

z-image

Syötteet

text

Files API

Ei vaadita minimipyynnössä

Peruskrediitit

1

Kyvykkyys

Image

Laskutus

FIXED

Prompt-raja

1000 merkkiä

Pyyntösopimus

Lähetä malli-ID ylätason kentässä. Mallikohtaiset ohjaimet kuuluvat params-objektiin.

AvainTyyppiPakollinenOletusKuvaus
modelstringKylläz-imageKäytä z-image-arvoa API-malli-ID:nä.
promptstringKyllä-Enintään 1000 merkkiä tälle mallille.
paramsobjectEi-Mallikohtainen parametriobjekti. Käytä alla olevia rivejä sallittuihin avaimiin.
client_request_idstringEi-Valinnainen asiakaspuolen ID pyyntöjen jäljittämiseen omassa järjestelmässäsi.

Malliparametrit

AvainTyyppiPakollinenOletusAlueVaihtoehdotKuvaus
aspect_ratioselectEi1:1-1:1, 4:3, 3:4, 16:9, 9:16Kuvasuhde

Minimipyyntö

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

Create-vastaus

Create-endpoint palauttaa julkisen tehtävä-ID:n. Pollaa status-endpointia, kunnes tehtävä onnistuu tai epäonnistuu.

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

Yleiset virheet

validation_failed, insufficient_credits, idempotency_conflict, rate_limited, not_found

Create-endpoint palauttaa julkisen tehtävä-ID:n. Pollaa status-endpointia, kunnes tehtävä onnistuu tai epäonnistuu.