Skip to content
VIDMOATDocs

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

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.

Errors#

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

StatusCodeWhen
400invalid_requestprojectId is missing, or the project has no clips.
404not_foundNo such project, or not yours.
402quota_exceededMonthly exports used up, too many renders running at once for the plan, or the project uses media the plan cannot export.