Create Inspiration Job

FreshPOST

POST https://api.creatify.ai/api/inspiration_jobs/

Create a video based on an inspiration template. Provide the inspiration ID and parameter values to generate a customized version.

Request Body

Name	Type	Required	Description
inspiration_id	string	Yes	The inspiration template ID
parameters	object	Yes	Key-value pairs matching the inspiration's parameter schema

Headers

Header	Type	Required	Description
X-API-ID	string	Yes	Your Creatify API ID
X-API-KEY	string	Yes	Your Creatify API key
Content-Type	string	Yes	application/json

Example Request

curl -X POST 'https://api.creatify.ai/api/inspiration_jobs/' \
  -H 'X-API-ID: your-api-id' \
  -H 'X-API-KEY: your-api-key' \
  -H 'Content-Type: application/json' \
  -d '{
    "inspiration_id": "insp-001",
    "parameters": {
      "product_url": "https://example.com/product",
      "headline": "Discover Our Best Seller"
    }
  }'

Response

{
  "id": "insp-job-001",
  "inspiration_id": "insp-001",
  "status": "pending",
  "created_at": "2024-01-15T10:30:00Z"
}

Status Codes

Code	Description
201	Job created successfully
400	Bad request -- missing required parameters
401	Unauthorized -- invalid API credentials
402	Insufficient credits
404	Inspiration not found
429	Rate limit exceeded
500	Internal server error

TIP

Browse available inspirations with GET /api/inspirations/ to find creative concepts that match your use case. Check each inspiration's parameters with the get endpoint before creating a job.