Skip to main content
POST
/
api
/
custom_template_jobs
/
preview_async
cURL
curl --request POST \
  --url https://api.creatify.ai/api/custom_template_jobs/preview_async/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-ID: <api-key>' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "variables": {},
  "name": "<string>",
  "webhook_url": "<string>",
  "is_hidden": false
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "variables": {},
  "media_job": "<string>",
  "video_output": "<string>",
  "preview": "<string>",
  "editor_url": "<string>",
  "failed_reason": "<string>",
  "credits_used": 123,
  "duration": 123,
  "progress": 123,
  "name": "<string>",
  "webhook_url": "<string>",
  "is_hidden": false
}

Documentation Index

Fetch the complete documentation index at: https://docs.creatify.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Difference from Synchronous Preview

The synchronous POST /api/custom_template_jobs/preview/ endpoint blocks until the preview is ready and returns the completed result directly. This async endpoint returns immediately with the job in a pending state. You should poll the job status using GET /api/custom_template_jobs/{id}/ until the status becomes done, then read the preview field from the response.

​
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"
This async endpoint is recommended over the synchronous preview endpoint, especially for templates with complex assets or heavy processing. It avoids HTTP timeout issues that can occur with the synchronous endpoint when the server is under high load.

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

​
template_id
string<uuid>
required
write-only

Template ID associated with the job.

​
variables
object
required

JSON data for the custom template.

​
name
string | null

Name of the video. Default is null.

Maximum string length: 255
​
webhook_url
string<uri> | null

Webhook URL for status updates. Default is null.

Maximum string length: 200
​
model_version
enum<string>

Model version for the avatar, 'standard', 'aurora_v1' or 'aurora_v1_fast'. Default is 'standard'. Standard model costs 5 credits per 30 seconds video, Aurora_v1 model costs 1 credit per second, and Aurora_v1_fast renders faster with lower quality for 0.5 credits per second.

  • standard - Standard
  • aurora_v1 - Aurora v1
  • aurora_v1_fast - Aurora v1 Fast
Available options:
standard,
aurora_v1,
aurora_v1_fast
​
is_hidden
boolean
default:false

Whether the job should be hidden.

Response

200 - application/json
​
id
string<uuid>
required
read-only
​
created_at
string<date-time>
required
read-only
​
updated_at
string<date-time>
required
read-only
​
variables
object
required

JSON data for the custom template.

​
media_job
string | null
required
read-only
​
video_output
string | null
required
read-only

Video output URL

​
preview
string | null
required
read-only

Preview URL

​
editor_url
string | null
required
read-only

Editor URL for the video. Expires in 24 hours. Available only if your API account has API editor access enabled. , expires in 24 hours.

​
failed_reason
string
required
read-only

Failed reason

​
credits_used
number
required
read-only

Credits used in this API call

​
duration
integer
required
read-only

Duration of the video in seconds

​
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<double>
required
read-only

Progress of the job

​
name
string | null

Name of the video. Default is null.

Maximum string length: 255
​
webhook_url
string<uri> | null

Webhook URL for status updates. Default is null.

Maximum string length: 200
​
model_version
enum<string>

Model version for the avatar, 'standard', 'aurora_v1' or 'aurora_v1_fast'. Default is 'standard'. Standard model costs 5 credits per 30 seconds video, Aurora_v1 model costs 1 credit per second, and Aurora_v1_fast renders faster with lower quality for 0.5 credits per second.

  • standard - Standard
  • aurora_v1 - Aurora v1
  • aurora_v1_fast - Aurora v1 Fast
Available options:
standard,
aurora_v1,
aurora_v1_fast
​
is_hidden
boolean
default:false

Whether the job should be hidden.