Topview-api-English version
  1. Video Avatar
Topview-api-English version
  • API Document
  • Avatar Marketing Video
    • script
      • List script content
      • Update script content
    • Submit task
      POST
    • Query task
      GET
    • Export
      POST
  • Video Avatar
    • submit task
      POST
    • query task
      GET
  • Scraper
    • submit scraper task
      POST
    • query scraper task
      GET
  • Upload
    • Get Upload Credential
      GET
    • Get Upload Check
      GET
  • Product Avatar
    • Replace Product Image
      • submit task
      • query task
    • Image2Video
      • submit task
      • query task
    • Category Query
      GET
    • Public product avatar Query
      GET
  • Common Task
    • image2Video
      • submit task
      • query task
  • Product AnyShoot
    • Replace Product Image
      • submit task
      • query task
    • Template Category
      GET
    • Template List
      GET
  • Caption List
    GET
  • Voice Query
    GET
  • AiAvatar Query
    GET
  • check notice url
    POST
  • Ethnicity Query
    GET
  1. Video Avatar

submit task

Developing
POST
/v1/video_avatar/task/submit

Description#

1.
The avatar id is from the AiAvatar Query api.
2.
The ethnicity id is from the Ethnicity Query api, and the scene should be passed as video_avatar.
3.
The voiceover id is from the Voice Query api.

Usage Instructions#

1.
When using uploaded video, avatarSourceFrom and videoFileId are required.
2.
When using a public avatar, avatarSourceFrom and aiAvatarId are required.
3.
When using uploaded audio, audioSourceFrom and audioFileId are required.
4.
When using TTS, audioSourceFrom and ttsText are required.
4.1. When using a public avatar, voiceoverId can be omitted to use the digital human's default tone.
4.2. In all other TTS scenarios, voiceoverId is required.

Request

Header Params
Topview-Uid
string 
required
Authorization
string 
required
Body Params application/json
avatarSourceFrom
enum<integer> 
required
The sources of avatars: 0- User uploaded video file; 1- avatar list;
Allowed values:
01
videoFileId
string 
optional
File id you uploaded video via the upload api. When avatarSourceFrom equals 1, this field must be provided.
aiAvatarId
string 
optional
avatar id. When avatarSourceFrom equals 0, this field must be provided.
audioSourceFrom
enum<integer> 
required
The sources of audio: 0-user uploaded audio file; 1- text to speech.
Allowed values:
01
audioFileId
string 
optional
File id via the upload api. When audioSourceFrom equals 0, this field must be provided.
ttsText
string 
optional
User input content. When audioSourceFrom equals 1, this field must be provided.
voiceoverId
string 
optional
Voice over id. When audioSourceFrom equals 1, and avatarSourceFrom equals 0, 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.
Example
{
    "avatarSourceFrom": 0,
    "videoFileId": "string",
    "aiAvatarId": "string",
    "audioSourceFrom": 0,
    "audioFileId": "string",
    "ttsText": "string",
    "voiceoverId": "string"
}

Request 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 --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": "string",
    "aiAvatarId": "string",
    "audioSourceFrom": 0,
    "audioFileId": "string",
    "ttsText": "string",
    "voiceoverId": "string"
}'

Responses

🟢200成功
application/json
Body
object {0}
Example
{}
Modified at 2025-05-21 02:59:46
Previous
Export
Next
query task
Built with