Video Creation API
API documentation for the video creation service
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
The unique user identifier (UUID) that you can retrieve from your Developer Space
Array of URLs of images to animate. Currently, the first image in the array is used for video creation.
Desired animation type. Possible values: “ZOOM_IN”, “ZOOM_OUT”, “PAN_RIGHT”, “PAN_LEFT”, “PAN_UP”, “PAN_DOWN”, “CAMERA_PUSH_OUT”
Textual description to guide the visual style of the animation (optional)
Video orientation format. Possible values: “portrait” (768x1280 format) or any other value for landscape format (1280x768). By default, landscape format is used.
Webhook URL to receive a notification when the generation is complete
Response
The unique generation identifier (UUID) to use with the retrieval API
The number of video credits remaining for the user
The unique project identifier (UUID)
Request Example
Response Example
Available Animation Types
Option | Description |
---|---|
ZOOM_IN | Zoom-in effect towards the inside of the image |
ZOOM_OUT | Zoom-out effect moving away from the image |
PAN_RIGHT | Camera movement to the right |
PAN_LEFT | Camera movement to the left |
PAN_UP | Camera movement upward |
PAN_DOWN | Camera movement downward |
CAMERA_PUSH_OUT | Fluid movement combining zoom and displacement |
Retrieve a video
Request Parameters
The unique user identifier (UUID) that you can retrieve from your Developer Space
The unique generation identifier (UUID) returned by the generation API
Response
Generation status: “STARTING”, “IN_PROGRESS”, “SUCCEEDED”, “FAILED”
Array containing the URLs of generated videos (present only if status=“SUCCEEDED”)
Request Example
Response Example
Possible Generation States
Status | Description |
---|---|
STARTING | Generation is initializing |
IN_PROGRESS | Video is being created |
SUCCEEDED | Generation completed successfully |
FAILED | An error occurred during generation |
Important note: In case of “FAILED” status, your video credits are automatically refunded.