created_atstring date-time required
updated_atstring date-time required
audiostring uri required
Audio file url for the aurora video, 5 minutes max, 'mp3' and 'wav' formats only
imagestring uri required
Image file url for the aurora video, 'png', 'jpg', 'jpeg', 'webp' formats only
text_promptstring
Optional text prompt describing the desired visual style, atmosphere, or scene composition for the video. This can include details such as camera angles, lighting, mood, environment, subject expression, pose, motion, and other cinematic or artistic elements to guide video generation.
prompt_guidance_scalenumber double
Prompt guidance scale for image-to-video generation (0.0 to 10.0)
model_version'aurora_v1' | 'aurora_v1_fast' | 'aurora_v2'
- aurora_v1 - Aurora v1
- aurora_v1_fast - Aurora v1 Fast
- aurora_v2 - Aurora v2
ttl_daysinteger nullable
Optional. Days the generated video is retained before automatic deletion (1-7); actual deletion lands within [ttl_days, ttl_days + 2] days of creation. Omit to keep the video with no expiry (zero-data-retention accounts default to 1).
expires_atstring nullable required
ISO-8601 timestamp at which the generated video becomes eligible for deletion, or null when it does not expire. Actual deletion can lag up to 48h after this.
output_upload_urlstring uri
Optional. An https presigned PUT URL you own (for example S3 or GCS). When set, the finished mp4 is uploaded there with Content-Type: video/mp4 and deleted from Creatify's storage, so video_output stays null. If the upload fails, the job fails and is refunded. Never echoed back in responses.
video_outputstring nullable required
credits_usednumber required
Credits used in this API call
durationinteger required
Duration of the video in seconds
progressnumber double required
failed_reasonstring required
media_jobstring uuid nullable required
Media job associated with this Avatar X Flow
status'pending' | 'in_queue' | 'running' | 'failed' | 'done' | 'rejected' required
- pending - Pending
- in_queue - In Queue
- running - Running
- failed - Failed
- done - Done
- rejected - Rejected
is_hiddenboolean required
Is the video hidden in the website projects page
webhook_urlstring uri nullable
Webhook URL for status updates. Default is null.
previewstring nullable required
editor_urlstring nullable required
Editor URL for the video. Expires in 24 hours. Available only if your API account has API editor access enabled. , expires in 24 hours.