Probably
Start free
Docs

Stop a video

stop_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/stop_video

Stop a video's run, named by runId (get_video's run): everything still to make is cancelled, and nothing more is spent on it. A clip or still a provider is already making can't be stopped: it's charged as it finishes, up to the credits alreadyBeingMade names, and kept in the video's files; one that fails is charged nothing. Pass a new requestKey; repeating one stops that run once, and never a newer one.

Authorization

apiKey
headerAuthorizationBearer <token>

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

Request Body

application/json
  1. body
videoId*string
Formatuuid
runId*string
Formatuuid
requestKey*string
Match^[\w.:-]+$
Length8 <= length <= 64

Response Body

The tool's answer.

application/json
  1. response
runId*string
Formatuuid
status*string
Value in"received""pending""applied""rejected""withdrawn"
alreadyBeingMade*|null
curl -X POST 'https://probably.co/api/v1/tools/stop_video' \  -H "Authorization: Bearer $PROBABLY_API_KEY" \  -H 'Content-Type: application/json' \  -d '{  "videoId": "3524e86f-1bba-489a-bf6b-386ea1abbac0",  "runId": "78c33d18-170c-44d3-a227-b3194f134f73",  "requestKey": "stringst"}'
{  "runId": "78c33d18-170c-44d3-a227-b3194f134f73",  "status": "received",  "alreadyBeingMade": {    "clips": 0,    "stills": 0,    "mostCredits": 0  }}