Skip to main content
Glama
thenavidm
by thenavidm

Render Asset

render
Destructive

Convert 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:

  1. Validation: The edit JSON is validated

  2. Download: All assets are downloaded and cached

  3. Preprocessing: Video assets are automatically processed to fix compatibility issues

  4. Rendering: The timeline is rendered using the processed assets

  5. 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

TableJSON Schema
NameRequiredDescriptionDefault
diskNo**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>
mergeNoAn 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`.
outputNo
accountNoNamed private Shotstack account; selects private credentials and stage/v1 environment.
confirmNoMust be true for this exact requested render, generation, mutation, upload URL or deletion.
payloadNoComplete JSON request body instead of body flags. Preserves current endpoint fields and values.
callbackNoAn 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.
instanceNoThe 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
timelineNo
payload_fileNoRegular local JSON body file, at most 5 MB. Cannot be mixed with body flags or payload.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.0.0

TDQS

A3.7/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Beyond the annotations (destructive, non-idempotent, open-world), the description adds real value: it discloses the asynchronous 'queue' semantics, the multi-stage pipeline, required explicit confirmation, and that provider charges, hosting, sharing or deletion may apply, plus a caution never to auto-resubmit unknown outcomes. These are meaningful behavioral traits not captured by annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The purpose leads, followed by a well-structured numbered pipeline and a focused video-preprocessing aside. The Base URL line with an empty href is noise, but overall the content is front-loaded and each section roughly earns its place.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With no output schema, the description could do more to explain the async return (render ID / polling with get_render), but for a complex nested tool it adequately covers the pipeline, confirmation requirement and side effects. Given 80% schema coverage and rich nested docs, it is largely complete.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 80%, so the schema already documents most parameters and the baseline is 3. The description only adds meaning for one parameter, the `transcode: true` forcing of video preprocessing, which is a marginal but genuine addition over the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description gives a specific verb+resource: 'Queue and render the contents of an [Edit] as a video, image or audio file.' This clearly states the input (an Edit) and the output artifact type. It does not explicitly distinguish itself from the sibling render_template, but an agent can infer the difference from the 'Edit' vs 'template' wording.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies usage through the numbered rendering-process pipeline (validation, download, preprocessing, rendering, output) and the confirmation note, but it never says when to use this versus render_template or generate_asset, nor any prerequisite conditions. Usage is implied rather than stated.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.