video.export_create
Start rendering a studio project to a file: a video, a GIF, the sound mix alone or one poster still (format). Returns job_id immediately; call video.export with job_id to follow progress and receive a download link valid for 24 hours. Refuses, naming the fix, when the project is not exportable, the preset's aspect differs from the project, or the tenant's active-job or daily limit is reached. format picks the file (mp4_h264_aac, webm_vp9_opus, gif, m4a_aac, wav_pcm, poster_jpg; default mp4_h264_aac). Format refusals: a preset other than original with any format but mp4_h264_aac (SIMPLER_STUDIO_EXPORT_FORMAT_PRESET: send preset original); gif longer than 30 s (SIMPLER_STUDIO_EXPORT_GIF_TOO_LONG: trim, or pick a video format); m4a_aac or wav_pcm with nothing audible (SIMPLER_STUDIO_EXPORT_FORMAT_NO_AUDIO: add or unmute sound); poster_jpg without poster_time_ms inside the timeline, or poster_time_ms with another format (SIMPLER_STUDIO_EXPORT_POSTER_TIME). Repeating the same request within 24 hours returns the same job, except a job still waiting for a free renderer: the repeat replaces it with a fresh attempt (the old job then reads SIMPLER_STUDIO_EXPORT_SUPERSEDED). Pricing: free (rendering runs on platform compute, no provider cost). Limits per workspace: 2 renders at a time (SIMPLER_STUDIO_EXPORT_ACTIVE_CAP) and 60 output minutes per rolling 24 hours (SIMPLER_STUDIO_EXPORT_DAILY_QUOTA); wait, or export a shorter cut. A composition_version older than the saved one is refused (SIMPLER_STUDIO_EXPORT_VERSION_STALE): re-read with studio.get_composition. One export may run 15 min at 1080p and 5 min at 4K, and a sound-only export 15 min at any resolution (SIMPLER_STUDIO_EXPORT_OUTPUT_CAP): trim the timeline or pick a smaller preset. A poster renders the timeline up to its frame, so the cap counts up to its poster_time_ms: pick an earlier one. When every renderer is busy the job waits in a queue (queue_position) and starts on its own; video.export_cancel {job_id} withdraws it. The files are kept 30 days after the export finishes. Nothing is posted, emailed or uploaded anywhere; the result is a file you download.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| format | No | The output file; default mp4_h264_aac. mp4_h264_aac: H.264 video with AAC sound; plays everywhere and takes the platform presets. webm_vp9_opus: VP9 video with Opus sound; smaller files for the web, but encoding takes about three times as long. gif: Silent looping animation, up to 30 s, at most 480 px on the long side and 15 fps. Captions can burn in; no SRT file. m4a_aac: The sound mix only, as AAC 192 kbps; video is never decoded. Captions come only as an SRT file. wav_pcm: The sound mix only, uncompressed 16-bit 48 kHz; video is never decoded. Captions come only as an SRT file. poster_jpg: One JPEG still of the finished frame at the chosen time, with text and burned captions; no SRT file. | |
| preset | No | Encoder profile; default original (the project's own size and aspect). A preset whose aspect differs from the project is refused. | |
| project_id | Yes | The studio project (vp_...) to render. | |
| caption_mode | No | none (default), burned_in (drawn into the video), srt (a separate captions file), or both. | |
| poster_time_ms | No | Required with format "poster_jpg", refused with any other: the timeline millisecond to capture, from 0 to the timeline length minus 1. | |
| composition_version | No | Optional: the composition_version you reviewed (studio.get_composition). If a newer version is saved, the export is refused instead of rendering something you have not seen. |