POST
/
api
/
custom_templates
/
{id}
/
render
curl --request POST \
  --url https://api.creatify.ai/api/custom_templates/{id}/render/ \
  --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": "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 Request Data Structure of Webhook

When the ‘Create Video of Custom Template’ interface is requested, if the ‘webhook_url’ is passed in the parameters, the program will initiate a POST request to this network address when the task succeeds or fails, with the following content:

{
    'id': 'string',
    'status': 'string',
    'failed_reason': 'string',
    'output': 'string',
}

Arguments:

  • id (string): The unique identifier of the job
  • status (string): The status of the job. Possible values are pending, in_queue, running, failed, done
  • failed_reason (string): The reason of the failure if the job failed
  • output (string): The URL of the video if the job is done

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
​
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