Render Asset
renderConvert an Edit JSON timeline into a video, image, or audio file by queuing assets for validation, preprocessing, and rendering.
Instructions
Queue and render the contents of an Edit as a video, image or audio file.
Rendering Process:
Validation: The edit JSON is validated
Download: All assets are downloaded and cached
Preprocessing: Video assets are automatically processed to fix compatibility issues
Rendering: The timeline is rendered using the processed assets
Output: The final media file is generated and stored
Video Preprocessing:
Video assets undergo automatic preprocessing to ensure compatibility. You can force
preprocessing by setting "transcode": true on video assets. See VideoAsset
for more details.
Base URL: https://api.shotstack.io/edit/{version} Explicit confirmation is required for this exact action; provider charges, hosting, sharing or deletion may apply. Never automatically resubmit unknown outcomes.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| disk | No | **Notice: This option is now deprecated and will be removed. Disk types are handled automatically. Setting a disk type has no effect.** The disk type to use for storing footage and assets for each render. <ul> <li>`local` - optimized for high speed rendering with up to 512MB storage</li> <li>`mount` - optimized for larger file sizes and longer videos with 5GB for source footage and 512MB for output render</li> </ul> | |
| merge | No | An array of key/value pairs that provides an easy way to create templates with placeholders. The placeholders can be used to find and replace keys with values. For example you can search for the placeholder `{{NAME}}` and replace it with the value `Jane`. | |
| output | No | ||
| account | No | Named private Shotstack account; selects private credentials and stage/v1 environment. | |
| confirm | No | Must be true for this exact requested render, generation, mutation, upload URL or deletion. | |
| payload | No | Complete JSON request body instead of body flags. Preserves current endpoint fields and values. | |
| callback | No | An optional webhook callback URL used to receive status notifications when a render completes or fails. Notifications are also sent when a rendered video is sent to an output [destination](https://shotstack.io/docs/guide/serving-assets/destinations/). See [webhooks](https://shotstack.io/docs/guide/architecting-an-application/webhooks/) for more details. | |
| instance | No | The render instance type to use for processing the edit. <ul> <li>`s1` - standard instance (default)</li> <li>`s2` - standard instance with more resources</li> <li>`a1` - accelerated instance for faster rendering</li> </ul> | s1 |
| timeline | No | ||
| payload_file | No | Regular local JSON body file, at most 5 MB. Cannot be mixed with body flags or payload. |