Colossyan API Documentation
Creating video
Creating video
Since rendering your video could take several minutes, the video generation is done with a job queue.
Whenever you would like to create a new video, you have to post a new video generation job. This job will be picked up by our workers, executed and then you will be notified about the result.
To see how exactly can you get notified and then retrieve your finished video, check out how to get your video.
Using the API
To post a video generation job, you should send an authenticated POST request to the following endpoint.
https://app.colossyan.com/api/video-generation-jobsThe content of the body should be a video generation job, describing the video you would like to be created.
const token = "2fd3b795-15d4-456f-9a33-33391d1cfcf0";const url = "https://app.colossyan.com/api/video-generation-jobs";const job = { /* ... */};
const result = await fetch(url, { method: "POST", headers: { authorizationtoken: token }, body: JSON.stringify(job),});
console.log(result.data); // { id: "650c585a-c55c-468e-ab71-e73a405af5a7" }You will get back the id of the job you just posted. Make note of this, since you can use it to poll the status of the video generation job.
Video generation job
A video generation job has the following properties:
| Key | Default | Required | Type | Description |
|---|---|---|---|---|
| videoCreative | - | Yes | VideoCreative | Everything describing how the video should look. See: video creative |
| dynamicVariables | - | No | object | A simple object of your choice containing the dynamic variables to replace the tokens in the video creative |
| callback | - | No | string | A url we will ping with a POST request once the video is generated |
| callbackPayload | - | No | object | A simple object of your choice containing things to put into the callback function's body. The url and shareUrl properties are reserved. See: callback |
Video creative
The video creative consists of the followings:
| Key | Default | Required | Type | Description |
|---|---|---|---|---|
| scenes | - | Yes | Scene[] | The scenes the video consists of. See: scenes |
| settings | - | Yes | VideoSettings | The settings of the video itself. See: video settings |