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.

post

/video-generation-jobs

Authorizations

Body

videoCreativeobjectrequired

The video creative details.

callbackstring

URL for the callback.

callbackPayloadobject

Payload for the callback.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://app.colossyan.com/api/v1/video-generation-jobs' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"videoCreative":{"settings":{"name":"text","videoSize":{"width":1,"height":1}},"scenes":[{"transition":{"duration":1,"type":"fade"},"tracks":[{"variant":"full_body","view":"front","position":{},"size":{},"type":"ACTOR"}]}]},"callbackPayload":{}}'

200

400

401

500

200

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

Job created successfully

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.