Readme
Python SDK for the Shotstack Python video editor and cloud video editing API.
Shotstack is a cloud based video editing platform that enables the editing of videos using code.
The platform uses an API and a JSON format for specifying how videos should be edited and what assets and titles should be used.
A server based render farm takes care of rendering the videos allowing multiple videos to be created simultaneously.
For examples of how to use the SDK to create videos using code checkout the Python demo repo: https://github.com/shotstack/python-demos
pip install shotstack-sdk
The Shotstack SDK enables programmatic video editing via the Edit API render endpoint. Prepare JSON edits using the
provided schema classes and POST to the API for rendering.
The example below trims the start of a video clip and plays it for 8 seconds. The edit is prepared using the SDK models and then sent to the API for rendering.
import shotstack_sdk as shotstack
from shotstack_sdk.api import edit_api
from shotstack_sdk.model.video_asset import VideoAsset
from shotstack_sdk.model.clip import Clip
from shotstack_sdk.model.track import Track
from shotstack_sdk.model.timeline import Timeline
from shotstack_sdk.model.output import Output
from shotstack_sdk.model.edit import Edit
host = 'https://api.shotstack.io/stage'
configuration = shotstack.Configuration(host = host)
configuration.api_key['DeveloperKey'] = 'H7jKyj90kd09lbLOF7J900jNbSWS67X87xs9j0cD'
with shotstack.ApiClient(configuration) as api_client:
api_instance = edit_api.EditApi(api_client)
video_asset = VideoAsset(
src = 'https://s3-ap-southeast-2.amazonaws.com/shotstack-assets/footage/skater.hd.mp4',
trim = 3.0
)
video_clip = Clip(
asset = video_asset,
start = 0.0,
length = 8.0
)
track = Track(clips=[video_clip])
timeline = Timeline(tracks=[track])
timeline['tracks'] = [another_track]
output = Output(
format = 'mp4',
resolution = 'sd'
)
edit = Edit(
timeline = timeline,
output = output
)
try:
api_response = api_instance.post_render(edit)
print(f"{api_response['response']['id']}")
except Exception as e:
print(f"Unable to resolve API call: {e}")
The example request below can be called a few seconds after the render above is posted. It will return the status of the render, which can take several seconds to process.
import shotstack_sdk as shotstack
from shotstack_sdk.api import edit_api
host = 'https://api.shotstack.io/stage'
configuration = shotstack.Configuration(host = host)
configuration.api_key['DeveloperKey'] = 'H7jKyj90kd09lbLOF7J900jNbSWS67X87xs9j0cD'
with shotstack.ApiClient(configuration) as api_client:
api_instance = edit_api.EditApi(api_client)
id = '75143ec6-4b72-46f8-a67a-fd7284546935'
try:
api_response = api_instance.get_render(id, data=False, merged=True)
status = api_response['response']['status']
if status == 'done':
print(f"{api_response['response']['url']}")
except Exception as e:
print(f"Unable to resolve API call: {e}")
The example below uses the Edit we create in the Video Editing Example and saves it as a template. The template can be rendered at a later date and can include placeholders. Placeholders can be replaced when rendered using merge fields.
This example uses a placeholder for the video src (URL), trim (TRIM), and length (LENGTH) to allow you to trim any video using a template.
import shotstack_sdk as shotstack
import os
from shotstack_sdk.api import edit_api
from shotstack_sdk.model.video_asset import VideoAsset
from shotstack_sdk.model.clip import Clip
from shotstack_sdk.model.track import Track
from shotstack_sdk.model.timeline import Timeline
from shotstack_sdk.model.output import Output
from shotstack_sdk.model.edit import Edit
from shotstack_sdk.model.template import Template
host = "https://api.shotstack.io/stage"
configuration = shotstack.Configuration(host = host)
configuration.api_key['DeveloperKey'] = os.getenv("SHOTSTACK_KEY")
with shotstack.ApiClient(configuration) as api_client:
api_instance = edit_api.EditApi(api_client)
video_asset = VideoAsset(
src = '{{ URL }}',
trim = '{{ TRIM }}'
)
video_clip = Clip(
asset = video_asset,
start = 0.0,
length = '{{ LENGTH }}'
)
track = Track(clips=[video_clip])
timeline = Timeline(
background = '#000000',
tracks = [track]
)
output = Output(
format = 'mp4',
resolution = 'sd'
)
edit = Edit(
timeline = timeline,
output = output
)
template = Template(
name = 'Trim Template',
template = edit
)
try:
api_response = api_instance.post_template(template)
print(f"{api_response['response']['id']}")
except Exception as e:
print(f"Unable to resolve API call: {e}")
The example below renders the template we created in the previous example and includes merge fields that will replace the placeholders. Once submitted use the returned render ID and call the Status Check Example to get the render progress.
import shotstack_sdk as shotstack
import os
from shotstack_sdk.api import edit_api
from shotstack_sdk.model.template_render import TemplateRender
from shotstack_sdk.model.merge_field import MergeField
host = "https://api.shotstack.io/stage"
configuration = shotstack.Configuration(host = host)
configuration.api_key['DeveloperKey'] = os.getenv("SHOTSTACK_KEY")
with shotstack.ApiClient(configuration) as api_client:
api_instance = edit_api.EditApi(api_client)
merge_field_url = MergeField(
find = 'URL',
replace = 'https://s3-ap-southeast-2.amazonaws.com/shotstack-assets/footage/skater.hd.mp4'
)
merge_field_trim = MergeField(
find = 'TRIM',
replace = 3
)
merge_field_length = MergeField(
find = 'LENGTH',
replace = 6
)
template = TemplateRender(
id = id,
merge = [
merge_field_url,
merge_field_trim,
merge_field_length
]
)
try:
api_response = api_instance.post_template_render(template)
print(f"{api_response['response']['id']}")
except Exception as e:
print(f"Unable to resolve API call: {e}")
The following schemas are used to prepare a video edit.
An Edit defines the arrangement of a video on a timeline, an audio edit or an image design and the output format.
from shotstack_sdk.model.edit import Edit
edit = Edit(
timeline = timeline,
output = output,
merge = merge,
callback = "https://my-server.com/callback.php",
disk = "local"
)
| Argument | Type | Description | Required |
|---|---|---|---|
| timeline | Timeline | A timeline represents the contents of a video edit over time, an audio edit over time, in seconds, or an image layout. A timeline consists of layers called tracks. Tracks are composed of titles, images, audio, html or video segments referred to as clips which are placed along the track at specific starting point and lasting for a specific amount of time. | - |
| output | Output | The output format, render range and type of media to generate. | Y |
| merge | MergeField[] | 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. | - |
| callback | string | An optional webhook callback URL used to receive status notifications when a render completes or fails. See webhooks for more details. | - |
| disk | string | (Deprecated) The disk type to use for storing footage and asset for each render. See disk types for more details. [default to local]
| - |
A Timeline represents the contents of a video edit over time, an audio edit over time, in seconds, or an image layout. A timeline consists of layers called tracks. Tracks are composed of titles, images, audio, html or video segments referred to as clips which are placed along the track at specific starting point and lasting for a specific amount of time.
from shotstack_sdk.model.timeline import Timeline
timeline = Timeline(
soundtrack = soundtrack,
background = '#000000',
fonts = fonts,
tracks = tracks,
cache = True,
)
| Argument | Type | Description | Required |
|---|---|---|---|
| soundtrack | Soundtrack | A music or audio soundtrack file in mp3 format. | - |
| background | string | A hexadecimal value for the timeline background colour. Defaults to #000000 (black). | - |
| fonts | Font[] | An array of custom fonts to be downloaded for use by the HTML assets. | - |
| tracks | [Track | A timeline consists of an array of tracks, each track containing clips. Tracks are layered on top of each other in the same order they are added to the array with the top most track layered over the top of those below it. Ensure that a track containing titles is the top most track so that it is displayed above videos and images. | Y |
| cache | bool | Disable the caching of ingested source footage and assets. See caching for more details. [default to True] | - |
A music or audio file in mp3 format that plays for the duration of the rendered video or the length of the audio file, which ever is shortest.
from shotstack_sdk.model.soundtrack import Soundtrack
soundtrack = Soundtrack(
src = 'https://s3-ap-southeast-2.amazonaws.com/shotstack-assets/music/disco.mp3',
effect = 'fadeIn',
volume = 1.0
)
| Argument | Type | Description | Required |
|---|---|---|---|
| src | string | The URL of the mp3 audio file. The URL must be publicly accessible or include credentials. | Y |
| effect | string | The effect to apply to the audio file
| - |
| volume | float | Set the volume for the soundtrack between 0 and 1 where 0 is muted and 1 is full volume (defaults to 1). | - |
Download a custom font to use with the HTML asset type, using the font name in the CSS or font tag. See our custom fonts getting started guide for more details.
from shotstack_sdk.model.font import Font
font = Font(src='https://shotstack-assets.s3-ap-southeast-2.amazonaws.com/fonts/OpenSans-Regular.ttf')
| Argument | Type | Description | Required |
|---|---|---|---|
| src | string | The URL of the font file. The URL must be publicly accessible or include credentials. | Y |
A track contains an array of clips. Tracks are layered on top of each other in the order in the array. The top most track will render on top of those below it.
from shotstack_sdk.model.track import Track
track = Track(clips=clips)
| Argument | Type | Description | Required |
|---|---|---|---|
| clips | Clip[] | An array of Clips comprising of TitleClip, ImageClip or VideoClip. | Y |
A Clip is a container for a specific type of asset, i.e. a title, image, video, audio or html. You use a Clip to define when an asset will display on the timeline, how long it will play for and transitions, filters and effects to apply to it.
from shotstack_sdk.model.clip import Clip
clip = Clip(
asset = asset,
start = 2.0,
length = 5.0,
fit = 'crop',
scale = 0.0,
position = 'center',
offset = offset,
transition = transition,
effect = 'zoomIn',
filter = 'greyscale',
opacity = 1.0,
transform = transform,
)
| Argument | Type | Description | Required |
|---|---|---|---|
| asset | asset | The type of asset to display for the duration of this Clip. Value must be one of: | Y |
| start | float | The start position of the Clip on the timeline, in seconds. | Y |
| length | float | The length, in seconds, the Clip should play for. | Y |
| fit | string fit | Set how the asset should be scaled to fit the viewport using one of the following options [default to crop]:
| - |
| scale | float | Scale the asset to a fraction of the viewport size - i.e. ting the scale to 0.5 will scale asset to half the size of the viewport. This is useful for picture-in-picture video and scaling images such as logos and watermarks. | - |
| position | string | Place the asset in one of nine predefined positions of the viewport. This is most effective for when the asset is scaled and you want to position the element to a specific position [default to center].
| - |
| offset | Offset | Offset the location of the asset relative to its position on the viewport. The offset distance is relative to the width of the viewport - for example an x offset of 0.5 will move the asset half the viewport width to the right. | - |
| transition | Transition | In and out transitions for a clip - i.e. fade in and fade out | - |
| effect | string | A motion effect to apply to the Clip.
Fast or Slow to the effect, e.g. zoomInFast or slideRightSlow. | - |
| filter | string | A filter effect to apply to the Clip.
| - |
| opacity | float | s the opacity of the Clip where 1 is opaque and 0 is transparent. [default to 1] | - |
| transform | Transformation | A transformation lets you modify the visual properties of a clip. Available transformations are RotateTransformation, SkewTransformation and FlipTransformation. Transformations can be combined to create interesting new shapes and effects. | - |
The VideoAsset is used to create video sequences from video files. The src must be a publicly accessible URL to a video resource such as an mp4 file.
from shotstack_sdk.model.video_asset import VideoAsset
video_asset = VideoAsset(
src = 'https://shotstack-assets.s3.aws.com/mountain.mp4',
trim = 5.0,
volume = 0.5,
volumeEffect = 'fadeIn'
crop = crop
)
| Argument | Type | Description | Required |
|---|---|---|---|
| src | string | The video source URL. The URL must be publicly accessible or include credentials. | Y |
| trim | float | The start trim point of the video clip, in seconds (defaults to 0). Videos will start from the in trim point. The video will play until the file ends or the Clip length is reached. | - |
| volume | float | Set the volume for the video clip between 0 and 1 where 0 is muted and 1 is full volume (defaults to 0). | - |
| volumeEffect | effect | The volume effect to apply to the video asset.
| - |
| crop | Crop | Crop the sides of an asset by a relative amount. The size of the crop is specified using a scale between 0 and 1, relative to the screen width - i.e. a left crop of 0.5 will crop half of the asset from the left, a top crop of 0.25 will crop the top by quarter of the asset. | - |
The ImageAsset is used to create video from images to compose an image. The src must be a publicly accessible URL to an image resource such as a jpg or png file.
from shotstack_sdk.model.image_asset import ImageAsset
image_asset = ImageAsset(
src = 'https://shotstack-assets.s3-ap-southeast-2.amazonaws.com/images/earth.jpg',
crop = crop
)
| Argument | Type | Description | Required |
|---|---|---|---|
| src | string | The image source URL. The URL must be publicly accessible or include credentials. | Y |
| crop | Crop | Crop the sides of an asset by a relative amount. The size of the crop is specified using a scale between 0 and 1, relative to the screen width - i.e. a left crop of 0.5 will crop half of the asset from the left, a top crop of 0.25 will crop the top by quarter of the asset. | - |
The TitleAsset clip type lets you create video titles from a text string and apply styling and positioning.
from shotstack_sdk.model.title_asset import TitleAsset
title_asset = TitleAsset(
text = 'My Title',
style = 'minimal',
color = '#ffffff',
size = 'medium',
background = '#000000',
position = 'center',
offset = offset
)
| Argument | Type | Description | Required |
|---|---|---|---|
| text | string | The title text string. | Y |
| style | string | Uses a preset to apply font properties and styling to the title.
| - |
| color | string | Set the text color using hexadecimal color notation. Transparency is supported by ting the first two characters of the hex string (opposite to HTML), i.e. #80ffffff will be white with 50% transparency [default to #ffffff]. | - |
| size | string | Set the relative size of the text using predefined sizes from xx-small to xx-large [default to 'medium'].
| - |
| background | string | Apply a background color behind the text. Set the text color using hexadecimal color notation. Transparency is supported by ting the first two characters of the hex string (opposite to HTML), i.e. #80ffffff will be white with 50% transparency. Omit to use transparent background. | - |
| position | string | Place the title in one of nine predefined positions of the viewport [default to center.
| - |
| offset | Offset | Offset the location of the title relative to its position on the screen. | - |
The HtmlAsset clip type lets you create text based layout and formatting using HTML and CSS. You can also set the height and width of a bounding box for the HTML content to sit within. Text and elements will wrap within the bounding box.
from shotstack_sdk.model.html_asset import HtmlAsset
html_asset = HtmlAsset(
html = '<p>Hello <b>World</b></p>',
css = 'p { color: #ffffff; } b { color: #ffff00; }',
width = 400,
height = 200,
background = 'transparent',
position = 'center'
)
| Argument | Type | Description | Required |
|---|---|---|---|
| html | string | The HTML text string. See list of supported HTML tags. | Y |
| css | string | The CSS text string to apply styling to the HTML. See list of support CSS properties. | - |
| width | int | Set the width of the HTML asset bounding box in pixels. Text will wrap to fill the bounding box. | - |
| height | int | Set the height of the HTML asset bounding box in pixels. Text and elements will be masked if they exceed the height of the bounding box. | - |
| background | string | Apply a background color behind the HTML bounding box using. Set the text color using hexadecimal color notation. Transparency is supported by ting the first two characters of the hex string (opposite to HTML), i.e. #80ffffff will be white with 80% transparency [default to transparent]. | - |
| position | string | Place the HTML in one of nine predefined positions within the HTML area [default to center].
| - |
The AudioAsset is used to add sound effects and audio at specific intervals on the timeline. The src must be a publicly accessible URL to an audio resource such as an mp3 file.
from shotstack_sdk.model.audio_asset import AudioAsset
audio_asset = AudioAsset(
src = 'https://shotstack-assets.s3-ap-southeast-2.amazonaws.com/music/unminus/lit.mp3',
trim = 2.0,
volume = 0.5,
effect = 'fadeInFadeOut'
)
| Argument | Type | Description | Required |
|---|---|---|---|
| src | string | The audio source URL. The URL must be publicly accessible or include credentials. | Y |
| trim | float | The start trim point of the audio clip, in seconds (defaults to 0). Audio will start from the trim point. The audio will play until the file ends or the Clip length is reached. | - |
| volume | float | Set the volume for the audio clip between 0 and 1 where 0 is muted and 1 is full volume (defaults to 1). | - |
| effect | string | The effect to apply to the audio asset:
| - |
The LumaAsset is used to create luma matte masks, transitions and effects between other assets. A luma matte is a grey scale image or animated video where the black areas are transparent and the white areas solid. The luma matte animation should be provided as an mp4 video file. The src must be a publicly accessible URL to the file.
from shotstack_sdk.model.luma_asset import LumaAsset
luma_asset = LumaAsset(
src = 'https://shotstack-assets.s3-ap-southeast-2.amazonaws.com/examples/luma-mattes/paint-left.mp4',
trim = 5.0
)
| Argument | Type | Description | Required |
|---|---|---|---|
| src | string | The luma matte source URL. The URL must be publicly accessible or include credentials. | Y |
| trim | float | The start trim point of the luma matte clip, in seconds (defaults to 0). Videos will start from the in trim point. A luma matte video will play until the file ends or the Clip length is reached. | - |
The Transition clip type lets you define in and out transitions for a clip - i.e. fade in and fade out
from shotstack_sdk.model.transition import Transition
transition = Transition(
_in = 'fade',
out = 'fade'
)
| Argument | Type | Description | Required |
|---|---|---|---|
| in | string | The transition in. Available transitions are:
Fast or Slow to the transition, e.g. fadeFast or CarouselLeftSlow. | - |
| out | string | The transition out. Available transitions are:
Fast or Slow to the transition, e.g. fadeFast or CarouselLeftSlow. | - |
Offsets the position of an asset horizontally or vertically by a relative distance.
from shotstack_sdk.model.offset import Offset
offset = Offset(
x = 0.1,
y = -0.2
)
| Argument | Type | Description | Required |
|---|---|---|---|
| x | float | Offset an asset on the horizontal axis (left or right), range varies from -10 to 10. Positive numbers move the asset right, negative left. For all asset except titles the distance moved is relative to the width of the viewport - i.e. an X offset of 0.5 will move the asset half the screen width to the right. [default to 0] | - |
| y | float | Offset an asset on the vertical axis (up or down), range varies from -10 to 10. Positive numbers move the asset up, negative down. For all asset except titles the distance moved is relative to the height of the viewport - i.e. an Y offset of 0.5 will move the asset up half the screen height. [default to 0] | - |
Crop the sides of an asset by a relative amount. The size of the crop is specified using a scale between 0 and 1, relative to the screen width - i.e a left crop of 0.5 will crop half of the asset from the left, a top crop of 0.25 will crop the top by quarter of the asset.
from shotstack_sdk.model.crop import Crop
crop = Crop(
top = 0.15,
bottom= 0.15,
left = 0.0,
right = 0.0
)
| Argument | Type | Description | Required |
|---|---|---|---|
| top | float | Crop from the top of the asset | - |
| bottom | float | Crop from the bottom of the asset | - |
| left | float | Crop from the left of the asset | - |
| right | float | Crop from the right of the asset | - |
Apply one or more transformations to a clip. Transformations alter the visual properties of a clip and can be combined to create new shapes and effects.
from shotstack_sdk.model.transformation import Transformation
transformation = Transformation(
rotate = rotate,
skew = skew,
flip = flip
)
| Argument | Type | Description | Required |
|---|---|---|---|
| rotate | RotateTransformation | Rotate a clip by the specified angle in degrees. Rotation origin is set based on the clips position. | - |
| skew | SkewTransformation | Skew a clip so its edges are sheared at an angle. Use values between 0 and 3. Over 3 the clip will be skewed almost flat. | - |
| flip | FlipTransformation | Flip a clip vertically or horizontally. Acts as a mirror effect of the clip along the selected plane. | - |
Rotate a clip by the specified angle in degrees. Rotation origin is set based on the clips position.
from shotstack_sdk.model.rotate_transformation import RotateTransformation
rotate_transformation = RotateTransformation(
angle = 45.0
)
| Argument | Type | Description | Required |
|---|---|---|---|
| angle | int | The angle to rotate the clip. Can be 0 to 360, or 0 to -360. Using a positive number rotates the clip clockwise, negative numbers counter-clockwise. | - |
Skew a clip so its edges are sheared at an angle. Use values between 0 and 3. Over 3 the clip will be skewed almost flat.
from shotstack_sdk.model.skew_transformation import SkewTransformation
skew_transformation = SkewTransformation(
x = 0.5,
y = 0.5
)
| Argument | Type | Description | Required |
|---|---|---|---|
| x | float | Skew the clip along it's x axis. [default to 0] | - |
| y | float | Skew the clip along it's y axis. [default to 0] | - |
Flip a clip vertically or horizontally. Acts as a mirror effect of the clip along the selected plane.
from shotstack_sdk.model.flip_transformation import FlipTransformation
flip_transformation = FlipTransformation(
horizontal = True,
vertical = True
)
| Argument | Type | Description | Required |
|---|---|---|---|
| horizontal | bool | Flip a clip horizontally. [default to False] | - |
| vertical | bool | Flip a clip vertically. [default to False] | - |
A merge field consists of a key; find, and a value; replace. Merge fields can be used to replace placeholders within the JSON edit to create re-usable templates. Placeholders should be a string with double brace delimiters, i.e. "{{NAME}}". A
placeholder can be used for any value within the JSON edit.
from shotstack_sdk.model.merge_field import MergeField
merge_field = MergeField(
find = 'NAME',
replace = 'Jane'
)
| Argument | Type | Description | Required |
|---|---|---|---|
| find | string | The string to find without delimiters. | Y |
| replace | replace | The replacement value. The replacement can be any valid JSON type - string, boolean, number, etc... | Y |
The following schemas specify how to use templates to store and render templates. A template lets you save an Edit that can be rendered by its template ID and optionally include merge fields that are merged with the template when rendered.
A template is a saved Edit than can be loaded and re-used.
from shotstack_sdk.model.template import Template
template = Template(
name = 'My Template',
template = edit
)
| Argument | Type | Description | Required |
|---|---|---|---|
| name | string | The template name. | Y |
| template | Edit | An edit defines the arrangement of a video on a timeline, an audio edit or an image design and the output format. | Y |
Configure the id and optional merge fields to render a template by id.
from shotstack_sdk.model.template_render import TemplateRender
template_render = TemplateRender(
id = '21e781c0-8232-4418-fec1-cc99f0280c21',
merge = merge
)
| Argument | Type | Description | Required |
|---|---|---|---|
| id | string id | The id of the template to render in UUID format. | Y |
| merge | MergeField[] | 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. | - |
The following schemas specify the output format and settings.
The output format, render range and type of media to generate.
from shotstack_sdk.model.output import Output
output = Output(
format = 'mp4',
resolution = 'sd',
aspectRatio = '16:9',
size = size,
fps = 25.0,
scaleTo = 'preview',
quality = 'mediue',
repeat = True,
mute = False,
_range = _range,
poster = poster,
thumbnail = thumbnail,
destinations = destinations
)
| Argument | Type | Description | Required |
|---|---|---|---|
| format | string | The output format and type of media file to generate.
| Y |
| resolution | string | The output resolution of the video or image.
| - |
| aspectRatio | string | The aspect ratio (shape) of the video or image. Useful for social media output formats. Options are:
| - |
| size | Size | Set a custom size for a video or image. When using a custom size omit the resolution and aspectRatio. Custom sizes must be divisible by 2 based on the encoder specifications. | - |
| fps | float | Override the default frames per second. Useful for when the source footage is recorded at 30fps, i.e. on mobile devices. Lower frame rates can be used to add cinematic quality (24fps) or to create smaller file size/faster render times or animated gifs (12 or 15fps). Default is 25fps.
| - |
| scaleTo | string | Override the resolution and scale the video or image to render at a different size. When using scaleTo the asset should be edited at the resolution dimensions, i.e. use font sizes that look best at HD, then use scaleTo to output the file at SD and the text will be scaled to the correct size. This is useful if you want to create multiple asset sizes.
| - |
| quality | string | Adjust the output quality of the video, image or audio. Adjusting quality affects render speed, download speeds and storage requirements due to file size. The default medium provides the most optimized choice for all three factors.
| - |
| repeat | bool | Loop tings for gif files. Set to True to loop, False to play only once. [default to True] | - |
| mute | mute | Mute the audio track of the output video. Set to True to mute, False to un-mute. | - |
| range | Range | Specify a time range to render, i.e. to render only a portion of a video or audio file. Omit this ting to export the entire video. Range can also be used to render a frame at a specific time point - ting a range and output format as jpg will output a single frame image at the range start point. | - |
| poster | Poster | Generate a poster image from a specific point on the timeline. | - |
| thumbnail | Thumbnail | Generate a thumbnail image from a specific point on the timeline. | - |
| destinations | Destinations[] | A destination is a location where output files can be sent to for serving or hosting. By default all rendered assets are automatically sent to the Shotstack hosting destination. | - |
Set a custom size for a video or image. When using a custom size omit the resolution and aspectRatio. Custom sizes must be divisible by 2 based on the encoder specifications.
from shotstack_sdk.model.size import Size
size = Size(
width = 1200,
height = 800
)
| Argument | Type | Description | Required |
|---|---|---|---|
| width | int | Set a custom width for the video or image file. Value must be divisible by 2. Maximum video width is 1920px, maximum image width is 4096px. | - |
| height | int | Set a custom height for the video or image file. Value must be divisible by 2. Maximum video height is 1920px, maximum image height is 4096px. | - |
Specify a time range to render, i.e. to render only a portion of a video or audio file. Omit this setting to export the entire video. Range can also be used to render a frame at a specific time point - setting a range and output format as jpg
will output a single frame image at the range start point.
from shotstack_sdk.model.range import Range
_range = Range(
start = 3.0,
length = 6.0
)
| Argument | Type | Description | Required |
|---|---|---|---|
| start | float | The point on the timeline, in seconds, to start the render from - i.e. start at second 3. | - |
| length | float | The length of the portion of the video or audio to render - i.e. render 6 seconds of the video. | - |
Generate a Poster image for the video at a specific point from the timeline. The poster image size will match the size of the output video.
from shotstack_sdk.model.poster import Poster
poster = Poster(
capture = 1.0
)
| Argument | Type | Description | Required |
|---|---|---|---|
| capture | float | The point on the timeline in seconds to capture a single frame to use as the poster image. | Y |
Generate a thumbnail image for the video or image at a specific point from the timeline.
from shotstack_sdk.model.thumbnail import Thumbnail
thumbnail = Thumbnail(
capture = 1.0,
scale = 0.3
)
| Argument | Type | Description | Required |
|---|---|---|---|
| capture | float | The point on the timeline in seconds to capture a single frame to use as the thumbnail image. | Y |
| scale | float | Scale the thumbnail size to a fraction of the viewport size - i.e. ting the scale to 0.5 will scale the thumbnail to half the size of the viewport. | Y |
Send rendered assets to the Shotstack hosting and CDN service. This destination is enabled by default.
from shotstack_sdk.model.shotstack_destination import ShotstackDestination
shotstack_destination = ShotstackDestination(
provider = 'shotstack',
exclude = False
)
| Argument | Type | Description | Required |
|---|---|---|---|
| provider | string | The destination to send rendered asset to - set to shotstack for Shotstack hosting and CDN. [default to shotstack] | Y |
| exclude | bool | Set to True to opt-out from the Shotstack hosting and CDN service. All files must be downloaded within 24 hours of rendering. [default to False] | - |
Send rendered videos to the Mux video hosting and streaming service. Mux credentials are required and added via the dashboard, not in the request.
from shotstack_sdk.model.mux_destination import MuxDestination
mux_destination = MuxDestination(
provider = 'mux',
options = options
)
| Argument | Type | Description | Required |
|---|---|---|---|
| provider | string | The destination to send rendered assets to - set to mux for Mux. | Y |
| options | MuxDestinationOptions | Additional Mux configuration and features. | - |
Pass additional options to control how Mux processes video. Currently supports playback policy option.
from shotstack_sdk.model.mux_destination_options import MuxDestinationOptions
mux_destination_options = MuxDestinationOptions(
playback_policy = ['public']
)
| Argument | Type | Description | Required |
|---|---|---|---|
| playback_policy | string | Sets the Mux playback_policy option. Value is an array of strings - use public, signed, or both. | - |
Send rendered videos to an Amazon S3 bucket. Send files to any region with your own prefix and filename. AWS credentials are required and added via the dashboard, not in the request.
from shotstack_sdk.model.s3_destination import S3Destination
s3_destination = S3Destination(
provider = 's3',
options = options
)
| Argument | Type | Description | Required |
|---|---|---|---|
| provider | string | The destination to send rendered assets to - set to s3 for S3. | Y |
| options | S3DestinationOptions | Additional S3 configuration options. | - |
Pass additional options to control how files are stored in S3.
from shotstack_sdk.model.s3_destination_options import S3DestinationOptions
s3_destination_options = S3DestinationOptions(
region = 'us-east-1',
bucket = 'my-bucket',
prefix = 'my-renders',
filename = 'my-file',
acl = 'public-read'
)
| Argument | Type | Description | Required |
|---|---|---|---|
| region | string | Choose the region to send the file to. Must be a valid AWS region string like us-east-1 or ap-southeast-2 | Y |
| bucket | string | The bucket name to send files to. The bucket must exist in the AWS account before files can be sent. | Y |
| prefix | string | A prefix for the file being sent. This is typically a folder name, i.e. videos or customerId/videos. | - |
| filename | string | Use your own filename instead of the default render ID filename. Note: omit the file extension as this will be appended depending on the output format. Also -poster.jpg and -thumb.jpg will be appended for poster and thumbnail images. | - |
| acl | string | Sets the S3 Access Control List (acl) permissions. Default is private. Must use a valid S3 Canned ACL. | - |
The following schemas are returned by the render request and status request.
The response received after a render request is submitted. The render task is queued for rendering and a unique render id is returned.
| Attribute | Type | Description | Required |
|---|---|---|---|
| success | bool | True if successfully queued, else False. | Y |
| message | string | Created, Bad Request or an error message. | Y |
| response | QueuedResponseData | QueuedResponseData or an error message. | Y |
The QueuedResponseData is the response data returned with the QueuedResponse.
| Attribute | Type | Description | Required |
|---|---|---|---|
| message | string | Success response message or error details. | Y |
| id | string | The id of the render task in UUID format. | Y |
The RenderResponse is the response received after a render status request is submitted. The response includes details about status of a render and the output URL.
| Attribute | Type | Description | Required |
|---|---|---|---|
| success | bool | True if status available, else False. | Y |
| message | string | OK or an error message. | Y |
| response | RenderResponseData | RenderResponse or an error message. | Y |
The RenderResponseData is the response data returned with the RenderResponse request including status and URL.
| Argument | Type | Description | Required |
|---|---|---|---|
| id | string | The id of the render task in UUID format. | Y |
| owner | string | The owner id of the render task. | Y |
| plan | string | The customer subscription plan. | - |
| status | string | The status of the render task.
| Y |
| error | string | An error message, only displayed if an error occurred. | - |
| duration | float | The output video or audio length in seconds. | - |
| render_time | float | The time taken to render the asset in milliseconds. | - |
| url | string | The URL of the final asset. This will only be available if status is done. This is a temporary URL and will be deleted after 24 hours. By default all asset are copied to the Shotstack hosting and CDN destination. | - |
| poster | string | The URL of the poster image if requested. This will only be available if status is done. | - |
| thumbnail | string | The URL of the thumbnail image if requested. This will only be available if status is done. | - |
| data | Edit | The timeline and output data to be rendered. | Y |
| created | string | The time the render task was initially queued. | Y |
| updated | string | The time the render status was last updated. | Y |
The following schemas are returned by the templates endpoint, including create, update and rendering a template.
The response received after a template is submitted. The template is saved and a unique template id is returned.
| Attribute | Type | Description | Required |
|---|---|---|---|
| success | bool | True if successfully queued, else False. | Y |
| message | string | Created, Bad Request or an error message. | Y |
| response | TemplateResponseData | TemplateResponseData or an error message. | Y |
The response data returned with the TemplateResponse.
| Attribute | Type | Description | Required |
|---|---|---|---|
| message | string | Success response message or error details. | Y |
| id | string | The unique id of the template in UUID format. | Y |
The template data including the template name and Edit.
| Attribute | Type | Description | Required |
|---|---|---|---|
| success | bool | True if successfully queued, else False. | Y |
| message | string | Created, Bad Request or an error message. | Y |
| response | TemplateDataResponseData | TemplateDataResponseData or an error message. | Y |
The response data returned with the TemplateDataResponse.
| Attribute | Type | Description | Required |
|---|---|---|---|
| id | string | The unique id of the template in UUID format. | Y |
| name | string | The template name. | Y |
| owner | string | The owner id of the templates. | Y |
| template | Edit | Edit or an error message. | Y |
A list of previously saved templates.
| Attribute | Type | Description | Required |
|---|---|---|---|
| success | bool | True if successfully queued, else False. | Y |
| message | string | Created, Bad Request or an error message. | Y |
| response | TemplateListResponseData | TemplateListResponseData or an error message. | Y |
The response data returned with the TemplateListResponse.
| Attribute | Type | Description | Required |
|---|---|---|---|
| owner | bool | The owner id of the templates. | Y |
| templates | TemplateListResponseItem[] | The list of templates. | Y |
The individual template item returned with the TemplateListResponseData templates list.
| Attribute | Type | Description | Required |
|---|---|---|---|
| id | string | The unique id of the template in UUID format. | Y |
| name | string | The template name | Y |
| created | string | The time the template was created. | - |
| updated | string | The time the template was last updated. | - |
The SDK probe endpoint can be used to inspect media hosted online. Simply pass the URL of an asset to inspect.
The example below inspects (probes) a video hosted on GitHub and returns metadata about the file.
import shotstack_sdk as shotstack
from shotstack_sdk.api import edit_api
host = "https://api.shotstack.io/stage"
configuration = shotstack.Configuration(host = host)
configuration.api_key['DeveloperKey'] = "H7jKyj90kd09lbLOF7J900jNbSWS67X87xs9j0cD"
with shotstack.ApiClient(configuration) as api_client:
api_instance = edit_api.EditApi(api_client)
url = 'https://github.com/shotstack/test-media/raw/main/captioning/scott-ko.mp4'
try:
api_response = api_instance.probe(url)
streams = api_response['response']['metadata']['streams']
for stream in streams:
if stream['codec_type'] == 'video':
print(f"Example settings for: {api_response['response']['metadata']['format']['filename']}")
print(f"Width: {stream['width']}px")
print(f"Height: {stream['height']}px")
print(f"Framerate: {stream['r_frame_rate']} fps")
print(f"Duration: {stream['duration']} secs")
except Exception as e:
print(f"Unable to resolve API call: {e}")
The following schemas are returned by the probe request.
The ProbeResponse is the response returned after a probe request is submitted. The probe requests returns data from FFprobe formatted as JSON.
| Argument | Type | Description | Required |
|---|---|---|---|
| success | bool | True if media successfully read, else False. | Y |
| message | string | Created, Bad Request or an error message. | Y |
| response | object | The response from FFprobe in JSON format | Y |
By default, all assets generated by the editing API are hosted by Shotstack and served via our CDN. The SDK provides access to the Serve API to retrieve information about hosted files. Files can also be deleted.
The example below uses a render ID to look up hosted assets associated with the render. Note that multiple assets can be created for a render, i.e. video, thumb and poster. Each asset has a unique asset ID different to the render ID.
import shotstack_sdk as shotstack
from shotstack_sdk.api import serve_api
host = 'https://api.shotstack.io/stage'
configuration = shotstack.Configuration(host = host)
configuration.api_key['DeveloperKey'] = 'H7jKyj90kd09lbLOF7J900jNbSWS67X87xs9j0cD'
with shotstack.ApiClient(configuration) as api_client:
api_instance = serve_api.ServeApi(api_client)
id = '140924c6-077d-4334-a89f-94befcfc0155'
try:
api_response = api_instance.get_asset_by_render_id(id)
data = api_response['data']
if data['attributes']['status'] == 'ready':
print(f">> Asset CDN URL: {data['attributes']['url']}")
print(f">> Asset ID: {data['attributes']['id']}")
print(f">> Render ID: {data['attributes']['render_id']}")
except Exception as e:
print(f"Unable to resolve API call: {e}")
Every asset has a unique asset ID, the example below looks up an asset by its asset ID.
import shotstack_sdk as shotstack
from shotstack_sdk.api import serve_api
host = 'https://api.shotstack.io/stage'
configuration = shotstack.Configuration(host = host)
configuration.api_key['DeveloperKey'] = 'H7jKyj90kd09lbLOF7J900jNbSWS67X87xs9j0cD'
with shotstack.ApiClient(configuration) as api_client:
api_instance = serve_api.ServeApi(api_client)
id = 'ed43eae3-4825-4c03-979d-f7dc47b9997c'
try:
api_response = api_instance.get_asset(id)
data = api_response['data']
if data['attributes']['status'] == 'ready':
print(">> Something went wrong, asset could not be copied.")
else:
print(f">> Asset CDN URL: {data['attributes']['url']}")
print(f">> Asset ID: {data['attributes']['id']}")
print(f">> Render ID: {data['attributes']['render_id']}")
except Exception as e:
print(f"Unable to resolve API call: {e}")
The following schemas are returned by requests to the Serve API.
The AssetResponse is the response returned by the Serve API get asset request. Includes details of a hosted video, image, audio file, thumbnail or poster image. The response follows the json:api specification.
| Argument | Type | Description | Required |
|---|---|---|---|
| data | AssetResponseData | Returns an asset resource. | - |
The AssetRenderResponse is the response returned by the Serve API get asset by render id request. The response is an array of asset resources, including video, image, audio, thumbnail and poster image. The response follows the json:api specification.
| Argument | Type | Description | Required |
|---|---|---|---|
| data | AssetResponseData[] | Returns an array of asset resources grouped by render id. | - |
The AssetResponseData contains the type of resource (an asset) and attributes of the asset.
| Argument | Type | Description | Required |
|---|---|---|---|
| type | string | The type of resource, in this case it is an asset. | - |
| attributes | AssetResponseAttributes | The asset attributes including render id, url, filename, file size, etc... | - |
The AssetResponseAttributes contains the list of asset attributes and their values.
| Argument | Type | Description | Required |
|---|---|---|---|
| id | string | The unique id of the hosted asset in UUID format. | - |
| owner | string | The owner id of the render task. | - |
| region | string | The region the asset is hosted, currently only au (Australia). | - |
| renderId | string | The original render id that created the asset in UUID format. Multiple asset can share the same render id. | - |
| filename | string | The asset file name. | - |
| url | string | The asset file name. | - |
| status | string | The status of the asset.
| - |
| created | string | The time the asset was created. | - |
| updated | string | The time the asset status was last updated. | - |
FAQs
Shotstack
We found that shotstack-sdk demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
The Socket research team breaks down a sampling of malicious packages that download and execute files, among other suspicious behaviors, targeting the popular Discord platform.
Security News
Socket CEO Feross Aboukhadijeh joins a16z partners to discuss how modern, sophisticated supply chain attacks require AI-driven defenses and explore the challenges and solutions in leveraging AI for threat detection early in the development life cycle.
Security News
NIST's new AI Risk Management Framework aims to enhance the security and reliability of generative AI systems and address the unique challenges of malicious AI exploits.