Skip to content

Video.finalize

Lifts a Video’s draft mark once every claim it makes reads from a live record, so its cuts can publish.

Action class
None
Approval
Runs on its own
Emits
Video.finalized
Price
Free
POST https://api.sb/{your-domain}/videos/{video}/finalize

Its Inputs, Outputs, Effects and guards quote the hub’s Video.finalize; this page adds what each Venue honors, its limits and a worked call. It is one of the Verbs of Media.

Inputs

NameTypeDefaultMeaning
videoVideoRequiredThe rendered Video to finalize.

Outputs

FieldTypeWhat null means
videoVideoNever null: the Video, in status Final.

Effects

Action class

None: no approval rule names it, so it runs within its seat’s Permissions and Limits

Modes
  • try: Runs every check and returns the record as it would be; nothing is stored.
  • send: Returns a pending Action at once; Video.finalized fires when it is done.
  • do: Waits for the Action to finish and returns the record.
Idempotency

Only with a key: the same Idempotency-Key and input return the first Action, and the same key with other input returns 409.

Saved or shared

A Video with an unsettled claim keeps status Draft and cannot be published.

Emits

Video.finalized with { video }

Performed by

Whichever seat calls it

Price

Free on your own account: the platform charges nothing for the call.

On each Venue

It acts on your own records and reaches no Venue, so every account answers the same way.

What try does

Runs every check the call meets and returns the record as it would be; nothing is stored, sent or posted.

Refuses when

The hub sets no guard of its own on this call: it refuses only on the shared checks every write meets (a missing record, a Permission the seat lacks).

When it waits

Returns in one response; nothing waits.

Example

In send mode the call returns its pending Action at once, and Video.finalized delivers the result.

You, to your agent
Finalize the 30-second renewal-notice video; every number in it reads
from the Offer.
Response, in send mode
{
  "mode": "send",
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/action_Sd3kQ9vT2w",
    "operation": "Video.finalize",
    "status": "pending",
    "reason": "running"
  }
}

To retry, send the same Idempotency-Key: the retry returns the first answer for $0. A new key reads again.

Used by

None.