POST
/
videos
/
{id}
/
render

Authorizations

x-api-key
string
headerrequired

API key to be included in the x-api-key header

Path Parameters

id
string
required

The id of the Video to render

Response

200 - application/json
id
string
name
string
createdAt
string
updatedAt
string
status
string

Can be either IDLE, GENERATING_AUDIO, GENERATING_VIDEO, DONE or FAILED.

moments
object[]

An array of Moment items, each representing a portion of the complete video.

videoUrl
string

The url of the final avatar rendering video, containing all the moments merged.

videoUrlSubtitled
string

The url of the final avatar rendering video with subtitles. Only available if subtitles are enabled.

subtitles
object

Subtitles settings for the video

extras
object

A dictionary of custom key-value pairs to extend the video metadata. Maximum of 5 key-value pairs of 256 characters allowed.

Was this page helpful?

/videos/{id}/webhooks