Cancel a video
cancel_videoCancel a video that has NOT started rendering: a draft, a video still queued (PENDING), or one whose failed render is waiting for an automatic retry. The video ends as FAILED "Cancelled" and is never rendered. Credits are charged only after a render succeeds, so normally nothing had been charged; if the ledger holds a charge for it, exactly that is refunded (idempotent, never twice) and refundedCredits says how much. A video that is already rendering, finished, or a clip made straight from a prompt is refused (CANNOT_CANCEL_STARTED) and left untouched. Requires the "video:create" scope.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"videoId": "<videoId>"
},
"name": "cancel_video"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| videoId | Yes |