Render Custom Template Video

This endpoint renders a video with preview generated. Rendering a video through this endpoint costs 4 credits for every 30 seconds.

POST /api/custom_template_jobs/{id}/render

cURL

cURL

curl --request POST \
  --url https://api.creatify.ai/api/custom_template_jobs/{id}/render/ \
  --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>",
  "model_version": "standard",
  "is_hidden": false
}
'

200

{
  "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,
  "status": "pending",
  "progress": 123,
  "name": "<string>",
  "webhook_url": "<string>",
  "model_version": "standard",
  "is_hidden": false
}

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<uuid> · required

A UUID string identifying this Custom Template Job.

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

template_id · string<uuid> · required

Template ID associated with the job.

variables · object · required

JSON data for the custom template.

Show child attributes

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 20 credits per 15 seconds video, and Aurora_v1_fast renders faster with lower quality for 10 credits per 15 seconds video.

• 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

created_at · string<date-time> · required

updated_at · string<date-time> · required

variables · object · required

JSON data for the custom template.

Show child attributes

media_job · string | null · required

video_output · string | null · required

Video output URL

preview · string | null · required

Preview URL

editor_url · string | null · required

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

Failed reason

credits_used · integer · required

Credits used in this API call

duration · integer · required

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

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 20 credits per 15 seconds video, and Aurora_v1_fast renders faster with lower quality for 10 credits per 15 seconds video.

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