Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.iacrea.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Video Creation API

The video creation service allows you to transform your static images into dynamic animations using artificial intelligence.

​
Generate a video

​
POST /api/animation/v2/generate

​
Request Parameters

​
user_id
string
required
The unique user identifier (UUID) that you can retrieve from your Developer Space
​
image_urls
array
required
Array of URLs of images to animate. Currently, the first image in the array is used for video creation.
​
option
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”
​
prompt
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.
​
format
string
Video orientation format. Possible values: “portrait” (768x1280 format) or any other value for landscape format (1280x768). By default, landscape format is used.
​
webhook
string
Webhook URL to receive a notification when the generation is complete

​
Response

​
generation_id
string
The unique generation identifier (UUID) to use with the retrieval API
​
remaining_videos
number
The number of video credits remaining for the user
​
project_id
string
The unique project identifier (UUID)

​
Request Example

curl --request POST \
--url 'https://iacrea.com/api/animation/v2/generate' \
--header 'x-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
  "user_id": "uuid",
  "image_urls": ["https://example.com/image.jpg"],
  "option": "ZOOM_OUT",
  "prompt": "Elegant modern living room",
  "format": "portrait"
}'

​
Response Example

{
  "generation_id": "uuid",
  "remaining_videos": 10,
  "project_id": "uuid"
}

​
Available Animation Types

OptionDescription
ZOOM_INZoom-in effect towards the inside of the image
ZOOM_OUTZoom-out effect moving away from the image
PAN_RIGHTCamera movement to the right
PAN_LEFTCamera movement to the left
PAN_UPCamera movement upward
PAN_DOWNCamera movement downward
CAMERA_PUSH_OUTFluid movement combining zoom and displacement
AUTO_EFFECTSAutomatic prompt generation by AI to create optimal animation
AUTO_REVERSEAutomatic prompt generation by AI to create reverse animation

​
Retrieve a video

​
POST /api/animation/v2/get

​
Request Parameters

​
user_id
string
required
The unique user identifier (UUID) that you can retrieve from your Developer Space
​
generation_id
string
required
The unique generation identifier (UUID) returned by the generation API

​
Response

​
status
string
Generation status: “STARTING”, “IN_PROGRESS”, “SUCCEEDED”, “FAILED”
​
urls
array
Array containing the URLs of generated videos (present only if status=“SUCCEEDED”)

​
Request Example

curl --request POST \
--url 'https://iacrea.com/api/animation/v2/get' \
--header 'x-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
  "user_id": "uuid",
  "generation_id": "uuid"
}'

​
Response Example

{
  "status": "SUCCEEDED",
  "urls": ["https://generated-video-url.mp4"]
}

​
Possible Generation States

StatusDescription
STARTINGGeneration is initializing
IN_PROGRESSVideo is being created
SUCCEEDEDGeneration completed successfully
FAILEDAn error occurred during generation
Important note: In case of “FAILED” status, your video credits are automatically refunded.