Skip to content

Get a generation job

GEThttps://api.vidmoat.com/v1/ai/jobs/{id}
Bearer tokenScope ai.videoFreeTry it in the playground

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#

  • idstringrequired
    The id from Generate a video or Bring a still to life.

Response#

Returns 200.

Response fields#

  • jobobject
    The job.
    Show 9 child fields
    • idstring
      Job id.
    • statusenum
      Where it is.
      One of PROCESSING, COMPLETED, FAILED
    • kindenum
      Which endpoint made it.
      One of video, live
    • outputUrlstring or null
      The clip, once COMPLETED.
    • errorstring or null
      Why it failed.
    • durationSecinteger or null
      Seconds generated, once finished.
    • creditsobject
      Once finished: { charged, refunded } (charged may be null on an old job). A live job adds refundedCredits.
    • modelstring
      live only: vidmoat-image-live-1, with tier, method and motion, and the actionVerified, poseChange and actionCaveat fields when they apply.
    • warningstring
      Present when the provider could not be checked this time; poll again.
  • hintstring
    Only 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):

StatusCodeWhen
404not_foundNo such generation job on your projects.