Colossyan API
  • Welcome
  • Getting Started
    • Quickstart
    • Extracting request bodies from the web-editor
  • Basics
    • Authentication
    • Endpoints
    • Video Generation
      • Generating using a template
      • Generating a video manually
      • Receiving a generated video
    • Using template variables
      • Script template variables
      • Text template variables
    • Generated videos
      • Retrieve a video
      • Delete a video
    • Video generation job
      • Retrieve video generation job
      • Delete video generation job
    • Assets
      • Actors
      • Voices
  • Advanced
    • Advanced use-cases
    • Timing
  • Experimental
    • Knowledge to draft
Powered by GitBook
On this page

Was this helpful?

Export as PDF
  1. Basics
  2. Video Generation

Generating using a template

PreviousVideo GenerationNextGenerating a video manually

Last updated 1 month ago

Was this helpful?

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"

  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.

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.

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
200
Job created successfully
application/json
400
Bad Request. Invalid input data.
401
Unauthorized. Authentication required.
500
Internal server error.
post
POST /api/v1/video-generation-jobs/template-jobs HTTP/1.1
Host: app.colossyan.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 88

{
  "templateJobId": "text",
  "dynamicVariables": {},
  "callbackUrl": "text",
  "callbackPayload": {}
}
{
  "id": "text",
  "videoId": "text"
}