POST
/
api
/
custom_templates
/
preview
curl --request POST \
  --url https://api.creatify.ai/api/custom_templates/preview/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-ID: <api-key>' \
  --header 'X-API-KEY: <api-key>' \
  --data '{
  "visual_style": "style1",
  "data": {
    "address": "<string>",
    "city": "<string>",
    "state": "<string>",
    "sqft": 123,
    "bedrooms": 123,
    "bathrooms": 123,
    "price": 123,
    "estimated_monthly_payment": 123,
    "openhouseDate_1": {
      "date": "<string>",
      "time": "<string>"
    },
    "listing_images": {
      "image_1": "<string>",
      "image_2": "<string>",
      "image_3": "<string>",
      "image_4": "<string>",
      "image_5": "<string>"
    },
    "location_image": "https://d35ghwdno3nak3.cloudfront.net/media_file/279870/20250212/1f52448d-9516-4d0a-b521-5cfc8be12c5f_screenshot-20250212-162738.png",
    "name": "<string>",
    "email": "jsmith@example.com",
    "phone_number": "<string>",
    "office_name": "<string>",
    "head_shot": "<string>"
  },
  "name": "<string>",
  "webhook_url": "<string>"
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "visual_style": "style1",
  "data": {
    "address": "<string>",
    "city": "<string>",
    "state": "<string>",
    "sqft": 123,
    "bedrooms": 123,
    "bathrooms": 123,
    "price": 123,
    "estimated_monthly_payment": 123,
    "openhouseDate_1": {
      "date": "<string>",
      "time": "<string>"
    },
    "listing_images": {
      "image_1": "<string>",
      "image_2": "<string>",
      "image_3": "<string>",
      "image_4": "<string>",
      "image_5": "<string>"
    },
    "location_image": "https://d35ghwdno3nak3.cloudfront.net/media_file/279870/20250212/1f52448d-9516-4d0a-b521-5cfc8be12c5f_screenshot-20250212-162738.png",
    "name": "<string>",
    "email": "jsmith@example.com",
    "phone_number": "<string>",
    "office_name": "<string>",
    "head_shot": "<string>"
  },
  "name": "<string>",
  "media_job": "<string>",
  "video_output": "<string>",
  "preview": "<string>",
  "failed_reason": "<string>",
  "credits_used": 123,
  "status": "pending",
  "progress": 123,
  "webhook_url": "<string>"
}

​
About preview Field in the Response

The preview field provides a link to preview the video. This link allows you to preview the video before rendering it, you can put it in an iframe to show the video in your application. Example: The preview field in the response will look like this:

"https://app.creatify.ai/preview?layout=videos/20241024/f0c1e1f1-be05-48e0-91d8-3d26ed633d5b.json"

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.

Body

​
data
object
required
​
visual_style
string
default:style1
Maximum length: 256
​
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

Response

200 - application/json
​
id
string
required
​
created_at
string
required
​
updated_at
string
required
​
data
object
required
​
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
​
visual_style
string
default:style1
Maximum length: 256
​
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