Skip to main content

🚀 Introduction

The AI Ad Template API provides a simple interface to explore available inspirations, inspect their input parameter schemas, and create inspiration jobs that generate assets using those inspirations.
  1. First, list available inspirations and their JSON schemas.
  2. Then create an inspiration job and poll or use a webhook to retrieve the result.

✅ Prerequisites

  • A Creatify account with API access
  • Your API credentials (see Authentication)

1) Discover Inspirations & Input Schemas

Use this endpoint to list all available inspirations and view the JSON schema for their input_params. Endpoint: GET /api/inspirations/
curl --request GET \
  --url "https://api.creatify.ai/api/inspirations/" \
  --header 'X-API-ID: your-api-id' \
  --header 'X-API-KEY: your-api-key'
Notes
  • input_params_schema is the schema of the input_params for each inspiration.

2) Create an Inspiration Job

Submit the inspiration_id (inspiration ID) and input_params to start a new job.
Optional: add a webhook_url to receive automatic notifications.
Endpoint: POST /api/inspiration_jobs/ Body:
  • inspiration_id (string, required)
  • input_params (json, required — must match the input_params_schema)
  • webhook_url (string URL, optional)
curl --request POST \
  --url https://api.creatify.ai/api/inspiration_jobs/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-ID: your-api-id' \
  --header 'X-API-KEY: your-api-key' \
  --data '{
    "inspiration_id": "d749750d-4102-400d-949d-8e701bd0a800",
    "input_params": {
        "Product Image": "https://d35ghwdno3nak3.cloudfront.net/images/d6ba29c096ae40a9ca7a78ff135b5efd56d990278ae58a6f825caa3942c3c12a.jpg"
    },
    "webhook_url": "https://webhook.site/c424cab8-8ed2-46d6-9b04-d1290ca04276"
  }'

3) Check Job Status (Poll) or Receive Webhook

Poll the job by its ID until status becomes done, or use the webhook to receive the final result automatically. Endpoint: GET /api/inspiration_jobs/{id}/

Polling Example

curl --request GET \
  --url https://api.creatify.ai/api/inspiration_jobs/7c79daa6-db68-4d81-9ad7-2a88f866d6f6/ \
  --header 'X-API-ID: your-api-id' \
  --header 'X-API-KEY: your-api-key'

Webhook Example

If you provided webhook_url, Creatify sends:
{
  "id": "7c79daa6-db68-4d81-9ad7-2a88f866d6f6",
  "status": "done",
  "failed_reason": "",
  "output": "https://v3b.fal.media/files/b/zebra/5wm4Y12i3eOf1zobSnbGd.jpg"
}
You can verify the job anytime via a GET request to /api/inspiration_jobs/{id}/.

📚 Endpoint Reference

ActionEndpoint
List inspirations & schemasGET /api/inspirations/
Create an inspiration jobPOST /api/inspiration_jobs/
Check job status / get resultGET /api/inspiration_jobs/{id}/

🎯 Summary

StepWhat you do
1List inspirations and view their input schema
2Create an inspiration job with inspiration_id + input_params
3Poll /api/inspiration_jobs/{id}/ or receive a webhook with the final result