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.

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 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.

extras
object

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