Queue a render
POST
https://api.vidmoat.com/v1/rendersQueue an export of a project's saved document. Resolution cap, watermark and concurrency come from the owner's plan.
Body#
projectIdstringrequiredA project you own, with at least one clip.formatenumdefaultmp4Container. Any other value becomesmp4.One ofmp4,webm,gifqualityenumdefaultstandardEncoder quality. Any other value becomesstandard.One ofdraft,standard,highresolutionenumdefaultfullHalf renders at half the project height.One offull,halflinearbooleanAn 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 carriesplainsaying which route it is.pathstring[]An interactive project: the route to render as option ids, one per choice. Implieslinear. A route that goes back to an earlier scene is refused, with the reason.fastbooleanFast export.truemay spend fast-export packs you bought;falserenders at standard speed; omitted spends only the fast exports your plan includes.
Response#
Returns 202.
Response fields#
renderobjectThe job,PENDINGat first.Show 11 child fields
idstringRender job id.projectIdstringThe project rendered.statusenumWhere the job is.One ofPENDING,PROCESSING,COMPLETED,FAILED,CANCELLEDprogressinteger0 to 100.formatstringmp4,webmorgif.resolutionstringfullorhalf.qualitystringdraft,standardorhigh.urlstring or nullThe download URL onceCOMPLETED.errorstring or nullWhy it failed, whenFAILED.createdAtstringISO 8601 time.updatedAtstringISO 8601 time.
appliedobjectWhat the plan decided:{ resolution, watermark, priority }, plusmaxHeightandcappedByPlan: truewhen the plan capped the height.pollstringThe path to poll.plainobjectOnly withlinearorpath:{ 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):
| Status | Code | When |
|---|---|---|
| 400 | invalid_request | projectId is missing, the project has no clips, or linear/path was refused for this interactive project (the message says why). |
| 404 | not_found | No such project, or not yours; or a personal voiceover on the timeline was deleted or never authorised for this project. |
| 402 | quota_exceeded | Monthly exports used up, too many renders running at once for the plan, or the project uses media the plan cannot export. |