Skip to main content
POST

Authorizations

Authorization
string
header
required

API Key authentication. Format: Bearer YOUR_API_KEY.

Body

application/json

Animate a starting frame or connect a first and last frame.

first_frame_image
string<uri>
required

Starting frame. Use an HTTPS URL or asset://<asset_id> from Register Provider Asset.

Minimum string length: 1
Example:

"https://example.com/first.jpg"

last_frame_image
string<uri>

Ending frame. Use an HTTPS URL or asset://<asset_id> from Register Provider Asset.

Minimum string length: 1
Example:

"https://example.com/last.jpg"

prompt
string

Text prompt describing the desired animation.

Required string length: 1 - 10000
Example:

"Animate the scene gently with natural motion"

ratio
enum<string>
default:adaptive

Preserves the starting image's aspect ratio. Omit this field or use adaptive.

Available options:
adaptive
Example:

"adaptive"

resolution
enum<string>
default:720p

Output resolution.

Available options:
480p,
720p
Example:

"720p"

duration
enum<integer>
default:5

Output duration in seconds.

Available options:
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

generate_audio
boolean
default:true

Whether to generate an audio track with the video

Example:

true

output_format
enum<string>
default:mp4

Output video container format.

Available options:
mp4,
mov
Example:

"mp4"

execution_expires_after
integer
default:172800

Maximum time in seconds before the task expires.

Required range: 3600 <= x <= 259200
Example:

172800

return_last_frame
boolean
default:false

Whether to return the last frame of the generated video

Example:

false

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.