Skip to content

Get Custom Template Job

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

Retrieve a specific custom template job by its ID.

Path Parameters

NameTypeRequiredDescription
idstringYesThe template job 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_template_jobs/job-001/' \
  -H 'X-API-ID: your-api-id' \
  -H 'X-API-KEY: your-api-key'

Response

json
{
  "id": "job-001",
  "template_id": "template-001",
  "status": "done",
  "parameters": {
    "headline": "Introducing Our Latest Product",
    "product_image": "https://example.com/product.jpg",
    "cta_text": "Shop Now"
  },
  "output": "https://cdn.creatify.ai/template-jobs/job-001.mp4",
  "preview": "https://cdn.creatify.ai/template-jobs/job-001-preview.mp4",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:40:00Z"
}

Response Fields

FieldTypeDescription
idstringUnique job identifier
template_idstringTemplate used
statusstringJob status: pending, processing, done, failed
parametersobjectParameter values used
outputstringFinal rendered video URL
previewstringPreview video URL
created_atstringISO 8601 timestamp
updated_atstringISO 8601 timestamp

Status Codes

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