🚀 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.- First, list available inspirations and their JSON schemas.
- 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 theirinput_params.
Endpoint: GET /api/inspirations/
Notes
input_params_schemais the schema of the input_params for each inspiration.
2) Create an Inspiration Job
Submit theinspiration_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)
3) Check Job Status (Poll) or Receive Webhook
Poll the job by its ID until status becomesdone, or use the webhook to receive the final result automatically.
Endpoint: GET /api/inspiration_jobs/{id}/
Polling Example
Webhook Example
If you providedwebhook_url, Creatify sends:
You can verify the job anytime via a GET request to /api/inspiration_jobs/{id}/.
📚 Endpoint Reference
| Action | Endpoint |
|---|---|
| List inspirations & schemas | GET /api/inspirations/ |
| Create an inspiration job | POST /api/inspiration_jobs/ |
| Check job status / get result | GET /api/inspiration_jobs/{id}/ |
🎯 Summary
| Step | What you do |
|---|---|
| 1 | List inspirations and view their input schema |
| 2 | Create an inspiration job with inspiration_id + input_params |
| 3 | Poll /api/inspiration_jobs/{id}/ or receive a webhook with the final result |

