Shotstack

Learn how to use Shotstack with Composio

Overview

SLUG: SHOTSTACK

Description

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.

Authentication Details

version
stringRequired
generic_api_key
stringRequired

Connecting to Shotstack

Create an auth config

Use the dashboard to create an auth config for the Shotstack toolkit. This allows you to connect multiple Shotstack accounts to Composio for agents to use.

1

Select App

Navigate to Shotstack.

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Shotstack Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using API Key

1from composio import Composio
2
3# Replace these with your actual values
4shotstack_auth_config_id = "ac_YOUR_SHOTSTACK_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000" # UUID from database/app
6
7composio = Composio()
8
9def authenticate_toolkit(user_id: str, auth_config_id: str):
10 # Replace this with a method to retrieve an API key from the user.
11 # Or supply your own.
12 user_api_key = input("[!] Enter API key")
13
14 connection_request = composio.connected_accounts.initiate(
15 user_id=user_id,
16 auth_config_id=auth_config_id,
17 config={"auth_scheme": "API_KEY", "val": {"generic_api_key": user_api_key}}
18 )
19
20 # API Key authentication is immediate - no redirect needed
21 print(f"Successfully connected Shotstack for user {user_id}")
22 print(f"Connection status: {connection_request.status}")
23
24 return connection_request.id
25
26
27connection_id = authenticate_toolkit(user_id, shotstack_auth_config_id)
28
29# You can verify the connection using:
30connected_account = composio.connected_accounts.get(connection_id)
31print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Shotstack toolkit’s playground

Python
1from composio import Composio
2from openai import OpenAI
3import json
4
5openai = OpenAI()
6composio = Composio()
7
8# User ID must be a valid UUID format
9user_id = "0000-0000-0000" # Replace with actual user UUID from your database
10
11tools = composio.tools.get(user_id=user_id, toolkits=["SHOTSTACK"])
12
13print("[!] Tools:")
14print(json.dumps(tools))
15
16def invoke_llm(task = "What can you do?"):
17 completion = openai.chat.completions.create(
18 model="gpt-4o",
19 messages=[
20 {
21 "role": "user",
22 "content": task, # Your task here!
23 },
24 ],
25 tools=tools,
26 )
27
28 # Handle Result from tool call
29 result = composio.provider.handle_tool_calls(user_id=user_id, response=completion)
30 print(f"[!] Completion: {completion}")
31 print(f"[!] Tool call result: {result}")
32
33invoke_llm()

Tool List

Tool Name: Create Template

Description

Tool to create a new template for video editing. use when you want to save a reusable timeline configuration as a template.

Action Parameters

description
string
id
string
name
string
output
objectRequired
template
booleanDefaults to True
timeline
objectRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Ingested Media

Description

Tool to delete an ingested media asset. use when you've confirmed the ingest id and need to remove the file from shotstack storage.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Source

Description

Tool to delete a specific shotstack ingest source. use when you need to remove a source after confirming its id exists.

Action Parameters

sourceId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Shotstack Template

Description

Tool to delete a specific shotstack template. use when you need to remove a template after confirming its id exists.

Action Parameters

templateId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Shotstack Workflow

Description

Tool to delete a specific shotstack workflow. use when you need to permanently remove a workflow after confirming its id.

Action Parameters

workflowId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Fetch Source

Description

Tool to fetch a remote media file and store it as a source asset. use when you need to ingest a file before rendering.

Action Parameters

metadata
object
storage
string
type
string
url
Required

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Ingest Status

Description

Tool to retrieve the status and details of an ingested media asset. use when checking the processing status of an uploaded ingest.

Action Parameters

ingestId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Render Callback

Description

Tool to retrieve the callback url and status for a specific render job. use after creating or querying a render to confirm its callback settings.

Action Parameters

renderId
stringRequired

Action Response

data
objectRequired
error
string
message
stringRequired
success
booleanRequired
successful
booleanRequired

Tool Name: Get Source Details

Description

Tool to fetch the details of a specific source asset. use when you need to inspect a source after uploading or to check its status.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
meta
objectRequired
successful
booleanRequired

Tool Name: Get Template

Description

Tool to retrieve details of a specific template. use when you have the id of an existing template and need its metadata.

Action Parameters

templateId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Inspect Media

Description

Tool to inspect media metadata. use when you need to retrieve metadata like duration, resolution, and format of an online media file before processing.

Action Parameters

url
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Sources

Description

Tool to list all source assets. use when you need to retrieve source entries with optional pagination.

Action Parameters

index
string
limit
integer
offset
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Templates

Description

Tool to list shotstack templates in a paginated fashion. use after creating or updating templates to view your available templates.

Action Parameters

limit
integer
page
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Render Video

Description

Tool to initiate a new video render job. use when you have defined a timeline and output settings and want to start rendering.

Action Parameters

callback
output
objectRequired
timeline
objectRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired