Sign in

v1

latestOpenAPI 3.0.32026-07-241112213.6 KB

New Endpoint

This is your first endpoint! Edit this page to start documenting your API.

post/v1/m2v/task/submit

Request body

productLinkstring required

Either productLink or fileIds must be non-empty. </br>

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. </br> Example: https://www.amazon.com/dp/B0CXVSRY56/ref=sspa_dk_crr_aax_0?sp_csd=d2lkZ2V0TmFtZT1zcF9jcnJfc2hhcmVk&th=1

fileIdsstring[] required

Videos or images. Obtain the fileId after uploading through the file upload interface. </br>

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. </br> Example: 5664bb315f814bee8c45f023efff0bf2

productNamestring

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

productDescriptionstring

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

aspectRatio'9:16' | '3:4' | '1:1' | '4:3' | '16:9'

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

language'en' | 'ar' | 'bg' | 'hr' | 'cs' | 'da' | 'nl' | 'fil' | 'fi' | 'fr' | 'de' | 'el' | 'hi' | 'hu' | 'id' | 'it' | 'ja' | 'ko' | 'ms' | 'nb' | 'pl' | 'pt' | 'ro' | 'ru' | 'zh-CN' | 'sk' | 'es' | 'sv' | 'zh-Hant' | 'tr' | 'uk' | 'vi' | 'th'

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

voiceIdstring

Obtain it through the voice query interface.

captionIdstring

Obtained through the caption list interface. If not specified, then randomly.

aiavatarIdstring

Obtain it through the aiAvatar query interface.

videoLengthType1 | 2 | 3 | 4

Default value: 1, optional values: 1, 2, 3, 4.</br> 1： 30-50s</br> 2： 15-30s</br> 3： 30-45s</br> 4： 45-60s</br>

endcardFileIdstring

Obtain it after uploading through the file upload interface.

endcardAspectRatio'all' | '9:16' | '3:4' | '1:1' | '4:3' | '16:9'

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

endcardBackgroundColorstring

Default value: black. Optional values: black, white

logoFileIdstring

Obtain it after uploading through the file upload interface.

previewstring

Default value: false. When set to true, a preview video will be returned first. When you need to export the video, you need to trigger the export interface for export. When set to false or empty, an exported video will be returned.

isDiyScriptstring

Whether to use custom scripts. True - Use custom script, default false

diyScriptDescriptionstring

Customize script content. It will only take effect when isDiyScript=true

diyStyle'diyScriptStyle' | 'diyScriptPrompt'

Script style type, optional values: "diyScriptStyle" (using preset style), "diyScriptPrompt" (using custom Prompt)

  1. Used in conjunction with the DIY Script Style and DIY Script Prompt fields
  2. It only takes effect when isDiyScript=false
diyScriptStyle'Pain points + harms + solutions, using fear-based hooks' | 'Pain points + harms + solutions, using curiosity-based hooks' | 'Pain points + harms + solutions, using pitfalls-based hooks' | 'Pain points + harms + solutions, using pain point hooks' | 'Pain points + harms + solutions, using hooks related to relationships' | 'Attention-grabbing opening + setting expectations + solutions, using reveal-type hooks' | 'Attention-grabbing opening + setting expectations + solutions, using pitfalls-based hooks' | 'Attention-grabbing opening + setting expectations + solutions, using fear-based hooks' | 'Attention-grabbing opening + setting expectations + solutions, using cognitive contrast hooks' | 'Use a structure that foregrounds benefits and results' | 'Revealing industry secrets + setting expectations + solutions structure' | 'Leveraging celebrities/hot topics/public choices' | 'Conveying benefits + reinforcing expectations + solutions' | 'Sharing personal real stories, using curiosity hooks' | 'Sharing personal true stories, using cautionary hooks' | 'Sharing personal true stories' | 'Contrast structure of mistakes and correct actions' | 'Pain points + harms + solutions, with emoji😀' | 'Attention-grabbing opening + setting expectations + solutions, with emoji😀' | 'Use a structure that foregrounds benefits and results, with emoji😀' | 'Conveying benefits + reinforcing expectations + solutions, with emoji😀' | 'Revealing industry secrets + setting expectations + solutions structure, with emoji😀' | 'Pose a question to grab attention with a relatively formal tone' | 'Meticulous corporate introduction' | 'Storytelling style' | 'Concise and clear style' | 'Comparative analysis style' | 'Brand-oriented, storytelling' | 'Introduced from the user's first-person perspective' | 'News broadcast style' | 'Science Education Style' | 'Daily Life Style' | 'Auto-select by AI'

Preset script style, when diyStyle=diyScriptStyle, value needs to be passed

diyScriptPromptstring

Custom script style description, when diyStyle=diyScriptPrompt, value needs to be passed

targetAudiencestring

The target audience can better guide the AI in script writing.

musicFileIdstring

Customize the background music ID and obtain it after uploading through the file upload interface. If it is empty, use random music

noticeUrlstring

NoticeUrl. Please refer to the API documentation for details NoticeUrl

Response

codestring required

200:success Other:fail

messagestring required