提交Avatar Marketing Video

POST

/topview/v1/m2v/task/submit

Avatar Marketing Video is Topview's product marketing video generation tool. Users can upload product images, scripts, or materials to easily generate videos demonstrating the product being worn or interacted with, supporting multiple languages.
Demo video: https://d1735p3aqhycef.cloudfront.net/official-website/public/landing-page/home/home.mp4

Price: 2 PTC/time

If both productLink and fileIds parameters are provided, the fileIds parameter will be ignored, and all videos and images parsed from productLink will be used by default.
This interface is asynchronous. After successful submission, an ID will be returned. Users can query the processing result through the Get Marketing video result interface.

Request

Header Params

Authorization

string

optional

Example:

Bearer {{YOUR_API_KEY}}

Body Params application/json

productLink

string

optional

fileIds

array[string]

required

After uploading a video or image through the upload interface, obtain the fileId.

productName

string

required

Can be automatically parsed from the product link. Required when productLink is empty.

productDescription

string

required

Can be automatically parsed from the product link. Required when productLink is empty and isDiyScript=false.

aspectRatio

string

optional

Default value: 9:16. Optional values: 9:16, 3:4, 1:1, 4:3, 16:9

language

string

optional

Default value: en
Language list:
English: en
Arabic (العربية): ar
Bulgarian (Български): bg
Croatian (Hrvatski): hr
Czech (Čeština): cs
Danish (Dansk): da
Dutch (Nederlands): nl
Filipino (Filipino): fil
Finnish (Suomi): fi
French (Français): fr
German (Deutsch): de
Greek (Ελληνικά): el
Hindi (हिन्दी): hi
Hungarian (Magyar): hu
Indonesian (Bahasa Indonesia): id
Italian (Italiano): it
Japanese (日本語): ja
Korean (한국어): ko
Malay (Bahasa Melayu): ms
Norwegian (Norsk): nb
Polish (Polski): pl
Portuguese (Português): pt
Romanian (Română): ro
Russian (Русский): ru
Simplified Chinese (简体中文): zh-CN
Slovak (Slovenčina): sk
Spanish (Español): es
Swedish (Svenska): sv
Traditional Chinese (繁體中文): zh-Hant
Turkish (Türkçe): tr
Ukrainian (Українська): uk
Vietnamese (Tiếng Việt): vi
Thai (ภาษาไทย): th. Currently, the supported voiceIds for Thai are: 5d188a658b5a424e98bf0dbbcb8f97d8, eea5e5a4fb534231a5b4cf4766dd7a5f, 537e2643719c47bdac1d8a2c7f0c844a, e22db502aa8d40d9ba791083c9f4ab35

videoLengthType

integer

optional

Default value: 1. 1: 30-50 seconds; 2: 15-30 seconds; 3: 30-45 seconds; 4: 45-60 seconds

endcardFileId

string

optional

Obtained after uploading via the upload API.

endcardAspectRatio

string

optional

Default value: all. Optional values: all, 9:16, 3:4, 1:1, 4:3, 16:9

endcardBackgroundColor

string

optional

默认值：black。可选值：black、white

isDiyScript

boolean

optional

Whether to use a custom script. True - use a custom script, default is false

diyScriptDescription

string

optional

Custom script content, only effective when isDiyScript=true

Example

{
    "fileIds": [
        "8d745437254941adb141f95836d9454c"
    ],
    "productName": "8d745437254941adb141f95836d9454c.mp4",
    "productDescription": "303 talk"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.302.ai/topview/v1/m2v/task/submit' \
--header 'Content-Type: application/json' \
--data-raw '{
    "fileIds": [
        "8d745437254941adb141f95836d9454c"
    ],
    "productName": "8d745437254941adb141f95836d9454c.mp4",
    "productDescription": "303 talk"
}'

Responses

🟢200成功

application/json

Body

code

string

required

message

string

required

result

object

required

taskId

string

required

Use this taskId to query

status

string

required

errorMsg

null

required

subTaskId

string

required

Example

{"code":"200","message":"Success","result":{"taskId":"f58e38c01cdc497d9c6d05fbf54fef4e","status":"success","errorMsg":null,"subTaskId":"f58e38c01cdc497d9c6d05fbf54fef4e"}}

Modified at 2025-07-10 10:34:11

上传接口

获取Avatar Marketing Video结果