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

Video Avatar API Usage

Description#

Purpose: Generate a video to synchronize the mouth movements of a specified digital human with the audio.
Sources of digital humans:
Users upload videos to customize digital humans (avatarSourceFrom=0).
Use the system's existing public digital human ID (referred to as public model below) (avatarSourceFrom=1).
Use the user-defined digital human ID (referred to as private model below) (avatarSourceFrom=2).
Users upload images to customize digital humans (avatarSourceFrom=3).
Sources of audio:
Users upload audio (audioSourceFrom=0).
Use text-to-speech (TTS) (audioSourceFrom=1).
About avatar1 and avatar2 modes:
Avatar 1 (parameter modeType=0)Avatar 2 (parameter modeType=1)
Image inputNot supportedTake the image as the first frame input of Avatar 2, and the character movements in the subsequent video will be automatically generated according to the audio rhythm
Video inputOnly modify the mouth shape according to the audio, without changing the character movements in the videoTake the first frame of the video as the first frame input of Avatar 2, and the character movements in the subsequent video will be automatically generated according to the audio rhythm

Main Process#

1.
Call the Get Upload Credential interface. Pay attention to the uploadUrl and fileId fields returned by the interface.
2.
Upload the local audio/video/image to the address of uploadUrl. Upload File
3.
Call the submit task interface. Pay attention to the taskId field returned by the interface.
4.
Call the query task interface to obtain the task execution status and results.

Optional Processes#

1.
To use a public model digital human when submitting a task, please call AiAvatar Query.
2.
When querying public model digital humans, if you want to search by ethnicity, please call Ethnicity Query with the parameter scene=video_avatar.
3.
To use a public voice when submitting a task, please call Voice Query.
4.
If you want to save the video as a private model when submitting the task, set the parameter isSave2CustomAiAvatar=true.
5.
If you want to specify the subtitle style when submitting the task, please call Caption List.
Modified at 2025-08-14 06:42:31
Previous
Export
Next
submit task
Built with