POST
/
api
/
aurora
/
cURL
curl --request POST \
  --url https://api.creatify.ai/api/aurora/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-ID: <api-key>' \
  --header 'X-API-KEY: <api-key>' \
  --data '{
  "name": "<string>",
  "audio": "<string>",
  "image": "<string>",
  "webhook_url": "<string>"
}'
{
  "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>",
  "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.

Body

​
audio
string<uri>
required

Audio file url for the aurora video

​
image
string<uri>
required

Image file url for the aurora video

​
name
string | null

Name of the aurora video

Maximum length: 255
​
webhook_url
string<uri> | null

Webhook URL for status updates. Default is null.

Maximum length: 200

Response

201 - 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

​
image
string<uri>
required

Image file url for the aurora video

​
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
​
webhook_url
string<uri> | null

Webhook URL for status updates. Default is null.

Maximum length: 200