Skip to main content
Shotstack logo
  • Category: video & audio
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 24
  • Triggers: 0
  • Slug: SHOTSTACK
  • Version: 20261101_00

Tools

Slug: SHOTSTACK_CREATE_TEMPLATECreate 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

string
required
A name for the template (required by the API).
object
required
Output settings for video generation. Mismatched format, aspectRatio, or resolution relative to source media dimensions can cause letterboxing or playback issues.
boolean
Flag to save as template. Defaults to true.
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.
string
A short description of the template.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOTSTACK_CREATE_TEMPLATE2Tool 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

string
required
The template name
string ("stage" | "v1")
API environment version: ‘stage’ for sandbox testing or ‘v1’ for production
object
required
Template definition containing timeline and output configuration

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOTSTACK_DELETE_INGESTED_MEDIADelete an ingested source file from the production Ingest API by its ingest ID.

Input Parameters

string
required
Unique identifier of the ingested media asset to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOTSTACK_DELETE_TEMPLATE2Delete a Shotstack template by ID in the stage environment.

Input Parameters

string
required
The unique identifier of the template to delete in UUID format

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOTSTACK_DELETE_WORKFLOWTool to delete a specific Shotstack workflow. Use when you need to permanently remove a workflow after confirming its ID.

Input Parameters

string
required
Unique identifier of the workflow to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOTSTACK_FETCH_SOURCEQueue 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

string
required
Publicly accessible URL of the media file to fetch

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOTSTACK_GET_ASSETSRetrieve details of a hosted asset by asset ID in the Shotstack staging environment, including videos, images, audio files, thumbnails, and poster images.

Input Parameters

string
required
The unique identifier (UUID) of the asset to retrieve. Can be the asset ID, render ID, source ID, or rendition ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOTSTACK_GET_ASSETS_RENDERRetrieve hosted assets by render ID in the Shotstack staging environment, including files such as video, thumbnail, and poster images.

Input Parameters

string
required
The unique identifier (UUID) of the render job to retrieve associated assets for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOTSTACK_GET_INGEST_STATUSRetrieve the status and details of an ingested source by ID from the production Ingest API. This tool is deprecated.

Input Parameters

string
required
The unique identifier of the ingest asset to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOTSTACK_GET_RENDER_CALLBACKRequest callback details for a specific render job, including the callback URL and delivery status, attempts, response and last-attempt time.

Input Parameters

string
required
The unique identifier of the render process.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOTSTACK_GET_RENDER_STATUSRetrieve 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

string
required
The unique identifier (UUID) of the render job to retrieve status for.
boolean
Include the original timeline and output settings in the response. Default is false (will be deprecated to false soon).
boolean
When used with data=true, shows merge fields merged into the data response.
string
API version to use. Use ‘stage’ for sandbox/testing or ‘v1’ for production.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOTSTACK_GET_SOURCERetrieve 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

string
required
Unique identifier of the source asset to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOTSTACK_GET_TEMPLATERetrieve a template’s details and metadata by ID from the Shotstack staging environment.

Input Parameters

string
required
The unique identifier of the template to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOTSTACK_GET_TEMPLATE_BY_VERSIONTool 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

string
required
The id of the template in UUID format
string
The version of the Edit API to use. Common values: ‘v1’, ‘stage’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOTSTACK_GET_UPLOAD_URLTool 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

string
API version - use ‘stage’ for sandbox or ‘v1’ for production

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOTSTACK_INSPECT_MEDIATool 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

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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOTSTACK_LIST_SOURCESRequest 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

string
Filter sources by a specific index name
integer
Maximum number of results to return per page (default: 20)
integer
Number of results to skip for pagination (default: 0)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOTSTACK_LIST_SOURCES2Tool 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

string ("stage" | "v1")
required
Environment: ‘stage’ for sandbox testing or ‘v1’ for production
string
Filter sources by a specific index name
integer
Maximum number of results to return per page (default: 20)
integer
Number of results to skip for pagination (default: 0)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOTSTACK_LIST_TEMPLATESList Shotstack templates for the account in the stage environment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOTSTACK_LIST_TEMPLATES2Tool 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

string ("stage" | "v1")
Environment to use: ‘stage’ for sandbox testing or ‘v1’ for production. Defaults to stage.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOTSTACK_POST_UPLOADRequest 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOTSTACK_RENDER_VIDEOTool to initiate a new video render job. Use when you have defined a timeline and output settings and want to start rendering.

Input Parameters

object
required
Output settings for rendering including format, resolution, frame rate, and aspect ratio
string
Optional webhook URL to receive notifications when render status changes
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOTSTACK_TRANSFER_ASSETTransfer a file from a publicly available URL to one or more production Serve API destinations, including Shotstack hosting or other configured destinations.

Input Parameters

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.
string
required
The publicly accessible URL of the file to transfer. Must be a valid HTTP/HTTPS URL.
array
required
Array of destination objects specifying where to transfer the asset. At least one destination is required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOTSTACK_UPDATE_TEMPLATEUpdate a stage-environment template by ID, providing both its name and complete edit configuration.

Input Parameters

string
required
The unique identifier of the template to update in UUID format.
string
required
Display name for the 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not