Video Creation API
The video creation service allows you to transform your static images into dynamic animations using artificial intelligence.Generate a video
Request Parameters
string
required
The unique user identifier (UUID) that you can retrieve from your Developer Space
array
required
Array of URLs of images to animate. Currently, the first image in the array is used for video creation.
string
required
Desired animation type. Possible values: “ZOOM_IN”, “ZOOM_OUT”, “PAN_RIGHT”, “PAN_LEFT”, “PAN_UP”, “PAN_DOWN”, “CAMERA_PUSH_OUT”, “AUTO_EFFECTS”, “AUTO_REVERSE”
string
Textual description to guide the visual style of the animation. Only used if the option is not “AUTO_EFFECTS” or “AUTO_REVERSE”. For these automatic options, the prompt is automatically generated by AI.
string
Video orientation format. Possible values: “portrait” (768x1280 format) or any other value for landscape format (1280x768). By default, landscape format is used.
string
Webhook URL to receive a notification when the generation is complete
Response
string
The unique generation identifier (UUID) to use with the retrieval API
number
The number of video credits remaining for the user
string
The unique project identifier (UUID)
Request Example
Response Example
Available Animation Types
Retrieve a video
Request Parameters
string
required
The unique user identifier (UUID) that you can retrieve from your Developer Space
string
required
The unique generation identifier (UUID) returned by the generation API
Response
string
Generation status: “STARTING”, “IN_PROGRESS”, “SUCCEEDED”, “FAILED”
array
Array containing the URLs of generated videos (present only if status=“SUCCEEDED”)
Request Example
Response Example
Possible Generation States
Important note: In case of “FAILED” status, your video credits are automatically refunded.
