Skip to main content
POST
/
api
/
iab_images
cURL
curl --request POST \
  --url https://api.creatify.ai/api/iab_images/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-ID: <api-key>' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "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",
  "image": "<string>",
  "output": [
    {
      "name": "<string>",
      "size": "<string>",
      "url": "<string>",
      "type": "<string>"
    }
  ],
  "status": "pending",
  "failed_reason": "<string>",
  "webhook_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

​
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
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
image
string<uri>
required

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

​
output
object[]
required
​
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

Reason for failure. Default is null.

​
webhook_url
string<uri> | null

Webhook URL for status updates. Default is null.

Maximum string length: 200