> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Shotstack

> Shotstack is a cloud-based platform that enables developers, marketers, and designers to automate the generation of videos, images, and audio at scale using a RESTful API.

![Shotstack logo](https://mintcdn.com/composio-preview/B09iGux45A5cYDuO/images/toolkits/shotstack.svg?fit=max\&auto=format\&n=B09iGux45A5cYDuO\&q=85\&s=2913b4f1cc301b5dc186c07d8091b339)

* **Category:** video & audio
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 24
* **Triggers:** 0
* **Slug:** `SHOTSTACK`
* **Version:** 20261101\_00

## Tools

> [accordion] Create Template
>
> **Slug:** `SHOTSTACK_CREATE_TEMPLATE`
>
> Create a named Shotstack template from timeline and output settings for reuse in media editing and rendering. With standard Shotstack connections, the request targets the staging environment.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> A name for the template (required by the API).
>
> **output** `object` *required*
>
> Output settings for video generation. Mismatched `format`, `aspectRatio`, or `resolution` relative to source media dimensions can cause letterboxing or playback issues.
>
> **template** `boolean`
>
> Flag to save as template. Defaults to true.
>
> **timeline** `object` *required*
>
> Timeline definition describing the video sequence and all assets. Must conform to Shotstack's JSON schema (valid tracks, clips, asset types); malformed structures cause rejection. All asset source URLs must be publicly reachable and non-expiring.
>
> **description** `string`
>
> A short description of the template.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Template (v2)
>
> **Slug:** `SHOTSTACK_CREATE_TEMPLATE2`
>
> Tool to save an Edit as a re-usable template. Templates can be retrieved and modified before rendering. Use when you want to create a template with merge fields for dynamic content.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> The template name
>
> **version** `string ("stage" | "v1")`
>
> API environment version: 'stage' for sandbox testing or 'v1' for production
>
> **template** `object` *required*
>
> Template definition containing timeline and output configuration
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Ingested Media
>
> **Slug:** `SHOTSTACK_DELETE_INGESTED_MEDIA`
>
> Delete an ingested source file from the production Ingest API by its ingest ID.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Unique identifier of the ingested media asset to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Template
>
> **Slug:** `SHOTSTACK_DELETE_TEMPLATE2`
>
> Delete a Shotstack template by ID in the stage environment.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The unique identifier of the template to delete in UUID format
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Shotstack Workflow
>
> **Slug:** `SHOTSTACK_DELETE_WORKFLOW`
>
> Tool to delete a specific Shotstack workflow. Use when you need to permanently remove a workflow after confirming its ID.
>
> #### Input Parameters
>
> **workflowId** `string` *required*
>
> Unique identifier of the workflow to delete
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Fetch Source
>
> **Slug:** `SHOTSTACK_FETCH_SOURCE`
>
> Queue a remote media file for ingestion as a source asset in the production Ingest API. The operation is asynchronous and returns a source ID for checking ingestion status.
>
> #### Input Parameters
>
> **url** `string` *required*
>
> Publicly accessible URL of the media file to fetch
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Asset
>
> **Slug:** `SHOTSTACK_GET_ASSETS`
>
> Retrieve details of a hosted asset by asset ID in the Shotstack staging environment, including videos, images, audio files, thumbnails, and poster images.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The unique identifier (UUID) of the asset to retrieve. Can be the asset ID, render ID, source ID, or rendition ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Assets by Render ID
>
> **Slug:** `SHOTSTACK_GET_ASSETS_RENDER`
>
> Retrieve hosted assets by render ID in the Shotstack staging environment, including files such as video, thumbnail, and poster images.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The unique identifier (UUID) of the render job to retrieve associated assets for.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Ingest Status (Deprecated)
>
> **Slug:** `SHOTSTACK_GET_INGEST_STATUS`
>
> Retrieve the status and details of an ingested source by ID from the production Ingest API. This tool is deprecated.
>
> #### Input Parameters
>
> **ingestId** `string` *required*
>
> The unique identifier of the ingest asset to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Render Callback
>
> **Slug:** `SHOTSTACK_GET_RENDER_CALLBACK`
>
> Request callback details for a specific render job, including the callback URL and delivery status, attempts, response and last-attempt time.
>
> #### Input Parameters
>
> **renderId** `string` *required*
>
> The unique identifier of the render process.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Render Status
>
> **Slug:** `SHOTSTACK_GET_RENDER_STATUS`
>
> Retrieve the status and details of a Shotstack render job by render ID in the selected environment. Use it to poll until the render completes or fails; completed renders can include a temporary asset URL. You can also request the original edit data and, when included, its merged fields.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The unique identifier (UUID) of the render job to retrieve status for.
>
> **data** `boolean`
>
> Include the original timeline and output settings in the response. Default is false (will be deprecated to false soon).
>
> **merged** `boolean`
>
> When used with data=true, shows merge fields merged into the data response.
>
> **version** `string`
>
> API version to use. Use 'stage' for sandbox/testing or 'v1' for production.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Source Details
>
> **Slug:** `SHOTSTACK_GET_SOURCE`
>
> Retrieve details and status of a source asset by ID from the production Ingest API. Responses without an original input URL fail validation, including direct uploads.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Unique identifier of the source asset to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Template
>
> **Slug:** `SHOTSTACK_GET_TEMPLATE`
>
> Retrieve a template's details and metadata by ID from the Shotstack staging environment.
>
> #### Input Parameters
>
> **templateId** `string` *required*
>
> The unique identifier of the template to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Template By Version
>
> **Slug:** `SHOTSTACK_GET_TEMPLATE_BY_VERSION`
>
> Tool to retrieve a template by template id and API version. Use when you need to fetch template details from a specific Edit API version.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The id of the template in UUID format
>
> **version** `string`
>
> The version of the Edit API to use. Common values: 'v1', 'stage'.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Upload URL
>
> **Slug:** `SHOTSTACK_GET_UPLOAD_URL`
>
> Tool to request a signed URL for direct file upload to Shotstack. Use when you need to upload a file to Shotstack storage. The response returns a signed URL that you use to upload the file using a PUT request with the binary file.
>
> #### Input Parameters
>
> **version** `string`
>
> API version - use 'stage' for sandbox or 'v1' for production
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Inspect Media
>
> **Slug:** `SHOTSTACK_INSPECT_MEDIA`
>
> Tool to inspect media metadata. Use before rendering to retrieve duration, resolution, frame rate, and format of an online media file — clip timecodes, trim points, and audio sync calculations depend on these values. Mixing assets without prior inspection can cause letterboxing, jitter, or audio sync issues in the final output.
>
> #### Input Parameters
>
> **url** `string` *required*
>
> The URL of the media file to inspect. Will be URL-encoded automatically. Must be publicly accessible and stable — private, geo-blocked, or expiring URLs will cause inspection to fail.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Sources
>
> **Slug:** `SHOTSTACK_LIST_SOURCES`
>
> Request a list of ingested source assets from the production Ingest API, with optional pagination parameters. Responses lacking pagination metadata or an original input URL for any listed source fail validation.
>
> #### Input Parameters
>
> **index** `string`
>
> Filter sources by a specific index name
>
> **limit** `integer`
>
> Maximum number of results to return per page (default: 20)
>
> **offset** `integer`
>
> Number of results to skip for pagination (default: 0)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Sources (with Environment)
>
> **Slug:** `SHOTSTACK_LIST_SOURCES2`
>
> Tool to list all ingested source files with environment selection. Use when you need to retrieve sources from stage (sandbox) or v1 (production) environment with optional pagination.
>
> #### Input Parameters
>
> **env** `string ("stage" | "v1")` *required*
>
> Environment: 'stage' for sandbox testing or 'v1' for production
>
> **index** `string`
>
> Filter sources by a specific index name
>
> **limit** `integer`
>
> Maximum number of results to return per page (default: 20)
>
> **offset** `integer`
>
> Number of results to skip for pagination (default: 0)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Templates
>
> **Slug:** `SHOTSTACK_LIST_TEMPLATES`
>
> List Shotstack templates for the account in the stage environment.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Templates with Environment
>
> **Slug:** `SHOTSTACK_LIST_TEMPLATES2`
>
> Tool to list all Shotstack templates for the specified environment. Use when you need to retrieve templates from a specific environment (stage or production).
>
> #### Input Parameters
>
> **env** `string ("stage" | "v1")`
>
> Environment to use: 'stage' for sandbox testing or 'v1' for production. Defaults to stage.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Request Upload URL
>
> **Slug:** `SHOTSTACK_POST_UPLOAD`
>
> Request a signed URL for direct file upload to the Shotstack staging environment. The signed URL expires in one hour; uploading the file requires a separate PUT request.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Render Video
>
> **Slug:** `SHOTSTACK_RENDER_VIDEO`
>
> Tool to initiate a new video render job. Use when you have defined a timeline and output settings and want to start rendering.
>
> #### Input Parameters
>
> **output** `object` *required*
>
> Output settings for rendering including format, resolution, frame rate, and aspect ratio
>
> **callback** `string`
>
> Optional webhook URL to receive notifications when render status changes
>
> **timeline** `object` *required*
>
> Timeline definition describing the sequence of tracks, clips, and transitions. Each track contains clips with an 'asset' (required), 'start' and 'length' (seconds), optional 'effect' (e.g. zoomIn, slideLeft, zoomOut), 'transform' (rotate/skew/flip -- NOTE: use 'transform' NOT 'transformations'), 'filter', 'opacity' (0-1), and 'transition'. Asset types: video, image, audio (require 'src'); title (requires 'text'); html; luma.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Transfer Asset
>
> **Slug:** `SHOTSTACK_TRANSFER_ASSET`
>
> Transfer a file from a publicly available URL to one or more production Serve API destinations, including Shotstack hosting or other configured destinations.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Unique identifier (UUID format recommended) for the asset. This identifier does not need to be globally unique but should be provided by the client.
>
> **url** `string` *required*
>
> The publicly accessible URL of the file to transfer. Must be a valid HTTP/HTTPS URL.
>
> **destinations** `array` *required*
>
> Array of destination objects specifying where to transfer the asset. At least one destination is required.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Template
>
> **Slug:** `SHOTSTACK_UPDATE_TEMPLATE`
>
> Update a stage-environment template by ID, providing both its name and complete edit configuration.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The unique identifier of the template to update in UUID format.
>
> **name** `string` *required*
>
> Display name for the template.
>
> **template** `object` *required*
>
> Complete edit configuration containing timeline and output settings. Must include both timeline (with tracks containing clips) and output (with format and resolution) properties.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
