Headless mode

Create and edit video designs from code, with or without the editor on screen.

The mounted video Editor API lets your code change a design through the editor’s editing actions. Media utilities read files and create previews without opening an editor.

The standalone Headless Runtime is Coming soon. Its public interface is being simplified before launch; it is separate from the mounted browser API.

Use cases

  • Your own controls. Change the mounted video design from buttons in your page.
  • Your own chat. Send assistant actions to the mounted editor through its API.
  • Upload previews. Read metadata and create a thumbnail before uploading a file.

Capabilities

PartWhat it doesPage
Headless RuntimeComing soon; the standalone interface is being simplified before launch.Headless runtime
EditorVerbApiThe same actions on the design of a mounted editor.Editor API
runChatTurnRuns one request of a conversation with the chat service, on either of the two.Custom chat UI
probeMediaFile, generateThumbnailRead a media file, and make a still picture from it.Media utilities

The mounted video API has 92 actions. Editor actions lists them.

Server-side export

Coming soon

Server-side export will render a design to an MP4 file on your server, with no user and no browser window.

Limitations

  • The Editor API requires a mounted video editor in a browser. It does not render video on your server.
  • The image editor does not expose the video EditorVerbApi. Its headless option is a separate browser export capability.
  • probeMediaFile and generateThumbnail need a browser, or a Worker in a browser.

Additional resources

On this page