Skip to content

Queue a render

POSThttps://api.vidmoat.com/v1/renders
Bearer tokenScope render.writeexport quotaTry it in the playground

Queue an export of a project's saved document. Resolution cap, watermark and concurrency come from the owner's plan.

Body#

  • projectIdstringrequired
    A project you own, with at least one clip.
  • formatenumdefault mp4
    Container. Any other value becomes mp4.
    One of mp4, webm, gif
  • qualityenumdefault standard
    Encoder quality. Any other value becomes standard.
    One of draft, standard, high
  • resolutionenumdefault full
    Half renders at half the project height.
    One of full, half
  • linearboolean
    An interactive project: render the plain video of its default route (the first option of each choice), with an end card naming the interactive link when one is published and shared. The reply carries plain saying which route it is.
  • pathstring[]
    An interactive project: the route to render as option ids, one per choice. Implies linear. A route that goes back to an earlier scene is refused, with the reason.
  • fastboolean
    Fast export. true may spend fast-export packs you bought; false renders at standard speed; omitted spends only the fast exports your plan includes.

Response#

Returns 202.

Response fields#

  • renderobject
    The job, PENDING at first.
    Show 11 child fields
    • idstring
      Render job id.
    • projectIdstring
      The project rendered.
    • statusenum
      Where the job is.
      One of PENDING, PROCESSING, COMPLETED, FAILED, CANCELLED
    • progressinteger
      0 to 100.
    • formatstring
      mp4, webm or gif.
    • resolutionstring
      full or half.
    • qualitystring
      draft, standard or high.
    • urlstring or null
      The download URL once COMPLETED.
    • errorstring or null
      Why it failed, when FAILED.
    • createdAtstring
      ISO 8601 time.
    • updatedAtstring
      ISO 8601 time.
  • appliedobject
    What the plan decided: { resolution, watermark, priority }, plus maxHeight and cappedByPlan: true when the plan capped the height.
  • pollstring
    The path to poll.
  • plainobject
    Only with linear or path: { route, seconds, endCard, link, note }, the route rendered, so the plain video is never taken for the interactive one.

Errors#

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

StatusCodeWhen
400invalid_requestprojectId is missing, the project has no clips, or linear/path was refused for this interactive project (the message says why).
404not_foundNo such project, or not yours; or a personal voiceover on the timeline was deleted or never authorised for this project.
402quota_exceededMonthly exports used up, too many renders running at once for the plan, or the project uses media the plan cannot export.