POST
/
videos

Authorizations

x-api-key
string
headerrequired

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

Body

application/json
name
string
required
moments
object[]
required

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

subtitles
object

Subtitles settings for the video

aspectRatio
enum<string>

Select desired output aspectRatio: 16:9 or 9:16. Optional, default depends on used avatar.

Available options:
16:9,
9:16
extras
object

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

Response

201 - 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/videos/{id}