Submit task

POST

/v1/m2v/task/submit

Parameter Description

If both productLink and fileIds exist, the parameter of fileIds will be ignored, and all videos and images parsed from productLink will be used by default.

Request

Header Params

Body Params application/json

Example

{
    "productLink": "string",
    "fileIds": [
        "string"
    ],
    "productName": "string",
    "productDescription": "string",
    "aspectRatio": "string",
    "language": "string",
    "voiceId": "string",
    "captionId": "string",
    "aiavatarId": "string",
    "videoLengthType": 0,
    "endcardFileId": "string",
    "endcardAspectRatio": "string",
    "endcardBackgroundColor": "string",
    "logoFileId": "string",
    "preview": true,
    "isDiyScript": false,
    "diyScriptDescription": "string",
    "targetAudience": "string",
    "noticeUrl": "string"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.topview.ai/v1/m2v/task/submit' \
--header 'Topview-Uid;' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "productLink": "string",
    "fileIds": [
        "string"
    ],
    "productName": "string",
    "productDescription": "string",
    "aspectRatio": "string",
    "language": "string",
    "voiceId": "string",
    "captionId": "string",
    "aiavatarId": "string",
    "videoLengthType": 0,
    "endcardFileId": "string",
    "endcardAspectRatio": "string",
    "endcardBackgroundColor": "string",
    "logoFileId": "string",
    "preview": true,
    "isDiyScript": false,
    "diyScriptDescription": "string",
    "targetAudience": "string",
    "noticeUrl": "string"
}'

Responses

🟢200成功

application/json

Body

Example

{
    "code": "string",
    "message": "string",
    "result": {
        "taskId": "string",
        "status": "string",
        "errorMsg": null
    }
}

Modified at 2025-09-16 10:32:18

Update script content

Query task

Submit task

Parameter Description#

Request

Request Code Samples

Responses

Parameter Description