Get a generation job
GET
https://api.vidmoat.com/v1/ai/jobs/{id}Poll a generation job (Generate a video, or Bring a still to life) until it is COMPLETED or FAILED. Images, speech and stickers answer synchronously and have no job. A job that fails is refunded.
Path parameters#
idstringrequiredTheidfrom Generate a video or Bring a still to life.
Response#
Returns 200.
Response fields#
jobobjectThe job.Show 9 child fields
idstringJob id.statusenumWhere it is.One ofPROCESSING,COMPLETED,FAILEDkindenumWhich endpoint made it.One ofvideo,liveoutputUrlstring or nullThe clip, onceCOMPLETED.errorstring or nullWhy it failed.durationSecinteger or nullSeconds generated, once finished.creditsobjectOnce finished:{ charged, refunded }(chargedmay benullon an old job). Alivejob addsrefundedCredits.modelstringliveonly:vidmoat-image-live-1, withtier,methodandmotion, and theactionVerified,poseChangeandactionCaveatfields when they apply.warningstringPresent when the provider could not be checked this time; poll again.
hintstringOnly on the poll that completes a video job; later polls answer from the stored row without it.
Errors#
Besides the errors any request can get (authentication, rate limits):
| Status | Code | When |
|---|---|---|
| 404 | not_found | No such generation job on your projects. |