---
title: "Get a render"
method: GET
path: "/renders/{id}"
tags: ["Rendering"]
---

# Get a render

`GET /renders/{id}`

## Request

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

Poll a job: PENDING, then PROCESSING, then COMPLETED or FAILED, with progress 0 to 100 and the download URL on completion.

Poll every few seconds, not every few hundred milliseconds: the rate limiter does not distinguish an eager poller from an attack. Subscribe to render.completed and render.failed in the Webhooks console instead.

## Path parameters

- `id` string, required

## Response `200`

Get a render

- object
  - `render` object: The job.
    - `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.

## Other responses

- `404`: `not_found`: No such job, 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)