Skip to main content
POST

Authorizations

​
Authorization
string
header
required

API Key authentication. Format: Bearer YOUR_API_KEY.

Body

application/json

At least one of prompt, file_url, or link_url is required (anyOf below). file_url and link_url are mutually exclusive. resolution/ratio/duration/audio have defaults when omitted.

​
prompt
string
required

Text prompt describing the desired video content. Supports Chinese and English. Max 20000 characters. Required unless file_url or link_url is provided.

Required string length: 1 - 20000
Example:

"A cute cat running on a moonlit rooftop, cinematic."

​
file_url
string<uri>

Reference file URL. Supported formats: docx, doc, xlsx, xls, pptx, ppt, pdf, txt, key, pages, numbers, md. Max 100MB; page-based formats up to 50 pages. HTTP/HTTPS or oss:// temporary URL. Mutually exclusive with link_url. May be used alone or with prompt.

Example:

"https://example.com/glass.pptx"

​
link_url
string<uri>

Public webpage URL that does not require login. HTTP/HTTPS only. Mutually exclusive with file_url. May be used alone or with prompt.

Example:

"https://example.com/article"

​
resolution
enum<string>
default:1080P

Specifies the resolution tier for the generated video

Available options:
480P,
720P,
1080P
Example:

"1080P"

​
ratio
enum<string>
default:1:1

Specifies the aspect ratio for the generated video

Available options:
16:9,
4:3,
1:1,
3:4,
9:16
Example:

"1:1"

​
duration
enum<integer>
default:5

Video duration in seconds. Allowed values are integers from 2 to 30

Available options:
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30
Example:

5

​
audio
boolean
default:true

Whether the output video includes an audio track

Example:

true

​
seed
integer

Random number seed for reproducibility. Identical seeds cannot guarantee completely identical results

Required range: 0 <= x <= 2147483647
Example:

12345

Response

200 - application/json

Task submitted successfully

​
code
integer
required

Response code, 0 indicates success

Example:

0

​
message
string
required

Response message

Example:

"success"

​
data
object
required

Detailed data about the submitted asynchronous task.