Skip to main content
GET

Overview

Returns one rendered video: its status, progress and, once it is ready, a download link. A video exists once a project’s render has started. Its ID comes from Get Project (data.video.id), List Videos, Render Project or a webhook payload (data.videoId). If you only have the projectId from a create endpoint, use Get Project: it returns the same video object under video, and also covers the generation stage before the render.

Video status

The video is rendering. progress shows how far along it is and url is "".
The video is ready. Download it from url. The link is signed and expires: request the video again for a fresh one instead of storing it. The thumbnail is generated shortly after.
The render failed; message says why. Render the project again with Render Project, which costs no credits.

Errors

Retrying this GET is always safe. To be notified instead of polling, pass a webhook when you create the project; see Webhooks.

Get Project

Follow a project from create to video

List Videos

All rendered videos of your team

Webhooks

Get notified when a video is ready

Render Project

Render a project again

Authorizations

x-api-key
string
header
required

Path Parameters

videoId
string
required

The video ID: data.video.id from GET /v1/project/{projectId}, an item of GET /v1/video/list, data.videoId from POST /v1/render, or data.videoId in a webhook payload.

Response

Video

success
boolean
message
string
data
object

A rendered video. A video exists once a project's render has started; each render of a project is a new video.