Sign in

v2

latestOpenAPI 3.0.22026-07-3121671.8 KB

Create a new movie

Submit a new movie rendering job.

post/movies

Request body

idstring

Movie ID string. It must be unique per project

commentstring

Used for adding your comments

drafttrue | false

Deprecated. This property is ignored and has no effect. Watermarking is now controlled automatically based on the account plan.

variablesobject

Variables of the template. Variable names can only contain letters, numbers and underscores

resolution'sd' | 'hd' | 'full-hd' | 'squared' | 'instagram-story' | 'instagram-feed' | 'twitter-landscape' | 'twitter-portrait' | 'custom'

Set the movie size based on common use cases. Use <code>custom</code> to set a custom size with the <code>width</code> and <code>height</code> properties

widthinteger

Width of the movie. Only applicable if resolution is set to <code>custom</code>

heightinteger

Height of the movie. Only applicable if resolution is set to <code>custom</code>

quality'low' | 'medium' | 'high'

Quality of the final rendered movie. Use it for speeding up the rendering process. <code>low</code> is the lowest quality, <code>high</code> is the highest quality

fpsinteger

Frames per second

client-dataobject

Key-value pairs that will be included in the response of the GET requests and in the webhook payloads. Client data is intended to pass on information to the following steps of the workflow.

settingsobject

Deprecated

cacheboolean

Use the cached version of the movie if its available

Example request

{
  "comment": "MyProject",
  "resolution": "full-hd",
  "scenes": [
    {
      "elements": [
        {
          "type": "video",
          "src": "https://example.com/path/to/my/video.mp4"
        }
      ]
    }
  ]
}

Response

Added