---
title: "Queue a render"
method: POST
path: "/renders"
tags: ["Rendering"]
---

# Queue a render

`POST /renders`

## Request

- Base URL: `https://api.vidmoat.com/v1`
- URL: `https://api.vidmoat.com/v1/renders`
- Auth: HTTP bearer

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

## Request body

- object
  - `projectId` string, required: A project you own, with at least one clip.
  - `format` 'mp4' | 'webm' | 'gif': Container. Any other value becomes `mp4`.
  - `quality` 'draft' | 'standard' | 'high': Encoder quality. Any other value becomes `standard`.
  - `resolution` 'full' | 'half': Half renders at half the project height.

## Response `202`

Queue a render

- object
  - `render` object: The job, `PENDING` at first.
    - `id` string: Render job id.
    - `projectId` string: The project rendered.
    - `status` 'PENDING' | 'PROCESSING' | 'COMPLETED' | 'FAILED' | 'CANCELLED': Where the job is.
    - `progress` integer: 0 to 100.
    - `format` string: `mp4`, `webm` or `gif`.
    - `resolution` string: `full` or `half`.
    - `quality` string: `draft`, `standard` or `high`.
    - `url` string, nullable: The download URL once `COMPLETED`.
    - `error` string, nullable: Why it failed, when `FAILED`.
    - `createdAt` string: ISO 8601 time.
    - `updatedAt` string: ISO 8601 time.
  - `applied` object: What the plan decided: `{ resolution, watermark, priority }`, plus `maxHeight` and `cappedByPlan: true` when the plan capped the height.
  - `poll` string: The path to poll.

## Other responses

- `400`: `invalid_request`: `projectId` is missing, or the project has no clips.
- `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.
- `404`: `not_found`: No such project, or not yours.

---

[API](https://skmtc.dev/vidmoat/apis/vidmoat-api.md) · [All operations](https://skmtc.dev/vidmoat/apis/vidmoat-api/llms.txt) · [OpenAPI document](https://skmtc.dev/vidmoat/apis/vidmoat-api/revisions/23e24e25c756?raw)