Skip to main content
POST
/
api
/
custom_template_jobs
cURL
curl --request POST \
  --url https://api.creatify.ai/api/custom_template_jobs/ \
  --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.

​
About Request Data Structure of Webhook

When using ‘custom_templates’ API, if the ‘webhook_url’ is passed in the parameters, we will initiate a POST request to the webhook_url when the task succeeds or fails, with the following content: 
{
    'id': 'string',
    'status': 'string',
    'failed_reason': 'string',
    'video_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
  • video_output (string): The URL of the video if the job is done
Note: We might send multiple requests for status changes.

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

201 - 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.