Export project
export_projectStart a video export of the project. Returns immediately with an export_id; the export renders in the background (~5 min) and the user gets the result in the editor's Exports tab. Start it, tell the user it has started (with the export_id), and stop: do not call get_export in a loop or hold run_script open waiting for it. Call get_export only when the user asks for the link (it then returns download_url, or embed_url for destination="embed").
destination: • "download" (default) — an mp4 file; once done, get_export returns a time-limited download_url. • "embed" — publish the project as an embeddable video player (the same embed the editor's Share → Embed creates). The embed URL is permanent: re-publishing after edits updates the video behind the SAME URL, so pages and LMS lessons that embed it update in place. Use get_embed(project_id) to read the URL and iframe code of an already-published project without re-rendering.
Defaults: 1080p / 30fps / no captions / English. Pass overrides only when needed.
captions burns subtitles into a download; an embed instead carries captions the
viewer toggles in the player, so captions is ignored for destination="embed".
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| fps | No | Frames per second (default 30) | |
| captions | No | Burn subtitles into the video (default false) | |
| project_id | Yes | The project ID to export | |
| resolution | No | Output resolution (default 1080p) | |
| destination | No | Where the render goes: "download" (mp4 file, default) or "embed" (publish/update the project's embeddable player; its URL never changes). Publishing an embed needs an editor or admin role. |