Generating a video manually

You can generate a video by sending us a video-generation-job. This is essentially a recipe for a video. Constructing such a recipe manually for complex videos can become tedious very quickly. Due to this we strongly recommend to either:

• Extract the video-generation-job payload from our web-based UI editor. More details here: Extracting request bodies from the web-editor.

• Or to generate based on a template. More details here: Generating using a template

---

Important concepts

To better understand the API, it's recommended to get an understanding of the following building blocks first:

• Scenes

  • A scene is a logical consolidation of related content.

  • A video can consist of multiple scenes. These scenes are concatenated together. Think of them as slides on a presentation. Each scene is meant to aggregate and encapsulate related content.

  • Scenes offer a lot of convenience in timing their content, however it is completely up to the individual to decide how to divide the content into scenes.

• Tracks

  • Tracks are the building blocks of scenes. You define the content of the video in tracks.

  • There are different types of tracks, for different purposes. To differentiate between them we use the type property.

Create a video generation job

Submits a new video generation job for processing.

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

Authorization

bearerAuth

Body

application/json

videoCreative*VideoCreative (object)

callbackstring

URL for the callback.

callbackPayloadobject

Payload for the callback.

Response

200400401500

Job created successfully

Body

application/json

idstring

The ID of the created job.

videoIdstring

The provisioned ID of the generated video.

Request

JavaScriptCurlPython

const response = await fetch('https://app.colossyan.com/api/v1/video-generation-jobs', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "videoCreative": {
        "settings": {
          "videoSize": {
            "width": 0,
            "height": 0
          },
          "name": "text"
        },
        "scenes": [
          {
            "tracks": [
              {}
            ]
          }
        ]
      }
    }),
});
const data = await response.json();

Response

200

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

For advanced use-cases and customisations (such as advanced timings or animations), please reach out to us, so we can help out with a solution engineer to make sure you achieve what you are after. Read more here: Advanced use-cases.