Skip to main content
GET
/
api
/
aurora
/
cURL
curl --request GET \
  --url https://api.creatify.ai/api/aurora/ \
  --header 'X-API-ID: <api-key>' \
  --header 'X-API-KEY: <api-key>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "audio": "<string>",
    "image": "<string>",
    "text_prompt": "<string>",
    "prompt_guidance_scale": 1,
    "model_version": "aurora_v1",
    "video_output": "<string>",
    "credits_used": 123,
    "duration": 123,
    "progress": 123,
    "failed_reason": "<string>",
    "media_job": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "pending",
    "is_hidden": true,
    "webhook_url": "<string>",
    "preview": "<string>",
    "editor_url": "<string>"
  }
]

Authorizations

​
X-API-ID
string
header
required

API ID, from your settings page.

​
X-API-KEY
string
header
required

API Key, from your settings page.

Query Parameters

​
ids
string

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

Minimum length: 1
​
ordering
string

Which field to use when ordering the results.

Response

200 - application/json
​
id
string<uuid>
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
audio
string<uri>
required

Audio file url for the aurora video, 60 seconds max, 'mp3' and 'wav' formats only

​
image
string<uri>
required

Image file url for the aurora video, 'png', 'jpg', 'jpeg', 'webp' formats only

​
video_output
string | null
required

Video output URL

​
credits_used
integer
required

Credits used in this API call

​
duration
integer
required

Duration of the video in seconds

​
progress
number
required

Progress of the job

​
failed_reason
string
required

Failed reason

​
media_job
string<uuid> | null
required

Media job associated with this Avatar X Flow

​
status
enum<string>
required
  • pending - Pending
  • in_queue - In Queue
  • running - Running
  • failed - Failed
  • done - Done
  • rejected - Rejected
Available options:
pending,
in_queue,
running,
failed,
done,
rejected
​
is_hidden
boolean
required

Is the video hidden in the website projects page

​
preview
string | null
required

Preview URL

​
editor_url
string | null
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.

​
name
string | null

Name of the aurora video

Maximum length: 255
​
text_prompt
string

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_scale
number
default:1

Prompt guidance scale for image-to-video generation (0.0 to 10.0)

​
model_version
enum<string>
default:aurora_v1

Aurora model version to use for video generation. Default is 'aurora_v1'. 'aurora_v1' produces higher-quality videos (20 credits per 15s), while 'aurora_v1_fast' renders faster with lower quality (10 credits per 15s).

  • aurora_v1 - Aurora v1
  • aurora_v1_fast - Aurora v1 Fast
Available options:
aurora_v1,
aurora_v1_fast
​
webhook_url
string<uri> | null

Webhook URL for status updates. Default is null.

Maximum length: 200