Rivya AI -dokumentaatio

Generoinnin tila

Pollaa Rivya API -generointitöitä julkisella tehtävätunnuksella, lue queued-, processing-, succeeded- ja failed-tilat ja käytä tulos-URL-osoitteita.

Viimeksi tarkistettu 2026/05/10

Käytä GET /api/v1/generations/{taskId} -endpointtia asynkronisen generointityön tarkistamiseen.

Endpoint

GET https://rivya.ai/api/v1/generations/{taskId}

Vaadittu header:

Authorization: Bearer rvya_sk_...

curl-esimerkki

curl https://rivya.ai/api/v1/generations/task_public_id \
  -H "Authorization: Bearer rvya_sk_..."

Tila-arvot

Julkiset tila-arvot:

  • queued: tehtävä hyväksytty, ei valmis
  • processing: generointi on käynnissä
  • succeeded: tulos on saatavilla
  • failed: tehtävä epäonnistui ja voi sisältää julkisen virheobjektin

Onnistunut vastaus

{
  "id": "task_public_id",
  "status": "succeeded",
  "model": "z-image",
  "reserved_credits": 1,
  "final_credits": 1,
  "created_at": "2026-05-10T00:00:00.000Z",
  "updated_at": "2026-05-10T00:01:00.000Z",
  "result": {
    "primary_url": "https://media.example/result.png",
    "urls": ["https://media.example/result.png"]
  },
  "error": null
}

primary_url on ensimmäinen tulos-URL käytön helpottamiseksi. urls sisältää julkisen tulos-URL-luettelon, kun se on saatavilla.

Epäonnistunut vastaus

{
  "id": "task_public_id",
  "status": "failed",
  "model": "z-image",
  "reserved_credits": 1,
  "final_credits": 0,
  "created_at": "2026-05-10T00:00:00.000Z",
  "updated_at": "2026-05-10T00:01:00.000Z",
  "result": null,
  "error": {
    "code": "generation_failed",
    "message": "The generation failed."
  }
}

Pollausohjeet

Aloita lyhyellä viiveellä ja kasvata sitten pollausvälejä. Vältä tiukkoja silmukoita.

Suositeltu malli:

  • odota 2-3 sekuntia lähetyksen jälkeen
  • pollaa 5-10 sekunnin välein tavallisissa töissä
  • hidasta pitkissä video- ja audiotöissä
  • lopeta pollaus, kun tila on succeeded tai failed

Omistajuusraja

Tehtävän täytyy kuulua samalle Rivya-tilille, joka on API-avaimen takana. Jos tehtävää ei löydy tai se ei kuulu tilille, endpoint palauttaa virheen not_found.

Liittyvät sivut

Sisällysluettelo