GET
/
api
/
custom_templates
/
{id}
curl --request GET \
  --url https://api.creatify.ai/api/custom_templates/{id}/ \
  --header 'X-API-ID: <api-key>' \
  --header 'X-API-KEY: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "visual_style": "HouseSale",
  "data": "<any>",
  "name": "<string>",
  "media_job": "<string>",
  "video_output": "<string>",
  "preview": "<string>",
  "failed_reason": "<string>",
  "credits_used": 123,
  "status": "pending",
  "progress": 123,
  "webhook_url": "<string>"
}

Authorizations

​
X-API-ID
string
header
required

API ID, from your settings page.

​
X-API-KEY
string
header
required

API Key, from your settings page.

Path Parameters

​
id
string
required

A UUID string identifying this custom template.

Response

200 - application/json
​
id
string
required
​
created_at
string
required
​
updated_at
string
required
​
visual_style
enum<string>
required

Visual style of the video.

  • HouseSale - House Sale Template
Available options:
HouseSale
​
media_job
string | null
required
​
video_output
string | null
required
​
preview
string | null
required
​
failed_reason
string
required

Failed reason

​
credits_used
integer
required

Credits used in this api call

​
status
enum<string>
required
  • pending - Pending
  • in_queue - In Queue
  • running - Running
  • failed - Failed
  • done - Done
  • rejected - Rejected
Available options:
pending,
in_queue,
running,
failed,
done,
rejected
​
progress
number
required
​
data
any

JSON data for the custom template.

​
name
string | null

Name of the video. Default is null.

Maximum length: 255
​
webhook_url
string | null

Webhook URL for status updates. Default is null.

Maximum length: 200