CRcreatify
custom_template_jobs

POST /api/custom_template_jobs/{id}/render/

Changed on

Request

  • The document declares no server URL.
  • Auth
    API key in header X-API-ID and API key in header X-API-KEY

Path parameters

idstring uuid required

A UUID string identifying this Custom Template Job.

Request body

idstring uuid required
created_atstring date-time required
updated_atstring date-time required
namestring nullable

Name of the video. Default is null.

template_idstring uuid required

Template ID associated with the job.

variablesobject required

JSON data for the custom template.

media_jobstring nullable required
video_outputstring nullable required

Video output URL

previewstring nullable required

Preview URL

editor_urlstring nullable 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_reasonstring required

Failed reason

credits_usednumber required

Credits used in this API call

durationinteger required

Duration of the video in seconds

status'pending' | 'in_queue' | 'running' | 'failed' | 'done' | 'rejected' required
  • pending - Pending
  • in_queue - In Queue
  • running - Running
  • failed - Failed
  • done - Done
  • rejected - Rejected
progressnumber double required

Progress of the job

webhook_urlstring uri nullable

Webhook URL for status updates. Default is null.

model_version'standard' | 'aurora_v1' | 'aurora_v1_fast' | 'boreal' | 'aurora_v2'
  • standard - Standard
  • aurora_v1 - Aurora v1
  • aurora_v1_fast - Aurora v1 Fast
  • boreal - Boreal
  • aurora_v2 - Aurora v2
is_hiddenboolean

Whether the job should be hidden.

Response

idstring uuid required
created_atstring date-time required
updated_atstring date-time required
namestring nullable

Name of the video. Default is null.

template_idstring uuid required

Template ID associated with the job.

variablesobject required

JSON data for the custom template.

media_jobstring nullable required
video_outputstring nullable required

Video output URL

previewstring nullable required

Preview URL

editor_urlstring nullable 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_reasonstring required

Failed reason

credits_usednumber required

Credits used in this API call

durationinteger required

Duration of the video in seconds

status'pending' | 'in_queue' | 'running' | 'failed' | 'done' | 'rejected' required
  • pending - Pending
  • in_queue - In Queue
  • running - Running
  • failed - Failed
  • done - Done
  • rejected - Rejected
progressnumber double required

Progress of the job

webhook_urlstring uri nullable

Webhook URL for status updates. Default is null.

model_version'standard' | 'aurora_v1' | 'aurora_v1_fast' | 'boreal' | 'aurora_v2'
  • standard - Standard
  • aurora_v1 - Aurora v1
  • aurora_v1_fast - Aurora v1 Fast
  • boreal - Boreal
  • aurora_v2 - Aurora v2
is_hiddenboolean

Whether the job should be hidden.

Changes

  • 8423ba73b422Revision changes
    • breaking

      added to the request property allOf list (media type: application/json)

    • breaking

      added to the request property allOf list (media type: application/x-www-form-urlencoded)

    • breaking

      added to the request property allOf list (media type: multipart/form-data)

    • warning

      removed from the request property allOf list (media type: application/json)

    • warning

      removed from the request property allOf list (media type: application/x-www-form-urlencoded)

    • warning

      removed from the request property allOf list (media type: multipart/form-data)

    • info

      added to the response property allOf list for the response status

    • info

      removed from the response property allOf list for the response status