Where you work

Surface

Codex or an agent with shell access

Local MCP, shared CLI or both

Desktop chat

Compatible local MCP or .mcpb

Scripts/CI

CLI or an MCP client

Remote-URL-only chat

Official provider-hosted MCP

Capability

CLI command

MCP tool

Render and status

render / get-render

render / get_render

Templates

create-template / list-templates / render-template

create_template / list_templates / render_template

Generation models and jobs

list-models / generate-asset / get-generated-asset

list_models / generate_asset / get_generated_asset

Hosted assets

get-asset / transfer-asset

get_asset / transfer_asset

Ingest sources

ingest-source / list-sources / get-source

ingest_source / list_sources / get_source

Private upload credential

create-upload-url-file

create_upload_url_file

Account/environment labels

list-accounts

list_accounts

Configuration checks

doctor / login

CLI utilities

Number

Section

What it covers

1

What you can ask it

Practical tasks

2

Quick install

MCP/CLI/desktop

3

Set up Shotstack access

Keys, environments, credits

4

Connect your client

All client/OS routes

5

Check it works

Doctor and first read

6

Output, flags and exit codes

Flags and scripting

7

MCP or CLI and token cost

Actual measurement method

8

Every tool and argument

Every route/argument

9

Render, template, generation and media workflows

Native workflow inputs

10

Jobs, pagination and private files

Status and private credential files

11

Several private accounts

Isolated named profiles

12

Writing safely

Approval and direct-call policies

13

How it works

Shared architecture and sync

14

Your data

Credentials and provider processing

15

Environment variables

Private settings and bounds

16

Updates and removal

Upgrade/revoke/uninstall

17

Troubleshooting

Errors and recovery

18

API coverage and comparisons

Official and community tradeoffs

19

Versions

Release history and migration

20

FAQ

Accordion answers

Flag

What it does

--json

JSON output

--compact

Single-line JSON

--agent

Compact JSON and no prompts; never confirms a write

--select a,b.c

Keep selected fields; dotted paths descend and arrays are traversed

--confirm

Confirm the requested paid media operation

--no-input, --no-color, --yes

Automation switches; none overrides the spending guard

--wait=false

Return an accepted job instead of polling

--download

Save completed media locally; requires waiting for completion

Exit code

Meaning

What a script should do

0

Success

Read stdout

1

Unexpected error

Report it with the command that caused it

2

Usage, invalid input, a refused write, an unknown command or a hidden write

Fix the input or confirm only the requested action

3

Job or local upload file not found

Check the ID/path

4

Authentication or entitlement rejected

Check private credential settings and permissions

5

API, network or polling failure

Inspect an accepted job before another paid submission

7

Rate limited

Wait; do not loop over paid submissions

10

Credentials not configured

Complete local setup

Cost

2.0.2

3.0.0

Claude Code, every tool loaded, every message

287,446

154,114

Claude Code's default, tool search, every message

482

480

SKILL.md, read once

1,207

1,266

Codex over the CLI, one task, median of five

105,563

83,947

Codex over MCP, the same task, median of five

46,793

47,033

Tool

Route

Mode

render

POST /edit/{environment}/render

Confirm requested operation

get_render

GET /edit/{environment}/render/{id}

Read

create_template

POST /edit/{environment}/templates

Confirm requested operation

list_templates

GET /edit/{environment}/templates

Read

get_template

GET /edit/{environment}/templates/{id}

Read

update_template

PUT /edit/{environment}/templates/{id}

Confirm requested operation

delete_template

DELETE /edit/{environment}/templates/{id}

Confirm requested operation

render_template

POST /edit/{environment}/templates/render

Confirm requested operation

probe_media

GET /edit/{environment}/probe/{url}

Read

generate_asset

POST /edit/{environment}/generate

Confirm requested operation

get_generated_asset

GET /edit/{environment}/generate/{id}

Read

list_models

GET /edit/{environment}/models

Read

get_model

GET /edit/{environment}/models/{id}

Read

get_asset

GET /serve/{environment}/assets/{id}

Read

delete_asset

DELETE /serve/{environment}/assets/{id}

Confirm requested operation

get_asset_by_render_id

GET /serve/{environment}/assets/render/{id}

Read

transfer_asset

POST /serve/{environment}/assets

Confirm requested operation

ingest_source

POST /ingest/{environment}/sources

Confirm requested operation

list_sources

GET /ingest/{environment}/sources

Read

get_source

GET /ingest/{environment}/sources/{id}

Read

delete_source

DELETE /ingest/{environment}/sources/{id}

Confirm requested operation

create_upload_url_file

POST /ingest/{environment}/upload

Confirm requested operation

list_accounts

Local, no network

Read

Argument

Required

Type

Details

timeline

No; body and guard rules apply

Timeline

See the full input schema.

output

No; body and guard rules apply

Output

See the full input schema.

merge

No; body and guard rules apply

array

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. Items: MergeField.

callback

No; body and guard rules apply

string

An 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. See webhooks for more details.

disk

No; body and guard rules apply

string

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. local - optimized for high speed rendering with up to 512MB storage mount - optimized for larger file sizes and longer videos with 5GB for source footage and 512MB for output render Values: local, mount.

instance

No; body and guard rules apply

string

The render instance type to use for processing the edit. s1 - standard instance (default) s2 - standard instance with more resources a1 - accelerated instance for faster rendering Values: s1, s2, a1. default: s1.

account

No; body and guard rules apply

string

Named private Shotstack account; selects private credentials and stage/v1 environment.

confirm

No; body and guard rules apply

boolean

Set true only when the user asked for exactly this action.

payload

No; body and guard rules apply

object

Complete JSON request body instead of body flags. Preserves current endpoint fields and values.

payload_file

No; body and guard rules apply

string

Regular local JSON body file, at most 5 MB. Cannot be mixed with body flags or payload. minLength: 1.

Argument

Required

Type

Details

id

Yes

string

Exact resource ID from the selected account. minLength: 1.

account

No; body and guard rules apply

string

Named private Shotstack account; selects private credentials and stage/v1 environment.

Argument

Required

Type

Details

name

No; body and guard rules apply

string

The template name

template

No; body and guard rules apply

Edit

See the full input schema.

account

No; body and guard rules apply

string

Named private Shotstack account; selects private credentials and stage/v1 environment.

confirm

No; body and guard rules apply

boolean

Set true only when the user asked for exactly this action.

payload

No; body and guard rules apply

object

Complete JSON request body instead of body flags. Preserves current endpoint fields and values.

payload_file

No; body and guard rules apply

string

Regular local JSON body file, at most 5 MB. Cannot be mixed with body flags or payload. minLength: 1.

Argument

Required

Type

Details

account

No; body and guard rules apply

string

Named private Shotstack account; selects private credentials and stage/v1 environment.

Argument

Required

Type

Details

id

Yes

string

Exact resource ID from the selected account. minLength: 1.

account

No; body and guard rules apply

string

Named private Shotstack account; selects private credentials and stage/v1 environment.

Argument

Required

Type

Details

id

Yes

string

Exact resource ID from the selected account. minLength: 1.

name

No; body and guard rules apply

string

The template name

template

No; body and guard rules apply

Edit

See the full input schema.

account

No; body and guard rules apply

string

Named private Shotstack account; selects private credentials and stage/v1 environment.

confirm

No; body and guard rules apply

boolean

Set true only when the user asked for exactly this action.

payload

No; body and guard rules apply

object

Complete JSON request body instead of body flags. Preserves current endpoint fields and values.

payload_file

No; body and guard rules apply

string

Regular local JSON body file, at most 5 MB. Cannot be mixed with body flags or payload. minLength: 1.

Argument

Required

Type

Details

id

Yes

string

Exact resource ID from the selected account. minLength: 1.

account

No; body and guard rules apply

string

Named private Shotstack account; selects private credentials and stage/v1 environment.

confirm

No; body and guard rules apply

boolean

Set true only when the user asked for exactly this action.

Argument

Required

Type

Details

id

No; body and guard rules apply

string

The id of the template to render in UUID format.

merge

No; body and guard rules apply

array

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. Items: MergeField.

account

No; body and guard rules apply

string

Named private Shotstack account; selects private credentials and stage/v1 environment.

confirm

No; body and guard rules apply

boolean

Set true only when the user asked for exactly this action.

payload

No; body and guard rules apply

object

Complete JSON request body instead of body flags. Preserves current endpoint fields and values.

payload_file

No; body and guard rules apply

string

Regular local JSON body file, at most 5 MB. Cannot be mixed with body flags or payload. minLength: 1.

Argument

Required

Type

Details

url

Yes

string

Public HTTPS URL of the selected media file. minLength: 1. format: uri. pattern: ^https://.

account

No; body and guard rules apply

string

Named private Shotstack account; selects private credentials and stage/v1 environment.

Argument

Required

Type

Details

idempotency_key

No; body and guard rules apply

string

A key that makes this request its own generation. Retrying with the same key returns the job it first created instead of generating and billing again, and a new key generates afresh even when the asset matches an earlier one. Without a key, identical assets share one cached result. For 24 hours a key reused for a different asset is rejected; after that it returns its first result.

asset

No; body and guard rules apply

GenerationAsset

See the full input schema.

length

No; body and guard rules apply

number

The length, in seconds, of the clip the asset fills. A model that generates to a duration takes it from this value in place of its own duration option. Other models ignore it.

account

No; body and guard rules apply

string

Named private Shotstack account; selects private credentials and stage/v1 environment.

confirm

No; body and guard rules apply

boolean

Set true only when the user asked for exactly this action.

payload

No; body and guard rules apply

object

Complete JSON request body instead of body flags. Preserves current endpoint fields and values.

payload_file

No; body and guard rules apply

string

Regular local JSON body file, at most 5 MB. Cannot be mixed with body flags or payload. minLength: 1.

Argument

Required

Type

Details

id

Yes

string

Exact resource ID from the selected account. minLength: 1.

account

No; body and guard rules apply

string

Named private Shotstack account; selects private credentials and stage/v1 environment.

Argument

Required

Type

Details

account

No; body and guard rules apply

string

Named private Shotstack account; selects private credentials and stage/v1 environment.

Argument

Required

Type

Details

id

Yes

string

Exact resource ID from the selected account. minLength: 1.

account

No; body and guard rules apply

string

Named private Shotstack account; selects private credentials and stage/v1 environment.

Argument

Required

Type

Details

id

Yes

string

Exact resource ID from the selected account. minLength: 1.

account

No; body and guard rules apply

string

Named private Shotstack account; selects private credentials and stage/v1 environment.

Argument

Required

Type

Details

id

Yes

string

Exact resource ID from the selected account. minLength: 1.

account

No; body and guard rules apply

string

Named private Shotstack account; selects private credentials and stage/v1 environment.

confirm

No; body and guard rules apply

boolean

Set true only when the user asked for exactly this action.

Argument

Required

Type

Details

id

Yes

string

Exact resource ID from the selected account. minLength: 1.

account

No; body and guard rules apply

string

Named private Shotstack account; selects private credentials and stage/v1 environment.

Argument

Required

Type

Details

url

No; body and guard rules apply

string

The file URL to fetch and transfer.

id

No; body and guard rules apply

string

An identifier for the asset which must be provided by the client. The identifier does not need to be unique.

destinations

No; body and guard rules apply

array

Specify the storage locations and hosting services to send the file to. Items: Destinations.

account

No; body and guard rules apply

string

Named private Shotstack account; selects private credentials and stage/v1 environment.

confirm

No; body and guard rules apply

boolean

Set true only when the user asked for exactly this action.

payload

No; body and guard rules apply

object

Complete JSON request body instead of body flags. Preserves current endpoint fields and values.

payload_file

No; body and guard rules apply

string

Regular local JSON body file, at most 5 MB. Cannot be mixed with body flags or payload. minLength: 1.

Argument

Required

Type

Details

url

No; body and guard rules apply

string

The URL of the file to be ingested. The URL must be publicly accessible or include credentials.

outputs

No; body and guard rules apply

Outputs

See the full input schema.

destinations

No; body and guard rules apply

Destinations

See the full input schema.

callback

No; body and guard rules apply

string

An optional webhook callback URL used to receive status notifications when sources are uploaded and renditions processed.

account

No; body and guard rules apply

string

Named private Shotstack account; selects private credentials and stage/v1 environment.

confirm

No; body and guard rules apply

boolean

Set true only when the user asked for exactly this action.

payload

No; body and guard rules apply

object

Complete JSON request body instead of body flags. Preserves current endpoint fields and values.

payload_file

No; body and guard rules apply

string

Regular local JSON body file, at most 5 MB. Cannot be mixed with body flags or payload. minLength: 1.

Argument

Required

Type

Details

account

No; body and guard rules apply

string

Named private Shotstack account; selects private credentials and stage/v1 environment.

Argument

Required

Type

Details

id

Yes

string

Exact resource ID from the selected account. minLength: 1.

account

No; body and guard rules apply

string

Named private Shotstack account; selects private credentials and stage/v1 environment.

Argument

Required

Type

Details

id

Yes

string

Exact resource ID from the selected account. minLength: 1.

account

No; body and guard rules apply

string

Named private Shotstack account; selects private credentials and stage/v1 environment.

confirm

No; body and guard rules apply

boolean

Set true only when the user asked for exactly this action.

Argument

Required

Type

Details

account

No; body and guard rules apply

string

Named private Shotstack account; selects private credentials and stage/v1 environment.

confirm

No; body and guard rules apply

boolean

Set true only when the user asked for exactly this action.

secret_result_file

Yes

string

New absolute JSON file in a private owner-only directory. Signed upload URL stays out of model output; no overwrite. minLength: 1.

Argument

Required

Type

Details

None

No

None

No arguments

Argument

Required

Type

Details

soundtrack

No; body and guard rules apply

Soundtrack

A music or audio soundtrack file in mp3 format. Deprecated - use an AudioAsset clip on its own track instead.

background

No; body and guard rules apply

string

A hexadecimal value for the timeline background colour. Defaults to #000000 (black).

fonts

No; body and guard rules apply

array

An array of custom fonts to be downloaded for use by the HTML assets. Items: Font.

tracks

Yes

array

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. minItems: 1. Items: Track.

cache

No; body and guard rules apply

boolean

Disable the caching of ingested source footage and assets. See caching for more details.

Argument

Required

Type

Details

src

Yes

string

The URL of the mp3 audio file. The URL must be publicly accessible or include credentials. minLength: 1. pattern: \S.

effect

No; body and guard rules apply

string

The effect to apply to the audio file fadeIn - fade volume in only fadeOut - fade volume out only fadeInFadeOut - fade volume in and out Values: fadeIn, fadeOut, fadeInFadeOut.

volume

No; body and guard rules apply

number

Set the volume for the soundtrack between 0 and 1 where 0 is muted and 1 is full volume (defaults to 1).

Argument

Required

Type

Details

src

Yes

string

The URL of the font file. The URL must be publicly accessible or include credentials.

Argument

Required

Type

Details

clips

Yes

array

An array of Clips comprising of TitleClip, ImageClip or VideoClip. minItems: 1. Items: Clip.

Argument

Required

Type

Details

id

No; body and guard rules apply

string

Optional client-generated identifier. Used by client SDKs (e.g. the Shotstack Studio SDK) to reference a clip across edits without relying on its position in the timeline. The render API does not use this field and it does not appear in render output.

asset

Yes

Asset

See the full input schema.

start

Yes

Union

The start position of the Clip on the timeline.

length

Yes

Union

The duration the Clip should play for.

fit

No; body and guard rules apply

string

Set how the asset should be scaled to fit the viewport using one of the following options: crop (default) - scale the asset to fill the viewport while maintaining the aspect ratio. The asset will be cropped if it exceeds the bounds of the viewport. cover - stretch the asset to fill the viewport without maintaining the aspect ratio. contain - fit the entire asset within the viewport while maintaining the original aspect ratio. none - preserves the original asset dimensions and does not apply any scaling. Values: cover, contain, crop, none.

scale

No; body and guard rules apply

Union

Scale the asset to a fraction of the viewport size - i.e. setting 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. Use a number or an array of Tween objects to create a custom animation.

width

No; body and guard rules apply

number

Set the width of the clip bounding box in pixels. This constrains the width of the clip, overriding the default behavior where clips fill the viewport width. minimum: 1. maximum: 3840. format: float.

height

No; body and guard rules apply

number

Set the height of the clip bounding box in pixels. This constrains the height of the clip, overriding the default behavior where clips fill the viewport height. minimum: 1. maximum: 2160. format: float.

position

No; body and guard rules apply

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. top - top (center) topRight - top right right - right (center) bottomRight - bottom right bottom - bottom (center) bottomLeft - bottom left left - left (center) topLeft - top left center - center Values: top, topRight, right, bottomRight, bottom, bottomLeft, left, topLeft, center.

offset

No; body and guard rules apply

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

No; body and guard rules apply

Transition

See the full input schema.

effect

No; body and guard rules apply

string

A motion effect to apply to the Clip. zoomIn - slow zoom in zoomOut - slow zoom out slideLeft - slow slide (pan) left slideRight - slow slide (pan) right slideUp - slow slide (pan) up slideDown - slow slide (pan) down The motion effect speed can also be controlled by appending Fast or Slow to the effect, e.g. zoomInFast or slideRightSlow. Values: zoomIn, zoomInSlow, zoomInFast, zoomOut, zoomOutSlow, zoomOutFast, slideLeft, slideLeftSlow, slideLeftFast, slideRight, slideRightSlow, slideRightFast, slideUp, slideUpSlow, slideUpFast, slideDown, slideDownSlow, slideDownFast.

filter

No; body and guard rules apply

string

A filter effect to apply to the Clip. none - no filter applied blur - blur the scene boost - boost contrast and saturation contrast - increase contrast darken - darken the scene greyscale - remove colour lighten - lighten the scene muted - reduce saturation and contrast negative - negative colors Values: none, blur, boost, contrast, darken, greyscale, lighten, muted, negative.

opacity

No; body and guard rules apply

Union

Offset an asset on the horizontal axis (left or right). Use a number or an array of Tween objects to create a custom animation.

transform

No; body and guard rules apply

Transformation

A transformation lets you modify the visual properties of a clip. Available transformations are rotate, skew and flip. Transformations can be combined to create interesting new shapes and effects.

alias

No; body and guard rules apply

string

A unique identifier for this clip that can be used to reference it from other clips using the alias:// protocol in asset sources. This is useful for features like auto-captioning where a caption asset needs to reference the audio from another clip. pattern: ^[A-Za-z0-9_-]+$.

Argument

Required

Type

Details

type

Yes

string

The type of asset - set to video for videos. Values: video. default: video.

src

No; body and guard rules apply

string

The video source URL. The URL must be publicly accessible or include credentials. When prompt is also set, src serves as a preview placeholder and the video is regenerated from the prompt at render time. minLength: 1. pattern: \S.

prompt

No; body and guard rules apply

string

A text prompt to generate the video from. The engine generates a video at render time and fills src automatically; an existing src is treated as a preview placeholder and replaced. Use model to choose the generator and options to configure it. A starting image goes in options.startSrc — or options.inputSrc on the original image-to-video models — on the models that accept one. maxLength: 4000.

model

No; body and guard rules apply

string

The generation model to use when prompt is set (e.g. seedance-2.0-text-to-video). Defaults to seedance-2.0-text-to-video if omitted. GET /models lists what is available and the options each accepts.

options

No; body and guard rules apply

object

Model-specific generation settings. Valid keys and values depend on the chosen model and are defined by the model registry. Omitted options use the model's defaults. Unknown or invalid options are rejected.

transcode

No; body and guard rules apply

boolean

Set to true to force re-encoding of the video during preprocessing. This can help resolve compatibility issues, fix rotation problems, synchronize audio, or convert formats. The video will be processed to ensure optimal compatibility with the rendering engine.

trim

No; body and guard rules apply

number

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

No; body and guard rules apply

Union

Set the volume of the video clip. Use a number or an array of Tween objects to create custom volume transitions.

volumeEffect

No; body and guard rules apply

string

Preset volume effects to apply to the video asset fadeIn - fade volume in only fadeOut - fade volume out only fadeInFadeOut - fade volume in and out Values: none, fadeIn, fadeOut, fadeInFadeOut.

speed

No; body and guard rules apply

Union

Adjust the playback speed of the video clip. Use a number for a constant speed or an array of Tween objects to change speed over time, for example easing from normal speed up to 3x.

crop

No; body and guard rules apply

Crop

See the full input schema.

chromaKey

No; body and guard rules apply

ChromaKey

See the full input schema.

Argument

Required

Type

Details

type

Yes

string

The type of asset - set to image for images. Values: image. default: image.

src

No; body and guard rules apply

string

The image source URL. The URL must be publicly accessible or include credentials. When prompt is also set, src serves as a preview placeholder and the image is regenerated from the prompt at render time. minLength: 1. pattern: \S.

prompt

No; body and guard rules apply

string

A text prompt to generate the image from. The engine generates an image at render time and fills src automatically; an existing src is treated as a preview placeholder and replaced. Use model to choose the generator and options to configure it. maxLength: 4000.

model

No; body and guard rules apply

string

The generation model to use when prompt is set (e.g. flux-schnell, nano-banana-2). Defaults to nano-banana-2 if omitted. Each model's available options are defined by the model registry.

options

No; body and guard rules apply

object

Model-specific generation settings. Valid keys and values depend on the chosen model and are defined by the model registry. Omitted options use the model's defaults. Unknown or invalid options are rejected.

crop

No; body and guard rules apply

Crop

See the full input schema.

Argument

Required

Type

Details

type

Yes

string

The type of asset - set to text for text. Values: text. default: text.

text

Yes

string

The text string to display.

width

No; body and guard rules apply

integer

Set the width of the HTML asset bounding box in pixels. Text will wrap to fill the bounding box.

height

No; body and guard rules apply

integer

Set the width of the HTML asset bounding box in pixels. Text and elements will be masked if they exceed the height of the bounding box.

font

No; body and guard rules apply

TextFont

Font styling properties.

background

No; body and guard rules apply

TextBackground

Background styling properties.

alignment

No; body and guard rules apply

TextAlignment

Alignment properties.

stroke

No; body and guard rules apply

object

Text stroke (outline) properties.

animation

No; body and guard rules apply

object

Animation properties for text entrance effects.

ellipsis

No; body and guard rules apply

string

The string to display when text overflows its bounding box. Set to an ellipsis character or custom string to indicate truncated text.

Argument

Required

Type

Details

type

Yes

string

The type of asset - set to rich-text for rich text. Values: rich-text. default: rich-text.

text

Yes

string

The text string to display. Maximum 5000 characters. maxLength: 5000.

font

No; body and guard rules apply

RichTextFont

Font styling properties.

style

No; body and guard rules apply

RichTextStyle

Text style properties including spacing, line height, and transformations.

stroke

No; body and guard rules apply

RichTextStroke

Text stroke (outline) properties.

shadow

No; body and guard rules apply

RichTextShadow

Text shadow properties.

background

No; body and guard rules apply

RichTextBackground

Background styling properties for the text bounding box.

border

No; body and guard rules apply

RichTextBorder

Border styling properties for the text bounding box.

padding

No; body and guard rules apply

Union

Padding inside the text bounding box. Can be a single number (applied to all sides) or an object with individual sides.

align

No; body and guard rules apply

RichTextAlignment

Text alignment properties (horizontal and vertical).

animation

No; body and guard rules apply

RichTextAnimation

Animation properties for text entrance effects.

Argument

Required

Type

Details

type

Yes

string

The type of asset - set to audio for audio assets. Values: audio. default: audio.

src

No; body and guard rules apply

string

The audio source URL. The URL must be publicly accessible or include credentials. When prompt is also set, src serves as a preview placeholder and the audio is regenerated from the prompt at render time. minLength: 1. pattern: \S.

prompt

No; body and guard rules apply

string

A text prompt. For text-to-speech models the prompt is the spoken text; for music models it describes the sound to generate. The generated src is filled in automatically; an existing src is treated as a preview placeholder and replaced. maxLength: 4000.

model

No; body and guard rules apply

string

The generation model to use when prompt is set (e.g. polly-neural, elevenlabs-tts, elevenlabs-music). Defaults to elevenlabs-tts (with a default voice) if omitted. Each model's available options are defined by the model registry.

options

No; body and guard rules apply

object

Model-specific generation settings. Valid keys and values depend on the chosen model and are defined by the model registry. Omitted options use the model's defaults. Unknown or invalid options are rejected.

trim

No; body and guard rules apply

number

The start trim point of the audio clip, in seconds (defaults to 0). Audio will start from the in trim point. The audio will play until the file ends or the Clip length is reached.

volume

No; body and guard rules apply

Union

Set the volume of the audio clip. Use a number or an array of Tween objects to create custom volume transitions.

speed

No; body and guard rules apply

number

Adjust the playback speed of the audio clip between 0 (paused) and 10 (10x normal speed), where 1 is normal speed (defaults to 1). Adjusting the speed will also adjust the duration of the clip and may require you to adjust the Clip length. For example, if you set speed to 0.5, the clip will need to be 2x as long to play the entire audio (i.e. original length / 0.5). If you set speed to 2, the clip will need to be half as long to play the entire audio (i.e. original length / 2). minimum: 0. maximum: 10. format: float.

effect

No; body and guard rules apply

string

The effect to apply to the audio asset fadeIn - fade volume in only fadeOut - fade volume out only fadeInFadeOut - fade volume in and out Values: none, fadeIn, fadeOut, fadeInFadeOut.

Argument

Required

Type

Details

type

Yes

string

The type of asset - set to shape for shape. Values: shape. default: shape.

shape

Yes

string

The shape to display. Values: rectangle, circle, line.

width

No; body and guard rules apply

integer

Sets the width of the bounding box in pixels. This value should be larger than the shape's width. If omitted, the entire viewport width and height will be used.

height

No; body and guard rules apply

integer

Sets the height of the bounding box in pixels. This value should be larger than the shape's height. If omitted, the entire viewport width and height will be used.

fill

No; body and guard rules apply

object

Specifies the fill style of the shape.

stroke

No; body and guard rules apply

object

Specifies the stroke style of the shape.

rectangle

No; body and guard rules apply

object

Configuration settings for the rectangle shape. Required when shape is set to rectangle.

circle

No; body and guard rules apply

object

Configuration settings for the circle shape. Required when shape is set to circle.

line

No; body and guard rules apply

object

Configuration settings for the line shape. Required when shape is set to line.

Argument

Required

Type

Details

type

Yes

string

The type of asset - set to luma for luma mattes. Values: luma. default: luma.

src

Yes

string

The luma matte source URL. The URL must be publicly accessible or include credentials. minLength: 1. pattern: \S.

trim

No; body and guard rules apply

number

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.

Argument

Required

Type

Details

type

Yes

string

The type of asset - set to caption for captions. Values: caption. default: caption.

src

Yes

string

The URL to an SRT or VTT subtitles file, or an alias reference to auto-generate captions from an audio or video clip. For file URLs, the URL must be publicly accessible or include credentials. For auto-captioning, use the format alias://clip-name where clip-name is the alias of an audio, video, or text-to-speech clip. The system will automatically transcribe the audio and detect the language. minLength: 1. pattern: \S.

font

No; body and guard rules apply

CaptionFont

Font styling properties.

background

No; body and guard rules apply

CaptionBackground

Background styling properties.

margin

No; body and guard rules apply

CaptionMargin

Margin properties.

trim

No; body and guard rules apply

number

The start trim point of the captions, in seconds (defaults to 0). Remove the trim length from the start of the captions and allow it to be synced with video or audio. The captions will play until the file ends or the Clip length is reached.

speed

No; body and guard rules apply

number

Adjust the playback speed of the captions between 0 (paused) and 10 (10x normal speed) where 1 is normal speed (defaults to 1). Adjusting the speed will also adjust the duration of the clip and may require you to adjust the Clip length. For example, if you set speed to 0.5, the clip will need to be 2x as long to play the entire captions (i.e. original length / 0.5). If you set speed to 2, the clip will need to be half as long to play the entire captions (i.e. original length / 2). minimum: 0. maximum: 10. format: float.

Argument

Required

Type

Details

type

Yes

string

The type of asset - set to rich-caption for rich captions. Values: rich-caption. default: rich-caption.

src

Yes

string

Source for the caption words. Accepts three formats: (1) the URL to a subtitle file (.srt, .vtt, .ttml, or .dfxp) which is parsed directly; (2) the URL to an audio or video media file (.mp4, .mov, .webm, .mp3, .wav, .m4a, .flac, .aac, .ogg, and related formats) which is auto-transcribed; (3) an alias reference in the form alias://clip-name where clip-name is the alias of another audio, video, or text-to-speech clip in the same timeline — the referenced clip's source is auto-transcribed. For file URLs, the URL must be publicly accessible or include credentials. Content is classified at runtime and unsupported content types (HTML, PDF, images, archives) are rejected with a structured error. minLength: 1.

font

No; body and guard rules apply

object

Font styling properties for inactive words.

style

No; body and guard rules apply

object

Text style properties including spacing, line height, and transformations.

stroke

No; body and guard rules apply

RichTextStroke

Text stroke (outline) properties for inactive words.

shadow

No; body and guard rules apply

RichTextShadow

Text shadow properties.

background

No; body and guard rules apply

RichTextBackground

Background styling properties for the caption bounding box.

border

No; body and guard rules apply

RichTextBorder

Border styling properties for the caption bounding box.

padding

No; body and guard rules apply

Union

Padding inside the caption bounding box. Can be a single number (applied to all sides) or an object with individual sides.

align

No; body and guard rules apply

RichTextAlignment

Text alignment properties (horizontal and vertical).

active

No; body and guard rules apply

RichCaptionActive

Styling properties for the active/highlighted word. These override the base styling when a word is being spoken.

animation

No; body and guard rules apply

RichCaptionAnimation

Word-level animation properties controlling how words are highlighted or revealed.

Argument

Required

Type

Details

family

No; body and guard rules apply

string

The font family for the active word. Inherits from the base font.family when not set.

weight

No; body and guard rules apply

JSON

The weight of the font for the active word. Can be a number (100-900) or a string. Inherits from the base font.weight when not set. default: 400.

color

No; body and guard rules apply

string

The active word color using hexadecimal color notation. pattern: ^#[A-Fa-f0-9]{6}$.

background

No; body and guard rules apply

string

The background color behind the active word using hexadecimal color notation. pattern: ^#[A-Fa-f0-9]{6}$.

opacity

No; body and guard rules apply

number

The opacity of the active word where 1 is opaque and 0 is transparent. minimum: 0. maximum: 1. default: 1.

size

No; body and guard rules apply

number

The font size of the active word in pixels. minimum: 1. maximum: 500.

textDecoration

No; body and guard rules apply

string

Text decoration to apply to the active word. Values: none, underline, line-through. default: none.

Argument

Required

Type

Details

font

No; body and guard rules apply

RichCaptionActiveFont

Font properties for the active word.

stroke

No; body and guard rules apply

Union

Stroke properties for the active word. Set to "none" to explicitly remove the base stroke on the active word.

shadow

No; body and guard rules apply

Union

Shadow properties for the active word. Set to "none" to explicitly remove the base shadow on the active word.

Argument

Required

Type

Details

style

Yes

string

The animation style to apply to words: karaoke - Word-by-word color fill as spoken (shows all words, highlights active) highlight - Word changes to active color when spoken (shows all words) pop - Each word scales up when active fade - Gradual opacity transition per word slide - Words slide in from a direction bounce - Spring animation on word appearance typewriter - Words appear one by one and stay visible none - No animation, all words visible immediately Values: karaoke, highlight, pop, fade, slide, bounce, typewriter, none. default: highlight.

direction

No; body and guard rules apply

string

Direction for directional animations (slide). Only applicable when style is slide. Values: left, right, up, down. default: up.

Argument

Required

Type

Details

type

Yes

string

The type of asset to generate - set to text-to-image for text-to-image. Values: text-to-image. default: text-to-image.

prompt

Yes

string

The text prompt to generate an image from.

width

No; body and guard rules apply

integer

The width of the image in pixels.

height

No; body and guard rules apply

integer

The height of the image in pixels.

crop

No; body and guard rules apply

Crop

See the full input schema.

Argument

Required

Type

Details

type

Yes

string

The type of asset to generate - set to image-to-video for image-to-video. Values: image-to-video. default: image-to-video.

src

Yes

string

The image source URL. The URL must be publicly accessible or include credentials. minLength: 1.

prompt

No; body and guard rules apply

string

The instructions for modifying the image into a video sequence.

aspectRatio

No; body and guard rules apply

string

The aspect ratio (shape) of the video output. Values: 1:1, 4:3, 16:9, 9:16, 3:4, 21:9, 9:21.

speed

No; body and guard rules apply

number

Adjust the playback speed of the video clip between 0 (paused) and 10 (10x normal speed) where 1 is normal speed (defaults to 1). Adjusting the speed will also adjust the duration of the clip and may require you to adjust the Clip length. For example, if you set speed to 0.5, the clip will need to be 2x as long to play the entire video (i.e. original length / 0.5). If you set speed to 2, the clip will need to be half as long to play the entire video (i.e. original length / 2). minimum: 0. maximum: 10. format: float.

crop

No; body and guard rules apply

Crop

See the full input schema.

Argument

Required

Type

Details

type

Yes

string

The type of asset - set to text-to-speech for text-to-speech. Values: text-to-speech. default: text-to-speech.

text

Yes

string

The text to convert to speech.

voice

Yes

string

The voice to use for the text-to-speech conversion.

language

No; body and guard rules apply

string

The language code for the text-to-speech conversion.

newscaster

No; body and guard rules apply

boolean

Set the voice to newscaster mode. default: False.

trim

No; body and guard rules apply

number

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

No; body and guard rules apply

Union

Set the volume of the audio clip. Use a number or an array of Tween objects to create custom volume transitions.

speed

No; body and guard rules apply

number

Adjust the playback speed of the audio clip between 0 (paused) and 10 (10x normal speed), where 1 is normal speed (defaults to 1). Adjusting the speed will also adjust the duration of the clip and may require you to adjust the Clip length. minimum: 0. maximum: 10. format: float.

effect

No; body and guard rules apply

string

The effect to apply to the audio asset fadeIn - fade volume in only fadeOut - fade volume out only fadeInFadeOut - fade volume in and out Values: none, fadeIn, fadeOut, fadeInFadeOut.

Argument

Required

Type

Details

type

Yes

string

The type of asset - set to html for HTML. Values: html. default: html.

html

Yes

string

The HTML text string. See list of supported HTML tags.

css

No; body and guard rules apply

string

The CSS text string to apply styling to the HTML. See list of support CSS properties.

width

No; body and guard rules apply

integer

Set the width of the HTML asset bounding box in pixels. Text will wrap to fill the bounding box.

height

No; body and guard rules apply

integer

Set the width of the HTML asset bounding box in pixels. Text and elements will be masked if they exceed the height of the bounding box.

background

No; body and guard rules apply

string

Apply a background color behind the HTML bounding box using. Set the text color using hexadecimal color notation. Transparency is supported by setting the first two characters of the hex string (opposite to HTML), i.e. #80ffffff will be white with 50% transparency.

position

No; body and guard rules apply

string

Place the HTML in one of nine predefined positions within the HTML area. top - top (center) topRight - top right right - right (center) bottomRight - bottom right bottom - bottom (center) bottomLeft - bottom left left - left (center) topLeft - top left center - center Values: top, topRight, right, bottomRight, bottom, bottomLeft, left, topLeft, center.

Argument

Required

Type

Details

type

Yes

string

The type of asset - set to html5 for HTML5/CSS3/JS. Values: html5. default: html5.

html

Yes

string

The HTML markup for the asset. Max 1,000,000 characters. maxLength: 1000000.

css

No; body and guard rules apply

string

The CSS string applied to the HTML. Max 500,000 characters. maxLength: 500000.

js

No; body and guard rules apply

string

Optional JavaScript. Use for chart libraries, animations, or DOM manipulation. gsap, d3, anime and lottie are always available. CSS animations, transitions, and Element.animate() are also captured automatically. Max 500,000 characters. maxLength: 500000.

Argument

Required

Type

Details

type

Yes

string

The type of asset - set to title for titles. Values: title. default: title.

text

Yes

string

The title text string - i.e. "My Title".

style

No; body and guard rules apply

string

Uses a preset to apply font properties and styling to the title. minimal blockbuster vogue sketchy skinny chunk chunkLight marker future subtitle Values: minimal, blockbuster, vogue, sketchy, skinny, chunk, chunkLight, marker, future, subtitle.

color

No; body and guard rules apply

string

Set the text color using hexadecimal color notation. Transparency is supported by setting the first two characters of the hex string (opposite to HTML), i.e. #80ffffff will be white with 50% transparency.

size

No; body and guard rules apply

string

Set the relative size of the text using predefined sizes from xx-small to xx-large. xx-small x-small small medium large x-large xx-large Values: xx-small, x-small, small, medium, large, x-large, xx-large.

background

No; body and guard rules apply

string

Apply a background color behind the text. Set the text color using hexadecimal color notation. Transparency is supported by setting 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

No; body and guard rules apply

string

Place the title in one of nine predefined positions of the viewport. top - top (center) topRight - top right right - right (center) bottomRight - bottom right bottom - bottom (center) bottomLeft - bottom left left - left (center) topLeft - top left center - center Values: top, topRight, right, bottomRight, bottom, bottomLeft, left, topLeft, center.

offset

No; body and guard rules apply

Offset

Offset the location of the title relative to its position on the screen.

Argument

Required

Type

Details

type

Yes

string

The asset type - set to svg for SVG assets. Values: svg. default: svg.

src

Yes

string

Raw SVG markup string. The SVG must contain valid SVG elements. The shape, fill, stroke, dimensions and opacity are automatically extracted from the SVG content. minLength: 1. maxLength: 500000.

Argument

Required

Type

Details

in

No; body and guard rules apply

string

The transition in. Available transitions are: fade - fade in reveal - reveal from left to right wipeLeft - fade across screen to the left wipeRight - fade across screen to the right slideLeft - move slightly left and fade in slideRight - move slightly right and fade in slideUp - move slightly up and fade in slideDown - move slightly down and fade in carouselLeft - slide in from right to left carouselRight - slide in from left to right carouselUp - slide in from bottom to top carouselDown - slide in from top to bottom shuffleTopRight - rotate in from top right shuffleRightTop - rotate in from right top shuffleRightBottom - rotate in from right bottom shuffleBottomRight - rotate in from bottom right shuffleBottomLeft - rotate in from bottom left shuffleLeftBottom - rotate in from left bottom shuffleLeftTop - rotate in from left top shuffleTopLeft - rotate in from top left zoom - fast zoom in The transition speed can also be controlled by appending Fast or Slow to the transition, e.g. fadeFast or CarouselLeftSlow. Values: none, fade, fadeSlow, fadeFast, reveal, revealSlow, revealFast, wipeLeft, wipeLeftSlow, wipeLeftFast, wipeRight, wipeRightSlow, wipeRightFast, slideLeft, slideLeftSlow, slideLeftFast, slideRight, slideRightSlow, slideRightFast, slideUp, slideUpSlow, slideUpFast, slideDown, slideDownSlow, slideDownFast, carouselLeft, carouselLeftSlow, carouselLeftFast, carouselRight, carouselRightSlow, carouselRightFast, carouselUp, carouselUpSlow, carouselUpFast, carouselDown, carouselDownSlow, carouselDownFast, shuffleTopRight, shuffleTopRightSlow, shuffleTopRightFast, shuffleRightTop, shuffleRightTopSlow, shuffleRightTopFast, shuffleRightBottom, shuffleRightBottomSlow, shuffleRightBottomFast, shuffleBottomRight, shuffleBottomRightSlow, shuffleBottomRightFast, shuffleBottomLeft, shuffleBottomLeftSlow, shuffleBottomLeftFast, shuffleLeftBottom, shuffleLeftBottomSlow, shuffleLeftBottomFast, shuffleLeftTop, shuffleLeftTopSlow, shuffleLeftTopFast, shuffleTopLeft, shuffleTopLeftSlow, shuffleTopLeftFast, zoom.

out

No; body and guard rules apply

string

The transition out. Available transitions are: fade - fade out reveal - reveal from right to left wipeLeft - fade across screen to the left wipeRight - fade across screen to the right slideLeft - move slightly left and fade out slideRight - move slightly right and fade out slideUp - move slightly up and fade out slideDown - move slightly down and fade out carouselLeft - slide out from right to left carouselRight - slide out from left to right carouselUp - slide out from bottom to top carouselDown - slide out from top to bottom shuffleTopRight - rotate out from top right shuffleRightTop - rotate out from right top shuffleRightBottom - rotate out from right bottom shuffleBottomRight - rotate out from bottom right shuffleBottomLeft - rotate out from bottom left shuffleLeftBottom - rotate out from left bottom shuffleLeftTop - rotate out from left top shuffleTopLeft - rotate out from top left zoom - fast zoom out The transition speed can also be controlled by appending Fast or Slow to the transition, e.g. fadeFast or CarouselLeftSlow. Values: none, fade, fadeSlow, fadeFast, reveal, revealSlow, revealFast, wipeLeft, wipeLeftSlow, wipeLeftFast, wipeRight, wipeRightSlow, wipeRightFast, slideLeft, slideLeftSlow, slideLeftFast, slideRight, slideRightSlow, slideRightFast, slideUp, slideUpSlow, slideUpFast, slideDown, slideDownSlow, slideDownFast, carouselLeft, carouselLeftSlow, carouselLeftFast, carouselRight, carouselRightSlow, carouselRightFast, carouselUp, carouselUpSlow, carouselUpFast, carouselDown, carouselDownSlow, carouselDownFast, shuffleTopRight, shuffleTopRightSlow, shuffleTopRightFast, shuffleRightTop, shuffleRightTopSlow, shuffleRightTopFast, shuffleRightBottom, shuffleRightBottomSlow, shuffleRightBottomFast, shuffleBottomRight, shuffleBottomRightSlow, shuffleBottomRightFast, shuffleBottomLeft, shuffleBottomLeftSlow, shuffleBottomLeftFast, shuffleLeftBottom, shuffleLeftBottomSlow, shuffleLeftBottomFast, shuffleLeftTop, shuffleLeftTopSlow, shuffleLeftTopFast, shuffleTopLeft, shuffleTopLeftSlow, shuffleTopLeftFast, zoom.

Argument

Required

Type

Details

x

No; body and guard rules apply

Union

Offset an asset on the horizontal axis (left or right). Use a number or an array of Tween objects to create a custom animation.

y

No; body and guard rules apply

Union

Offset an asset on the vertical axis (up or down). Use a number or an array of Tween objects to create a custom animation.

Argument

Required

Type

Details

top

No; body and guard rules apply

number

Crop from the top of the asset minimum: 0. maximum: 1. format: float.

bottom

No; body and guard rules apply

number

Crop from the bottom of the asset minimum: 0. maximum: 1. format: float.

left

No; body and guard rules apply

number

Crop from the left of the asset minimum: 0. maximum: 1. format: float.

right

No; body and guard rules apply

number

Crop from the left of the asset minimum: 0. maximum: 1. format: float.

Argument

Required

Type

Details

rotate

No; body and guard rules apply

RotateTransformation

See the full input schema.

skew

No; body and guard rules apply

SkewTransformation

See the full input schema.

flip

No; body and guard rules apply

FlipTransformation

See the full input schema.

Argument

Required

Type

Details

angle

No; body and guard rules apply

Union

Rotate a clip by the specified angle in degrees. Use a number or an array of Tween objects to create a custom animation.

Argument

Required

Type

Details

x

No; body and guard rules apply

Union

Skew the clip along it's x axis.

y

No; body and guard rules apply

Union

Skew the clip along it's y axis.

Argument

Required

Type

Details

horizontal

No; body and guard rules apply

boolean

Flip a clip horizontally.

vertical

No; body and guard rules apply

boolean

Flip a clip vertically.

Argument

Required

Type

Details

family

No; body and guard rules apply

string

The font family name. This must be Family name embedded in the font, i.e. "Open Sans".

color

No; body and guard rules apply

string

The text color using hexadecimal color notation.

opacity

No; body and guard rules apply

number

The opacity of the text where 1 is opaque and 0 is transparent.

size

No; body and guard rules apply

integer

The size of the font in pixels (px).

weight

No; body and guard rules apply

integer

The weight of the font. 100 is lightest, 900 is heaviest (boldest).

lineHeight

No; body and guard rules apply

number

The line height of the font as a ratio of the font size.

Argument

Required

Type

Details

color

No; body and guard rules apply

string

The background color using hexadecimal color notation. pattern: ^#[A-Fa-f0-9]{6}$.

opacity

No; body and guard rules apply

number

The opacity of the background where 1 is opaque and 0 is transparent. minimum: 0. maximum: 1.

padding

No; body and guard rules apply

number

Padding inside the background box in pixels. minimum: 0. maximum: 100.

borderRadius

No; body and guard rules apply

number

The border radius of the background box in pixels for rounded corners. minimum: 0.

wrap

No; body and guard rules apply

boolean

Not supported on legacy text assets. Accepted here only so validators can emit a clear migration error pointing users to rich-text or rich-caption, which support background wrapping natively.

Argument

Required

Type

Details

horizontal

No; body and guard rules apply

string

The horizontal alignment of the text. Value must be one of: left center right Values: left, center, right.

vertical

No; body and guard rules apply

string

The vertical alignment of the text. Value must be one of: top center bottom Values: top, center, bottom.

Argument

Required

Type

Details

family

No; body and guard rules apply

string

The font family name. This must be the Family name embedded in the font, i.e. "Open Sans". default: Open Sans.

size

No; body and guard rules apply

integer

The size of the font in pixels (px). Must be between 1 and 500. minimum: 1. maximum: 500. default: 24.

weight

No; body and guard rules apply

JSON

The weight of the font. Can be a number (100-900) or a string ('normal', 'bold', etc.). 100 is lightest, 900 is heaviest (boldest). default: 400.

style

No; body and guard rules apply

string

The font style. Values: normal, italic. default: normal.

color

No; body and guard rules apply

string

The text color using hexadecimal color notation. pattern: ^#[A-Fa-f0-9]{6}$. default: #000000.

opacity

No; body and guard rules apply

number

The opacity of the text where 1 is opaque and 0 is transparent. minimum: 0. maximum: 1. default: 1.

background

No; body and guard rules apply

string

The background color behind the text using hexadecimal color notation. pattern: ^#[A-Fa-f0-9]{6}$.

stroke

No; body and guard rules apply

RichTextStroke

Text stroke (outline) properties.

Argument

Required

Type

Details

letterSpacing

No; body and guard rules apply

number

Additional spacing between letters in pixels. Can be negative for tighter spacing. default: 0.

wordSpacing

No; body and guard rules apply

number

Additional spacing between words in pixels. A value of 0 uses the font's natural space width. minimum: 0. default: 0.

lineHeight

No; body and guard rules apply

number

The line height as a multiplier of the font size. Must be between 0 and 10. minimum: 0. maximum: 10. default: 1.2.

textTransform

No; body and guard rules apply

string

Text transformation to apply. Values: none, uppercase, lowercase, capitalize. default: none.

textDecoration

No; body and guard rules apply

string

Text decoration to apply. Values: none, underline, line-through. default: none.

gradient

No; body and guard rules apply

RichTextGradient

Gradient fill for text instead of solid color.

Argument

Required

Type

Details

type

No; body and guard rules apply

string

The type of gradient. Values: linear, radial. default: linear.

angle

No; body and guard rules apply

number

The angle of the gradient in degrees (for linear gradients). Must be between 0 and 360. minimum: 0. maximum: 360. default: 0.

stops

Yes

array

Gradient color stops. Must have at least 2 stops. minItems: 2. Items: object.

Argument

Required

Type

Details

width

No; body and guard rules apply

number

The width of the stroke in pixels. Must be 0 or greater. minimum: 0. default: 0.

color

No; body and guard rules apply

string

The stroke color using hexadecimal color notation. pattern: ^#[A-Fa-f0-9]{6}$. default: #000000.

opacity

No; body and guard rules apply

number

The opacity of the stroke where 1 is opaque and 0 is transparent. minimum: 0. maximum: 1. default: 1.

Argument

Required

Type

Details

offsetX

No; body and guard rules apply

number

Horizontal offset of the shadow in pixels. Positive values move right, negative left. default: 0.

offsetY

No; body and guard rules apply

number

Vertical offset of the shadow in pixels. Positive values move down, negative up. default: 0.

blur

No; body and guard rules apply

number

The blur radius of the shadow in pixels. Must be 0 or greater. minimum: 0. default: 0.

color

No; body and guard rules apply

string

The shadow color using hexadecimal color notation. pattern: ^#[A-Fa-f0-9]{6}$. default: #000000.

opacity

No; body and guard rules apply

number

The opacity of the shadow where 1 is opaque and 0 is transparent. minimum: 0. maximum: 1. default: 0.5.

Argument

Required

Type

Details

color

No; body and guard rules apply

string

The background color using hexadecimal color notation. pattern: ^#[A-Fa-f0-9]{6}$.

opacity

No; body and guard rules apply

number

The opacity of the background where 1 is opaque and 0 is transparent. minimum: 0. maximum: 1. default: 1.

borderRadius

No; body and guard rules apply

number

The border radius of the background box in pixels. Must be 0 or greater. minimum: 0. default: 0.

wrap

No; body and guard rules apply

boolean

When true, the background pill shrinks to fit the rendered text bounding box plus the asset's padding (and stroke width, if present), producing a pill or badge effect. When false (default), the background fills the full asset content area. Available on rich-text and rich-caption assets only; not supported on legacy type: text. default: False.

padding

No; body and guard rules apply

integer

Inner padding in pixels between the wrap pill edge and the rendered text. Only takes effect when wrap: true. When omitted, the renderer applies a sensible default proportional to the font size (approximately 12% of the active page font size on rich-caption assets). Set to 0 for a pill that hugs the text exactly. Available on rich-text and rich-caption assets only. minimum: 0. maximum: 200.

Argument

Required

Type

Details

horizontal

No; body and guard rules apply

string

The horizontal alignment of the text. Values: left, center, right. default: center.

vertical

No; body and guard rules apply

string

The vertical alignment of the text within the bounding box. Values: top, middle, bottom. default: middle.

Argument

Required

Type

Details

preset

Yes

string

The animation preset to apply. Available presets: fadeIn - fadeIn in animation slideIn - slide in from a direction typewriter - typewriter effect ascend - ascend from a direction shift - shift in from a direction movingLetters - letters move in from a direction Values: fadeIn, slideIn, typewriter, ascend, shift, movingLetters.

duration

No; body and guard rules apply

number

Override animation duration in seconds. Must be between 0.1 and 30 seconds. minimum: 0.1. maximum: 30.

style

No; body and guard rules apply

string

Animation style - animate by character or by word. Only applicable for typewriter and shift animations. Values: character, word.

direction

No; body and guard rules apply

string

Direction for directional animations. Required for slideIn, ascend, shift, and movingLetters presets. ascend - supports: up, down shift - supports: left, right, up, down slideIn - supports: left, right, up, down movingLetters - supports: left, right, up, down Values: left, right, up, down.

Argument

Required

Type

Details

width

No; body and guard rules apply

number

The width of the border in pixels. Must be 0 or greater. minimum: 0. default: 0.

color

No; body and guard rules apply

string

The border color using hexadecimal color notation. pattern: ^#[A-Fa-f0-9]{6}$. default: #000000.

opacity

No; body and guard rules apply

number

The opacity of the border where 1 is opaque and 0 is transparent. minimum: 0. maximum: 1. default: 1.

radius

No; body and guard rules apply

number

The border radius in pixels for rounded corners. Must be 0 or greater. minimum: 0. default: 0.

Argument

Required

Type

Details

top

No; body and guard rules apply

number

Top padding in pixels. minimum: 0. default: 0.

right

No; body and guard rules apply

number

Right padding in pixels. minimum: 0. default: 0.

bottom

No; body and guard rules apply

number

Bottom padding in pixels. minimum: 0. default: 0.

left

No; body and guard rules apply

number

Left padding in pixels. minimum: 0. default: 0.

Argument

Required

Type

Details

family

No; body and guard rules apply

string

The font family name. This must be Family name embedded in the font, i.e. "Open Sans".

color

No; body and guard rules apply

string

The text color using hexadecimal color notation.

opacity

No; body and guard rules apply

number

The opacity of the text where 1 is opaque and 0 is transparent.

size

No; body and guard rules apply

integer

The size of the font in pixels (px).

lineHeight

No; body and guard rules apply

number

The line height of the font as a ratio of the font size.

stroke

No; body and guard rules apply

string

The stroke color of the font using hexadecimal color notation.

strokeWidth

No; body and guard rules apply

number

The width of the stroke in pixels.

Argument

Required

Type

Details

color

No; body and guard rules apply

string

The background color using hexadecimal color notation.

opacity

No; body and guard rules apply

number

The opacity of the background color.

padding

No; body and guard rules apply

integer

The padding inside the background box in pixels.

borderRadius

No; body and guard rules apply

integer

The border radius of the background box in pixels.

Argument

Required

Type

Details

top

No; body and guard rules apply

number

The margin above the text. Pushes captions down the screen.

left

No; body and guard rules apply

number

The margin to the left of the text. Pushes captions to the right.

right

No; body and guard rules apply

number

The margin to the right of the text. Pushes captions to the left.

Argument

Required

Type

Details

color

Yes

string

The chroma key color as a hex value. Use green (#00b140) for green screens or blue (#0000FF) for blue screens. Any valid hex color can be used as the key color. pattern: ^#[0-9a-fA-F]{6}$.

threshold

No; body and guard rules apply

integer

Pixels within this distance from the key color are eliminated by setting their alpha values to zero. minimum: 0. maximum: 250.

halo

No; body and guard rules apply

integer

Pixels within the halo distance from the threshold boundary are given an increasing alpha value based on their distance from the threshold. minimum: 0. maximum: 250.

Argument

Required

Type

Details

from

No; body and guard rules apply

JSON

The initial property value at the start of the animation.

to

No; body and guard rules apply

JSON

The final property value at the end of the animation.

start

No; body and guard rules apply

number

The time in seconds when the animation starts, relative to the clip, not the timeline.

length

No; body and guard rules apply

number

The duration of the animation in seconds.

interpolation

No; body and guard rules apply

string

The interpolation method to use for the animation. Available options are: linear - a linear interpolation between the start and end values. bezier - a bezier curve interpolation between the start and end values. constant - an interpolation where the property instantly jumps from the start to the end value, without any gradual transition. Values: linear, bezier, constant.

easing

No; body and guard rules apply

string

The easing function to use for the animation. Easing controls the rate of change of the animated value, allowing for more natural motion by speeding up or slowing down the animation at different points. Only applicable if interpolation is set to bezier. Values: ease, easeIn, easeOut, easeInOut, easeInQuad, easeInCubic, easeInQuart, easeInQuint, easeInSine, easeInExpo, easeInCirc, easeInBack, easeOutQuad, easeOutCubic, easeOutQuart, easeOutQuint, easeOutSine, easeOutExpo, easeOutCirc, easeOutBack, easeInOutQuad, easeInOutCubic, easeInOutQuart, easeInOutQuint, easeInOutSine, easeInOutExpo, easeInOutCirc, easeInOutBack.

Argument

Required

Type

Details

find

Yes

string

The string to find without delimiters.

replace

Yes

JSON

The replacement value. The replacement can be any valid JSON type - string, boolean, number, etc...

Argument

Required

Type

Details

format

Yes

string

The output format and type of media file to generate. mp4 - mp4 video file gif - animated gif jpg - jpg image file png - png image file bmp - bmp image file mp3 - mp3 audio file (audio only) Values: mp4, gif, mp3, jpg, png, bmp.

resolution

No; body and guard rules apply

string

The preset output resolution of the video or image. For custom sizes use the size property. Either resolution or size (with both width and height) must be specified for all formats except mp3. preview - 512px x 288px @ 15fps mobile - 640px x 360px @ 25fps sd - 1024px x 576px @ 25fps hd - 1280px x 720px @ 25fps 1080 - 1920px x 1080px @ 25fps 4k - 3840px x 2160px @ 25fps Values: preview, mobile, sd, hd, 1080, 4k.

aspectRatio

No; body and guard rules apply

string

The aspect ratio (shape) of the video or image. Useful for social media output formats. Options are: 16:9 (default) - regular landscape/horizontal aspect ratio 9:16 - vertical/portrait aspect ratio 1:1 - square aspect ratio 4:5 - short vertical/portrait aspect ratio 4:3 - legacy TV aspect ratio Values: 16:9, 9:16, 1:1, 4:5, 4:3.

size

No; body and guard rules apply

Size

See the full input schema.

fps

No; body and guard rules apply

number

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. 12 - 12fps 15 - 15fps 24 - 24fps 23.976 - 23.976fps 25 (default) - 25fps 29.97 - 29.97fps 30 - 30fps 48 - 48fps 50 - 50fps 59.94 - 59.94fps 60 - 60fps Values: 12, 15, 23.976, 24, 25, 29.97, 30, 48, 50, 59.94, 60.

scaleTo

No; body and guard rules apply

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. preview - 512px x 288px @ 15fps mobile - 640px x 360px @ 25fps sd - 1024px x 576px @25fps hd - 1280px x 720px @25fps 1080 - 1920px x 1080px @25fps Values: preview, mobile, sd, hd, 1080, 4k.

quality

No; body and guard rules apply

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. verylow - reduced quality, smallest file size low - slightly reduced quality, smaller file size medium (default) - optimized quality, render speeds and file size high - slightly increased quality, larger file size veryhigh - highest quality, largest file size Values: verylow, low, medium, high, veryhigh.

repeat

No; body and guard rules apply

boolean

Loop settings for gif files. Set to true to loop, false to play only once.

mute

No; body and guard rules apply

boolean

Mute the audio track of the output video. Set to true to mute, false to un-mute.

range

No; body and guard rules apply

Range

See the full input schema.

poster

No; body and guard rules apply

Poster

Generate a poster image from a specific point on the timeline.

thumbnail

No; body and guard rules apply

Thumbnail

Generate a thumbnail image from a specific point on the timeline.

destinations

No; body and guard rules apply

array

Specify the storage locations and hosting services to send rendered videos to. Items: Destinations.

Argument

Required

Type

Details

width

No; body and guard rules apply

integer

Set a custom width for the video or image file in pixels. Value must be divisible by 2. Maximum video width is 1920px, maximum image width is 4096px. minimum: 1. maximum: 4096.

height

No; body and guard rules apply

integer

Set a custom height for the video or image file in pixels. Value must be divisible by 2. Maximum video height is 1920px, maximum image height is 4096px. minimum: 1. maximum: 4096.

Argument

Required

Type

Details

start

No; body and guard rules apply

number

The point on the timeline, in seconds, to start the render from - i.e. start at second 3. minimum: 0. format: float.

length

No; body and guard rules apply

number

The length of the portion of the video or audio to render - i.e. render 6 seconds of the video. minimum: 0. format: float.

Argument

Required

Type

Details

capture

Yes

number

The point on the timeline in seconds to capture a single frame to use as the poster image.

Argument

Required

Type

Details

capture

Yes

number

The point on the timeline in seconds to capture a single frame to use as the thumbnail image.

scale

Yes

number

Scale the thumbnail size to a fraction of the viewport size - i.e. setting the scale to 0.5 will scale the thumbnail to half the size of the viewport. minimum: 0. maximum: 1.

Argument

Required

Type

Details

provider

Yes

string

The destination to send assets to - set to shotstack for Shotstack hosting and CDN. default: shotstack.

exclude

No; body and guard rules apply

boolean

Set to true to opt-out from the Shotstack hosting and CDN service. All files must be downloaded within 24 hours of rendering.

Argument

Required

Type

Details

provider

Yes

string

The destination to send video to - set to mux for Mux. default: mux.

options

No; body and guard rules apply

MuxDestinationOptions

Additional Mux configuration and features.

Argument

Required

Type

Details

playbackPolicy

No; body and guard rules apply

array

Sets the Mux playback_policy option. Value is an array of strings - use public, signed, or both. Items: string.

passthrough

No; body and guard rules apply

string

Sets the Mux passthrough option. Max 255 characters. maxLength: 255.

Argument

Required

Type

Details

provider

Yes

string

The destination to send assets to - set to s3 for S3. default: s3.

options

No; body and guard rules apply

S3DestinationOptions

Additional S3 configuration options.

Argument

Required

Type

Details

region

Yes

string

Choose the region to send the file to. Must be a valid AWS region string like us-east-1 or ap-southeast-2.

bucket

Yes

string

The bucket name to send files to. The bucket must exist in the AWS account before files can be sent.

prefix

No; body and guard rules apply

string

A prefix for the file being sent. This is typically a folder name, i.e. videos or customerId/videos.

filename

No; body and guard rules apply

string

Use your own filename instead of the default filenames generated by Shotstack. 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

No; body and guard rules apply

string

Sets the S3 Access Control List (acl) permissions. Default is private. Must use a valid S3 Canned ACL.

Argument

Required

Type

Details

provider

Yes

string

The destination to send assets to - set to google-cloud-storage for Google Cloud Storage. default: google-cloud-storage.

options

No; body and guard rules apply

GoogleCloudStorageDestinationOptions

Additional Google Cloud Storage configuration options.

Argument

Required

Type

Details

bucket

Yes

string

The bucket name to send files to. The bucket must exist in the Google Cloud Storage account before files can be sent.

prefix

No; body and guard rules apply

string

A prefix for the file being sent. This is typically a folder name, i.e. videos or customerId/videos.

filename

No; body and guard rules apply

string

Use your own filename instead of the default filenames generated by Shotstack. 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.

Argument

Required

Type

Details

provider

Yes

string

The destination to send assets to - set to google-drive for Google Drive. default: google-drive.

options

No; body and guard rules apply

GoogleDriveDestinationOptions

Additional Google Drive configuration and features. If omitted, files are saved to the root of My Drive using the default Shotstack filename.

Argument

Required

Type

Details

folderId

No; body and guard rules apply

string

The Google Drive folder ID where the asset will be stored. If omitted, the asset is saved to the root of My Drive. The folder ID can be retrieved from the URL when logged in to Google Drive, e.g. https://drive.google.com/drive/u/0/folders/1r-eTY6OLO8tzQRKwMyq-fIrQ_7AJEI6A.

filename

No; body and guard rules apply

string

Use your own filename instead of the default filenames generated by Shotstack. 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.

Argument

Required

Type

Details

provider

Yes

string

The destination to send video to - set to vimeo for Vimeo. default: vimeo.

options

No; body and guard rules apply

VimeoDestinationOptions

Additional Vimeo configuration and features.

Argument

Required

Type

Details

name

No; body and guard rules apply

string

A name or title for the video that will be displayed on the Vimeo website.

description

No; body and guard rules apply

string

A description of the video that will be displayed on the Vimeo website.

privacy

No; body and guard rules apply

VimeoDestinationPrivacyOptions

Options to control the visibility of videos and privacy features.

folderUri

No; body and guard rules apply

string

The Vimeo folder URI to upload the video to. The folder must already exist in your Vimeo account.

Argument

Required

Type

Details

view

No; body and guard rules apply

string

Set who can view the videos. Available options are: anybody - Anyone can view the video. nobody - Only the video owner can view the video. contacts - Only contacts can view the video. password - A password is required to view the video. unlisted - The video is not listed on Vimeo. Values: anybody, nobody, contacts, password, unlisted.

embed

No; body and guard rules apply

string

Set who can embed the video. Available options are: public - Anyone can embed the video. private - Only the video owner can embed the video. whitelist - Only whitelisted domains can embed the video. Values: public, private, whitelist.

comments

No; body and guard rules apply

string

Set who can comment on the video. Available options are: anybody - Anyone can comment on the video. nobody - Only the video owner can comment on the video. contacts - Only contacts can comment on the video. Values: anybody, nobody, contacts.

download

No; body and guard rules apply

boolean

Set whether the video can be downloaded.

add

No; body and guard rules apply

boolean

Set whether other users can add the video to their collections.

Argument

Required

Type

Details

timeline

Yes

Timeline

See the full input schema.

output

Yes

Output

See the full input schema.

merge

No; body and guard rules apply

array

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. Items: MergeField.

callback

No; body and guard rules apply

string

An 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. See webhooks for more details.

disk

No; body and guard rules apply

string

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. local - optimized for high speed rendering with up to 512MB storage mount - optimized for larger file sizes and longer videos with 5GB for source footage and 512MB for output render Values: local, mount.

instance

No; body and guard rules apply

string

The render instance type to use for processing the edit. s1 - standard instance (default) s2 - standard instance with more resources a1 - accelerated instance for faster rendering Values: s1, s2, a1. default: s1.

Argument

Required

Type

Details

type

Yes

string

The kind of asset to generate. Values: image, video, audio.

prompt

Yes

string

A description of the asset to generate. For text-to-speech models it is the text spoken. minLength: 1. maxLength: 4000. pattern: \S.

model

No; body and guard rules apply

string

The generation model. Defaults to nano-banana-2 for images, seedance-2.0-text-to-video for video and elevenlabs-multilingual-v2 for audio. GET /models lists the models for each type.

options

No; body and guard rules apply

object

Settings for the chosen model. GET /models lists the options each model accepts; omitted options use the model's defaults and unknown or invalid options are rejected. A starting image for video goes in startSrc (inputSrc on the original image-to-video models) and a speech voice in voice.

Argument

Required

Type

Details

renditions

No; body and guard rules apply

array

The output renditions and transformations that should be generated from the source file. Items: Rendition.

transcription

No; body and guard rules apply

Transcription

The transcription settings for the output file.

Argument

Required

Type

Details

format

No; body and guard rules apply

string

The output format to encode the file to. You can only encode a file to the same type, i.e. a video to a video or an image to an image. You can't encode a video as an image. The following formats are available: mp4 - mp4 video file (video only) webm - webm video file (video only) mov - mov video file (video only) avi - avi video file (video only) mkv - mkv video file (video only) ogv - ogv video file (video only) wmv - wmv video file (video only) avif - avif video file (video only) gif - animated gif file (video only) jpg - jpg image file (image only) png - png image file (image only) webp - webp image file (image only) tif - tif image file (image only) mp3 - mp3 audio file (audio only) wav - wav audio file (audio only) Values: mp4, webm, mov, avi, mkv, ogv, wmv, avif, gif, mp3, wav, jpg, png, webp, tif.

size

No; body and guard rules apply

Size

See the full input schema.

fit

No; body and guard rules apply

string

Set how the rendition should be scaled and cropped when using a size with an aspect ratio that is different from the source. Fit applies to both videos and images. crop (default) - scale the rendition to fill the output area while maintaining the aspect ratio. The rendition will be cropped if it exceeds the bounds of the output. cover - stretch the rendition to fill the output without maintaining the aspect ratio. contain - fit the entire rendition within the output while maintaining the original aspect ratio. Values: cover, contain, crop.

resolution

No; body and guard rules apply

JSON

The preset output resolution of the video or image. This is a convenience property that sets the width and height based on industry standard resolutions. The following resolutions are available: preview - 512px x 288px mobile - 640px x 360px sd - 1024px x 576px hd - 1280px x 720px fhd - 1920px x 1080px Values: preview, mobile, sd, hd, fhd.

quality

No; body and guard rules apply

integer

Adjust the visual quality of the video or image. The higher the value, the sharper the image quality but the larger file size and slower the encoding process. When specifying quality, the goal is to balance file size vs visual quality. Quality is a value between 1 and 100 where 1 is fully compressed with low image quality and 100 is close to lossless with high image quality and large file size. Sane values are between 50 and 75. Omitting the quality parameter will result in an asset optimised for encoding speed, file size and visual quality. minimum: 1. maximum: 100.

fps

No; body and guard rules apply

number

Change the frame rate of a video asset. 12 - 12fps 15 - 15fps 24 - 24fps 23.976 - 23.976fps 25 (default) - 25fps 29.97 - 29.97fps 30 - 30fps 48 - 48fps 50 - 50fps 59.94 - 59.94fps 60 - 60fps Values: 12, 15, 23.976, 24, 25, 29.97, 30, 48, 50, 59.94, 60.

speed

No; body and guard rules apply

Speed

See the full input schema.

keyframeInterval

No; body and guard rules apply

integer

The keyframe interval is useful to optimize playback, seeking and smoother scrubbing in browsers. The value sets the number of frames between a keyframe. The lower the number, the larger the file. Try a value between 10 and 25 for smooth scrubbing. minimum: 1. maximum: 300.

fixOffset

No; body and guard rules apply

boolean

Attempt to fix audio and video sync issues. This can occur when recording devices, such as smartphones and web cams use compression techniques like Variable Frame Rate (VFR) which can cause audio and video to go out of sync. This option will attempt to fix the sync issues.

fixRotation

No; body and guard rules apply

boolean

Automatically reset the rotation of the video based on the orientation metadata in the video file. This is useful for videos recorded on smartphones that have orientation metadata that may not work correctly with certain video editing software, including the Shotstack Edit API.

enhance

No; body and guard rules apply

object

Apply media processing enhancements to the rendition using a third party provider. Currently only Dolby.io audio enhancement is available.

filename

No; body and guard rules apply

string

A custom name for the generated rendition file. The file extension will be automatically added based on the format of the rendition. If no filename is provided, the rendition ID will be used.

Argument

Required

Type

Details

format

No; body and guard rules apply

string

The output format of the transcription file. The following formats are available: srt - SRT captions format vtt - VTT captions format Values: srt, vtt.

Argument

Required

Type

Details

speed

No; body and guard rules apply

number

Adjust the playback speed of the video clip between 0 (paused) and 10 (10x normal speed) where 1 is normal speed (defaults to 1). Set values less than 1 to slow down the playback speed, i.e. set speed to 0.5 to play back at half speed. Set values greater than 1 to speed up the playback speed, i.e. set speed to 2 to play back at double speed. minimum: 0. maximum: 10. format: float.

preservePitch

No; body and guard rules apply

boolean

Set whether to adjust the audio pitch or not. Set to false to make the audio sound higher or lower pitched. By default the pitch is preserved.

Argument

Required

Type

Details

audio

No; body and guard rules apply

AudioEnhancement

An audio enhancement that can be applied to the audio content of the rendition.

Argument

Required

Type

Details

provider

Yes

string

The enhancement provider to use - set to dolby for Dolby. default: dolby.

options

Yes

DolbyEnhancementOptions

Additional Dolby configuration and features.

Argument

Required

Type

Details

preset

Yes

string

The preset to use for the audio enhancement. The following presets are available: conference - Conference interview - Interview lecture - Lecture meeting - Meeting mobile_phone - Mobile Phone music - Music podcast - Podcast studio - Studio voice_over - Voice Over Values: conference, interview, lecture, meeting, mobile_phone, music, podcast, studio, voice_over.

Variable

Meaning

SHOTSTACK_API_KEY

Private x-api-key credential; single-account alternative

SHOTSTACK_TOKEN_FILE

Regular private token-only file, max 64 KB; overrides environment key

SHOTSTACK_ACCOUNTS

Private named JSON account array; takes precedence over single settings

SHOTSTACK_DEFAULT_ACCOUNT

Exact configured label; default first entry

SHOTSTACK_ENV

stage or v1; fallback for account entries, default v1