Skip to content

Commit 3b2baeb

Browse files
committed
docs: say when studio links are permanent
1 parent 831cf1a commit 3b2baeb

2 files changed

Lines changed: 4 additions & 2 deletions

File tree

‎README.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ shotstack status 01ja7-x8m2k-... --output json
8282

8383
### `shotstack studio <file>`
8484

85-
Opens a `shotstack.studio` URL that loads the Edit JSON in the browser-based editor. By default, posts the JSON to the share API and emits a short URL like `https://shotstack.studio/s/abc12345` — clean, shareable, expires in 30 days. Falls back to inline base64url encoding if the share API is unreachable.
85+
Opens a `shotstack.studio` URL that loads the Edit JSON in the browser-based editor. By default, posts the JSON to the share API and emits a short URL like `https://shotstack.studio/s/abc12345`. With an API key (`SHOTSTACK_API_KEY`, or the key saved for `--env`) the link is permanent; without one it lasts 30 days, and the command says so on stderr. A timeout, 429 or 5xx gets one retry, then the command falls back to inline base64url encoding and prints the cause. If the share API refuses the edit (too large, invalid, or an invalid key), the command exits 1 with the reason.
8686

8787
No render API key required; no render credits charged. Use to hand a generated edit off to a human for review or quick tweaks before rendering.
8888

@@ -93,6 +93,7 @@ shotstack studio my-template.json
9393
shotstack studio my-template.json --copy # also copies URL to clipboard
9494
shotstack studio my-template.json --no-open # print URL, don't open browser
9595
shotstack studio my-template.json --no-shorten # emit base64url inline (offline / debug)
96+
shotstack studio my-template.json --env stage # share with the saved stage key
9697
shotstack studio my-template.json --output json # emit {"url":"...","shortened":true} on stdout
9798
```
9899

‎skills/shotstack/SKILL.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,12 +129,13 @@ shotstack generate seedance-2.0-text-to-video "Waves break over black sand at du
129129
shotstack studio template.json # opens browser + prints short URL
130130
shotstack studio template.json --no-open # headless: just print the URL
131131
shotstack studio template.json --no-shorten # emit base64url URL inline (offline / debug)
132+
shotstack studio template.json --env stage # share with the saved stage key
132133
shotstack studio template.json --output json # piping: {"url":"...","shortened":true}, no browser
133134
```
134135

135136
On headless systems (no `xdg-open`, no `$DISPLAY`) the browser launch silently no-ops; the URL is still printed. Safe to run anywhere.
136137

137-
If the share API is unreachable, the command falls back to the inline base64url form automatically and prints a stderr warning. Shares expire after 30 days.
138+
**The short link is permanent when the CLI has an API key** (`SHOTSTACK_API_KEY`, or the key saved for `--env`/`SHOTSTACK_ENV`). Without one it lasts 30 days and the command says so on stderr; suggest `shotstack login` if the user wants links that last. A timeout, 429 or 5xx gets one retry, then the command falls back to the inline base64url form and prints the cause on stderr. If the share API refuses the edit (over 1 MB, missing `timeline` or `output`, or an invalid key), the command exits 1 with the reason: fix that, or use `--no-shorten`.
138139

139140
**Default to `studio` for anything non-trivial** — multi-scene, multi-track, or any creative an interested human will review. It previews client-side, costs nothing, and lets the human hit Render when it's right. Use `render` directly only for single-shot/simple edits, automated pipelines, or when told "just render it".
140141

0 commit comments

Comments
 (0)