Sign in

v1

latestOpenAPI 3.0.32026-07-2691139249.7 KB
aurora

Retrieve a list of videos, with an optional ids param to filter vdieo by their UUIDs.

get/api/aurora/

Query parameters

idsstring

Comma-separated list of UUIDs to filter. Maximum 100 entries allowed.

orderingstring

Which field to use when ordering the results.

Response

idstring uuid required
created_atstring date-time required
updated_atstring date-time required
namestring nullable

Name of the aurora video

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_v1 - Aurora v1
  • aurora_v1_fast - Aurora v1 Fast
video_outputstring nullable required

Video output URL

credits_usednumber required

Credits used in this API call

durationinteger required

Duration of the video in seconds

progressnumber double required

Progress of the job

failed_reasonstring required

Failed reason

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

Preview URL

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.