You can use this endpoint to create avatar videos.

Request Body

FieldTypeDescription
background
stringThe background of the whole video. Could be:
- A public HTTP link of an image (jpg/jpeg/png)
- A public HTTP link of a video (mp4 only). The background will loop the whole video if the background video is shorter than the whole video.
- A six-bit hex color code starts with #. (e.g. #FAFAFA)
ratiostringAspect ratio of the video, should be one of
- 16:9
- 9:16
testboolSet the test flag to true to use test mode. Generation in test mode will not cost your credits and will contain a watermark on your video.
versionstringSet it to v1alpha . The version is alpha now, the API will keep the current version if there is any breaking change.
caption_openboolSet it true to create video with caption. Only text input supports caption
clipsA list of clips represents the content of the video.
clips[].avatar_idstringA unique identifier of an avatar. Only one of the avatar_id and talking_photo_id appears.
clips[].avatar_stylestringThe style of the avatar should be one of
- normal
- circle
clips[].input_textstringThe text content that an avatar/talking_photo speaks. Only one of the input_text and input_audio should be used.
clips[].input_audiostringThe audio url that an avatar/talking_photo speaks. Only one of the input_text and input_audio should be used.
clips[].scalefloatThe scale of the avatar or talking photo,
1 means to scale the avatar/talking photo to the whole screen.
0.5 means scale the avatar/talking photo to half of the screen
clips[].offsetSpecify the position of the avatar or talking photo.
clips[].offset.xfloatHorizontal position of the avatar or talking photo.
- 0 means center horizontally
- -0.5 means the center of the avatar (or talking photo) is on the left of the screen.
- 0.5 means the center of the avatar (or talking photo) is on the right of the screen.
clips[].offset.yfloatVertical position of the avatar or talking photo.
- 0 means center vertically.
- -0.5 means the center of the avatar (or talking photo) is on the bottom of the screen.
- 0.5 means the center of the avatar (or talking photo) is on the top of the screen.
clips[].talking_photo_idA unique identifier of a talking photo. Only one of the avatar_id and talking_photo_id appears.
clips[].talking_photo_styleThe style of the talking photo should be one of
- normal
- circle

Response

FieldTypeDescription
id
stringUnique identifier for the object.
errorjsonOptional, the error detail of the video.
statusstringVideo status, one of
- processing (The video is rendering)
- completed (The video render success)
- failed (An error occurred when rendering video).
video_urlstringThe URL of the video after completed. The URL will be expired in a few days.
Language
Authorization
Header
Click Try It! to start a request and see the response here!