Probably
Start free
Docs

Share a delivered video

share_video, in Changes: A connection or key that may make changes. None spends credits; prepare_* and stage tools (research, brainstorm, write_script, review, generate_clip, voice, storyboard) prepare paid work for confirm_spend.

POST
/api/v1/tools/share_video

A link to a delivered video, for anyone who has it or only for the people named (recipients, by email, who sign in to watch). Without versionId it follows the video's newest delivery; with one it stays on that version. Pass a new requestKey; repeating one returns the same link.

Authorization

apiKey
headerAuthorizationBearer <token>

An API key (prb_…) from Settings → Connections.

Request Body

application/json
  1. body
videoId*string
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid
versionId?string
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid
name?string
Length1 <= length <= 120
access?string
Default"anyone"
Value in"anyone""people"
recipients?array<>
Itemsitems <= 50
expiry?string
Default"week"
Value in"week""month""never"
requestKey*string
Match^[\w.:-]+$
Length8 <= length <= 64

Response Body

The tool's answer.

application/json
  1. response
shareId*string
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid
url*string
curl -X POST 'https://studio.probably.co/api/v1/tools/share_video' \  -H "Authorization: Bearer $PROBABLY_API_KEY" \  -H 'Content-Type: application/json' \  -d '{  "videoId": "3524e86f-1bba-489a-bf6b-386ea1abbac0",  "requestKey": "stringst"}'
{  "shareId": "6a9e781b-5ee2-4314-8665-1c09eed0443a",  "url": "string"}