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. Getting Started

Extracting request bodies from the web-editor

PreviousQuickstartNextAuthentication

Last updated 1 month ago

Was this helpful?

Constructing request bodies for complex video generation jobs can become very complicated very quickly. To get ahead of this we provide a way to use our web-based video-generation tool (Colossyan Studio) to export the payload for the video you see.

  1. To do this, open any draft you'd like to generate via the API.

  2. Click on the "Generate" button on the top right corner of your editor, than in the dialog appeared you should see a button called "Export to API", click that button.

    1. Note that you can only see this button if you have API access.

  3. In the appearing modal, you should see the request body that you can send to generate the exact video that you can see in the editor.

  4. Feel free to customise this payload.