Generating using a template

To generate a video based on a template:

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

   1. You can create dynamic variables in the script on any scene, by simply typing a key between curly braces at any point of the script. For example in the following script... Dear {name}, I have seen that you haven't logged into your account for the past two months. Should we catch up quickly? Since then we released several cool stuff, such as {cool_stuff_1} and {cool_stuff_2}. Let me know if you have a free slot on your calendar next week!

   2. ...you have created three dynamic variables:

      1. name

      2. cool_stuff_1

      3. cool_stuff_2

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

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 popup click "Save job as a template" and make note of the appearing ID. This is the ID of your template job.

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-job using the API endpoint below.

Create a video generation job from a template

Submits a new video generation job using a template

POSThttps://app.colossyan.com/api/v1/video-generation-jobs/template-jobs

Authorization

bearerAuth

Body

application/json

templateJobId*string

The ID of the template job.

dynamicVariables*object

Dynamic variables to be loaded into the template.

callbackUrlnullable string

URL for the callback after job completion.

callbackPayloadnullable object

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

Response

200400401500

Job created successfully

Body

application/json

idstring

The ID of the created video-generation-job.

videoIdstring

The provisioned ID of the generated video.

Request

JavaScriptCurlPython

const response = await fetch('https://app.colossyan.com/api/v1/video-generation-jobs/template-jobs', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "templateJobId": "text"
    }),
});
const data = await response.json();

Response

200

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