Skip to content

Custom Templates

Fresh

Purpose

Create branded, reusable video templates that can be populated with different variables for consistent video production using the Creatify Custom Templates API.

Prerequisites

  • Authenticated API access (Authentication SOP)
  • A custom template created in the Creatify dashboard
  • Template variable values
  • Sufficient credits (5/30s create, 1/30s preview, 4/30s render)

Procedure

Step 1: List Available Templates

bash
curl --request GET \
  --url https://api.creatify.ai/api/custom_templates/ \
  --header "X-API-ID: $CREATIFY_API_ID" \
  --header "X-API-KEY: $CREATIFY_API_KEY"

Response (partial):

json
[
  {
    "id": "template-uuid-001",
    "name": "Product Showcase 9:16",
    "description": "Vertical product showcase template with brand overlay",
    "variables": ["product_name", "tagline", "image_url", "cta_text"]
  }
]

Step 2: Get Template Details

bash
curl --request GET \
  --url https://api.creatify.ai/api/custom_templates/template-uuid-001/ \
  --header "X-API-ID: $CREATIFY_API_ID" \
  --header "X-API-KEY: $CREATIFY_API_KEY"

Step 3: Create a Template Job

bash
curl --request POST \
  --url https://api.creatify.ai/api/custom_templates/jobs/ \
  --header "Content-Type: application/json" \
  --header "X-API-ID: $CREATIFY_API_ID" \
  --header "X-API-KEY: $CREATIFY_API_KEY" \
  --data '{
    "template_id": "template-uuid-001",
    "variables": {
      "product_name": "Super Widget Pro",
      "tagline": "The future of productivity",
      "image_url": "https://example.com/product.jpg",
      "cta_text": "Shop Now"
    }
  }'

Response:

json
{
  "id": "template-job-uuid",
  "status": "pending",
  "template_id": "template-uuid-001"
}

Step 4: Poll for Preview

bash
curl --request GET \
  --url https://api.creatify.ai/api/custom_templates/jobs/template-job-uuid/ \
  --header "X-API-ID: $CREATIFY_API_ID" \
  --header "X-API-KEY: $CREATIFY_API_KEY"

Step 5: Render Final Video

bash
curl --request POST \
  --url https://api.creatify.ai/api/custom_templates/jobs/template-job-uuid/render/ \
  --header "X-API-ID: $CREATIFY_API_ID" \
  --header "X-API-KEY: $CREATIFY_API_KEY"

Step 6: Poll Render and Download

Poll the job status until done, then download from the output URL.

Credit Cost

OperationCredits
List templates0
Get template details0
Create preview job1 per 30s
Render final video4 per 30s
Total5 per 30s

TIP

Custom templates are ideal for high-volume production. Create the template once in the dashboard, then generate hundreds of branded variations via API with different variables.

Verification Checklist

  • [ ] Template ID exists and matches intended design
  • [ ] All required variables are provided
  • [ ] Preview shows correct brand elements and variable substitution
  • [ ] Rendered video matches brand guidelines
  • [ ] Output URL returns valid MP4

See Also