Topview-api
  1. Video Avatar
Topview-api
  • API文档
  • 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
  • Product Avatar
    • Product Avatar API Usage
    • Replace Product Image
      • submit task
      • query task
    • Image2Video
      • submit task
      • query task
    • Category Query
      GET
    • Public product avatar Query
      GET
  • Product AnyShoot
    • Replace Product Image
      • submit task
      • query task
    • Template Category
      GET
    • Template List
      GET
  • Common Task
    • image2Video
      • submit task
      • query task
  • Scraper
    • submit scraper task
      POST
    • query scraper task
      GET
  • Upload
    • Get Upload Credential
      GET
    • Get Upload Check
      GET
  • check notice url
    POST
  • Voice Query
    GET
  • Ethnicity Query
    GET
  • AiAvatar Query
    GET
  • Caption List
    GET
  1. Video Avatar

query task

Developing
GET
/v1/video_avatar/task/query

Request

Query Params
taskId
string 
required
任务id。
task id.
needCloudFrontUrl
boolean 
optional
是否需要返回CloudFront的url,true-返回cf的url;false-会返回s3的url
Whether to return a CloudFront URL: true - returns the CloudFront URL; false - will return the S3 URL
Header Params
Topview-Uid
string 
required
Authorization
string 
required

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 GET 'https://api.topview.ai/v1/video_avatar/task/query?taskId&needCloudFrontUrl' \
--header 'Topview-Uid;' \
--header 'Authorization;'

Responses

🟢200OK
application/json
Body
code
string 
required
message
string 
required
result
object 
required
taskId
string 
required
status
string 
required
任务状态 init/running/success/fail
errorMsg
string 
required
inputVideoFileId
string 
required
输入的视频文件id
inputAudioFileId
string 
required
输入音频文件id
outputVideoUrl
string 
required
输出的视频文件url
Example
{
    "code": "string",
    "message": "string",
    "result": {
        "taskId": "string",
        "status": "string",
        "errorMsg": "string",
        "inputVideoFileId": "string",
        "inputAudioFileId": "string",
        "outputVideoUrl": "string"
    }
}
Modified at 2025-04-30 11:15:29
Previous
submit task
Next
Product Avatar API Usage
Built with