Generating using a template

To generate a video based on a template:

1. Head over to Colossyan and create your desired video draft using our web-based studio

2. Once you are done, click on the "Generate" button on the top right corner of your editor, than in the dialog appeared click "Export to API"

Note that this button is only visible if you have a plan which has access to the API. For more information, head over to our pricing page.

1. On the top right corner of the appearing dialog click "Save job as a template" and make note of the appearing ID. This is the ID of your template job, you can send this id with your request to start generate the video.

Keep in mind: the template job ID refers to the state of the draft when you saved it. If later you edit this draft, you'll need to create another template id to represent the changes.

1. Now you have everything to send us a video generation request using the API endpoint below.

Create a video generation job from a template

post

Submits a new video generation job using a template

Authorizations

Body

templateJobIdstringrequired

The ID of the template job.

dynamicVariablesobjectrequired

Dynamic variables to be loaded into the template.

callbackUrlstring | nullableoptional

URL for the callback after job completion.

callbackPayloadobject | nullableoptional

Callback payload to return with the generated video once it's ready.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://app.colossyan.com/api/v1/video-generation-jobs/template-jobs' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "templateJobId": "text",
    "dynamicVariables": {},
    "callbackUrl": "text",
    "callbackPayload": {}
  }'

200

400

401

500

200

{
  "id": "text",
  "videoId": "text"
}

Job created successfully