Skip to content

Get Custom Template

FreshGET
GET https://api.creatify.ai/api/custom_templates/{id}/

Retrieve a specific custom template by its ID, including its configurable parameters.

Path Parameters

NameTypeRequiredDescription
idstringYesThe template ID

Headers

HeaderTypeRequiredDescription
X-API-IDstringYesYour Creatify API ID
X-API-KEYstringYesYour Creatify API key

Example Request

bash
curl -X GET 'https://api.creatify.ai/api/custom_templates/template-001/' \
  -H 'X-API-ID: your-api-id' \
  -H 'X-API-KEY: your-api-key'

Response

json
{
  "id": "template-001",
  "name": "Product Launch Template",
  "description": "Professional product launch video template",
  "thumbnail": "https://cdn.creatify.ai/templates/template-001-thumb.jpg",
  "parameters": {
    "headline": {"type": "string", "required": true},
    "product_image": {"type": "string", "required": true},
    "cta_text": {"type": "string", "required": false}
  },
  "created_at": "2024-01-15T10:30:00Z"
}

Response Fields

FieldTypeDescription
idstringUnique template identifier
namestringTemplate name
descriptionstringTemplate description
thumbnailstringPreview thumbnail URL
parametersobjectConfigurable parameters and their types
created_atstringISO 8601 timestamp

Status Codes

CodeDescription
200Success
401Unauthorized -- invalid API credentials
404Template not found
500Internal server error