Rivya AI-dokumentasjon

Genereringsstatus

Poll Rivya API-genereringsjobber etter offentlig task ID, les queued-, processing-, succeeded- og failed-tilstander, og bruk resultat-URL-er.

Sist gjennomgått 2026/05/10

Bruk GET /api/v1/generations/{taskId} for å sjekke en asynkron genereringsjobb.

Endepunkt

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

Påkrevd header:

Authorization: Bearer rvya_sk_...

curl-eksempel

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

Statusverdier

Offentlige statusverdier:

  • queued: oppgaven er akseptert, men ikke fullført
  • processing: genereringen kjører
  • succeeded: resultatet er tilgjengelig
  • failed: oppgaven feilet og kan inkludere et offentlig error-objekt

Vellykket respons

{
  "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 er den første resultat-URL-en for enkelhets skyld. urls inneholder listen over offentlige resultat-URL-er når den er tilgjengelig.

Mislykket respons

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

Polling-råd

Start med en kort forsinkelse, og øk deretter pollingintervallene. Unngå tette løkker.

Anbefalt mønster:

  • vent 2-3 sekunder etter innsending
  • poll hvert 5-10 sekund for vanlige jobber
  • senk tempoet for lange video- og lydjobber
  • stopp polling når status er succeeded eller failed

Eierskapsgrense

Oppgaven må tilhøre den samme Rivya-kontoen bak API-nøkkelen. Hvis den ikke finnes eller ikke eies av kontoen, returnerer endepunktet not_found.

Relaterte sider

Innholdsfortegnelse