Create Custom Template Job

FreshPOST

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

Create a video using a custom template. Provide the template ID and the parameter values to populate the template.

Credit Cost

5 credits per 30 seconds of video

Request Body

Name	Type	Required	Description
template_id	string	Yes	The custom template ID to use
parameters	object	Yes	Key-value pairs matching the template's parameter schema
aspect_ratio	string	No	Output aspect ratio

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/custom_template_jobs/' \
  -H 'X-API-ID: your-api-id' \
  -H 'X-API-KEY: your-api-key' \
  -H 'Content-Type: application/json' \
  -d '{
    "template_id": "template-001",
    "parameters": {
      "headline": "Introducing Our Latest Product",
      "product_image": "https://example.com/product.jpg",
      "cta_text": "Shop Now"
    },
    "aspect_ratio": "16:9"
  }'

Response

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

Status Codes

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

TIP

Check the template's parameters with GET /api/custom_templates/{id}/ before creating a job to ensure you provide all required values.