Skip to content
VIDMOATDocs

Get a generation job

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

Poll a video generation job 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.

Response#

Returns 200.

Response fields#

  • jobobject
    The job.
    Show 8 child fields
    • idstring
      Job id.
    • statusenum
      Where it is.
      One of PROCESSING, COMPLETED, FAILED
    • kindstring
      video.
    • outputUrlstring or null
      The clip, once COMPLETED.
    • errorstring or null
      Why it failed.
    • durationSecinteger
      Seconds generated, once finished.
    • creditsobject
      Once finished: { charged, refunded }.
    • warningstring
      Present when the provider could not be checked this time; poll again.
  • hintstring
    Present on completion.

Errors#

Besides the errors any request can get (authentication, rate limits):

StatusCodeWhen
404not_foundNo such video job on your projects.