VideoAvatar Submit - 302.AI API Document

VideoAvatar is an AI digital human video generation interface provided by the Topview platform. It allows users to easily generate dynamic videos featuring digital human explanations by selecting an AI Avatar and audio material. This capability is widely used in content creation, marketing videos, and more.
Demo Video 1
Demo Video 2
Pricing: 0.008/s, or 0.04ptc/100 characters

Request

Header Params

Authorization

string

optional

Example:

Bearer {{YOUR_API_KEY}}

Body Params application/json

avatarSourceFrom

integer

required

Digital human source: 0 - User uploaded video file; 1 - Digital human list; 2 - Custom digital human
Allowed values:
0
1
2

aiAvatarId

string

required

aiAvatarId: This field must be provided when avatarSourceFrom equals 1.

audioSourceFrom

integer

required

Audio Source: 0 - User-uploaded audio file; 1 - Text-to-speech.
Allowed values:
0
1

audioFileId

string

optional

When audioSourceFrom is 0, this field is required.

videoFileId

string

optional

The file ID of the video you uploaded via the upload API. This field must be provided when avatarSourceFrom is equal to 0.

ttsText

string

optional

User input content. This field is required when audioSourceFrom equals 1.

captionId

string

required

Only supports avatarSourceFrom equal to 1, and caption_id is obtained from the API.

voiceoverId

string

required

Obtain from voiceId. When audioSourceFrom equals 1 and avatarSourceFrom equals 0 or 2, this field must be provided.
When audioSourceFrom equals 1 and avatarSourceFrom equals 1, voiceoverId being null means the default voiceover ID of the digital human will be used.

isSave2CustomAiAvatar

string

optional

Whether to create a digital human from the current video, default is false

Example

{
    "avatarSourceFrom": 1,
    "aiAvatarId": "3325",
    "audioSourceFrom": 0,
    "audioFileId": "a55d7f81d297403e9f2149095f3bccbb"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200成功

application/json

Body

code

string

required

message

string

required

result

object

required

taskId

string

required

status

string

required

errorMsg

null

required

subTaskId

string

required

Example

{
    "code": "200",
    "message": "Success",
    "result": {
        "taskId": "41a13acfff334b689dc31034fb3143b7",
        "status": "success",
        "errorMsg": null,
        "subTaskId": "41a13acfff334b689dc31034fb3143b7"
    }
}