query task

Developing

GET

/v1/video_avatar/task/query

Request

Query Params

taskId

string

required

task id.

needCloudFrontUrl

boolean

optional

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

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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

task status.
init/running/success/fail

errorMsg

string

required

inputVideoFileId

string

required

user inputed video file id

inputAudioFileId

string

required

user inputed audio file id.

outputVideoUrl

string

required

output video file url.

Example

{
    "code": "string",
    "message": "string",
    "result": {
        "taskId": "string",
        "status": "string",
        "errorMsg": "string",
        "inputVideoFileId": "string",
        "inputAudioFileId": "string",
        "outputVideoUrl": "string"
    }
}

Modified at 2025-05-16 06:17:27

submit task

submit scraper task