v1

latestOpenAPI 3.0.32026-07-241112213.6 KB

New Endpoint

This is your first endpoint! Edit this page to start documenting your API.

post/v1/video_avatar/task/submit

Headers

Topview-Uidstring required
Authorizationstring required

Request body

avatarSourceFrom'0' | '1' | '2' | '3' required

The sources of avatars: Allowed values: 0 1 2 3. 0-user local video; 1-When isCustom is null or false of the API AiAvatar List; 2- When isCustom is true of the API AiAvatar List; 3-user local photo.

videoFileIdstring

File id you uploaded video via the upload api. When avatarSourceFrom equals 0, this field must be provided.

aiAvatarIdstring required

Voice over id. When audioSourceFrom equals 1 and avatarSourceFrom equals 0 or 2, this field must be provided. When audioSourceFrom equals 1 and avatarSourceFrom equals 1, voiceoverId is null means use the default voiceover id of the avatar.

isSave2CustomAiAvatarboolean

Whether create avatar from current video

captionIdstring

Only support avatarSourceFrom equals 1, caption_id from interface. Caption List

noticeUrlstring

Please refer to the API documentation for details NoticeUrl

imageFileIdstring

File id via the upload api. When audioSourceFrom equals 3, this field must be provided.

modeTypestring

Mode type. 0-avatar1, 1-avatar2 Allowed values: 0 1. Defaults to 0

audioSourceFromstring required

enum<integer> required The sources of audio: 0-user uploaded audio file; 1- text to speech. Allowed values: 0 1

audioFileIdstring

File id via the upload api. When audioSourceFrom equals 0, this field must be provided.

ttsTextstring required

User input content. When audioSourceFrom equals 1, this field must be provided.

voiceoverIdstring

Voice over id. When audioSourceFrom equals 1 and avatarSourceFrom equals 0 or 2 or 3, this field must be provided. When audioSourceFrom equals 1 and avatarSourceFrom equals 1, voiceoverId is null means use the default voiceover id of the avatar.

voiceSpeednumber

Sound speed, range [0.8 ~ 1.2], default is 1. It only takes effect when audioSourceFrom=1.

Response

Successful response