Topview-api
  1. Avatar Marketing Video
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. Avatar Marketing Video

query task

Developing
GET
/v1/m2v/task/query

Request

Query Params
taskId
string 
required
submit task后返回的taskId
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/m2v/task/query?taskId=&needCloudFrontUrl' \
--header 'Topview-Uid;' \
--header 'Authorization;'

Responses

🟢200成功
application/json
Body
code
string 
required
message
string 
required
result
object 
required
taskId
string 
required
status
string 
required
errorMsg
string 
optional
exportVideos
array [object {7}] 
optional
previewVideos
array [object {7}] 
optional
productName
string 
optional
产品名称
productDescription
string 
optional
产品描述
videoSceneInfoList
array [object {8}] 
optional
视频分镜信息列表
imageSceneInfoList
array [object {5}] 
optional
scriptContentList
array [object {2}] 
required
Example
{
    "code": "string",
    "message": "string",
    "result": {
        "taskId": "string",
        "status": "string",
        "errorMsg": "string",
        "exportVideos": [
            {
                "scriptId": 0,
                "status": "string",
                "title": "string",
                "description": "string",
                "videoUrl": "string",
                "coverUrl": "string",
                "videoDuration": 0
            }
        ],
        "previewVideos": [
            {
                "scriptId": 0,
                "status": "string",
                "title": "string",
                "description": "string",
                "videoUrl": "string",
                "coverUrl": "string",
                "videoDuration": 0
            }
        ],
        "productName": "string",
        "productDescription": "string",
        "videoSceneInfoList": [
            {
                "mediaId": "string",
                "seq": 0,
                "mediaType": "string",
                "sceneAnalyseDesc": "string",
                "sceneFileName": "string",
                "videoSceneCoverUrl": "string",
                "start": 0,
                "end": 0
            }
        ],
        "imageSceneInfoList": [
            {
                "mediaId": "string",
                "mediaType": "string",
                "sceneAnalyseDesc": "string",
                "sceneFileName": "string",
                "imageSceneUrl": "string"
            }
        ],
        "scriptContentList": [
            {
                "scriptId": "string",
                "scriptContents": [
                    {
                        "segId": "string",
                        "segText": "string"
                    }
                ]
            }
        ]
    }
}
Modified at 2025-06-12 02:44:41
Previous
submit task
Next
export
Built with