Skip to main content
POST
cURL

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

image
string<uri>
required

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

webhook_url
string<uri> | null

Webhook URL for status updates. Default is null.

Maximum string length: 200

Response

201 - application/json
id
string<uuid>
required
read-only
created_at
string<date-time>
required
read-only
updated_at
string<date-time>
required
read-only
image
string<uri>
required

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

output
object[]
required
read-only
status
enum<string>
required

Status of the image processing. Default is 'pending'.

  • pending - Pending
  • in_queue - In Queue
  • running - Running
  • failed - Failed
  • done - Done
Available options:
pending,
in_queue,
running,
failed,
done
failed_reason
string | null
required
read-only

Reason for failure. Default is null.

credits_used
number
required
read-only

Credits used in this API call

webhook_url
string<uri> | null

Webhook URL for status updates. Default is null.

Maximum string length: 200