1. Video Avatar
Topview-api-English version
  • API Document
  • Release Note
  • Image Translate
    • ImageTranslate
  • Photo Avatar/Avatar 4
    • Avatar4
  • Avatar Marketing Video
    • script
      • List script content
      • Update script content
    • Submit task
      POST
    • Query task
      GET
    • Export
      POST
  • Video Avatar
    • Video Avatar API Usage
    • submit task
      POST
    • query task
      GET
  • Scraper
    • submit scraper task
      POST
    • query scraper task
      GET
  • Upload
    • Get Upload Credential
      GET
    • Upload File
      PUT
    • Get Upload Check
      GET
  • Product Avatar
    • v2
      • Product Avatar V2 API Usage
      • Replace Product Image
        • location parameters document
        • submit task
        • query task
      • Image2Video
        • submit task
        • query task
      • Category Query
      • Public product avatar Query
    • v1
      • Product Avatar API Usage
      • Replace Product Image
        • submit task
        • query task
        • download result without watermark
      • Image2Video
        • submit task
        • query task
      • Category Query
      • Public product avatar Query
  • Common Task
    • image2Video
      • submit task
      • query task
    • video2aiavatar
      • submit task
      • query task
    • Image Remove Background
      • submit task
      • query task
  • Product AnyShoot
    • v1
      • Replace Product Image
        • submit task
        • query task
      • Template Category
      • Template List
    • v2
      • Product AnyShoot - V2 - Product Model
      • Product AnyShoot - V2 - Product Background
  • Voice
    • Voice Clone
      • submit task
      • query task
    • text2voice
      • submit task
      • query task
  • Caption List
    GET
  • Voice Query
    GET
  • AiAvatar Query
    GET
  • check notice url
    POST
  • Delete Custom Avatar
    DELETE
  • Delete Custom Voice
    DELETE
  • Ethnicity Query
    GET
  1. Video Avatar

submit task

POST
/v1/video_avatar/task/submit

Usage Instructions#

For reference examples, please see the Examples section in the lower right corner. Only some parameters are explained here.
1.
When using a public digital human model, avatarSourceFrom=1 and aiAvatarId must be passed.
2.
When using an existing private digital human model, avatarSourceFrom=2 and aiAvatarId must be passed.
3.
When using a locally uploaded video as the digital human template, avatarSourceFrom=1 and videoFileId must be passed.
4.
When using a locally uploaded image as the digital human template, avatarSourceFrom=3, imageFileId, and modeType=1 must be passed.
5.
When using local audio to drive the digital human, audioSourceFrom=0 and audioFileId must be passed.
6.
When using text-to-speech (TTS) to drive the digital human, audioSourceFrom=1 and ttsText must be passed.
6.1 When using a public digital human model, voiceoverId can be omitted to use the voice of the public digital human model;
6.2 In other cases where TTS is used, voiceoverId must be passed.
7.
Other parameters can be optionally passed as needed.
1.
When using video + audio/text without saving the digital human, the parameter captionId is invalid.
2.
When using an image, the digital human will definitely be saved, and the isSave2CustomAiAvatar parameter is invalid.

Supplementary Notes#

1.
The avatar ID is obtained from the AiAvatar Query.
2.
The ethnicity ID is obtained from the Ethnicity Query , with the scene parameter set to video_avatar.
3.
The voiceover ID is obtained from the Voice Query.
4.
The caption ID is obtained from the Caption List.

Request

Header Params

Body Params application/json

Examples
{
    "avatarSourceFrom": 0,
    "videoFileId": "test",
    "audioSourceFrom": 0,
    "audioFileId": "test",
    "isSave2CustomAiAvatar": true,
    "modeType": "0"
}

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
cURL
curl --location --request POST 'https://api.topview.ai/v1/video_avatar/task/submit' \
--header 'Topview-Uid;' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "avatarSourceFrom": 0,
    "videoFileId": "test",
    "audioSourceFrom": 0,
    "audioFileId": "test",
    "isSave2CustomAiAvatar": true,
    "modeType": "0"
}'

Responses

🟢200成功
application/json
Body

Example
{
    "code": "string",
    "message": "string",
    "result": {
        "taskId": "string"
    }
}
Modified at 2025-09-12 10:08:56
Previous
Video Avatar API Usage
Next
query task
Built with