Voice.retire

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

InputsCopy Anchor Link

OutputsCopy Anchor Link

EffectsCopy Anchor Link

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; Voice.retired 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

Runs at once when the speaker withdraws Consent. Deletes nothing in db.sb.

Emits

Voice.retired with { voice }

Performed by

Privacy Officer

Price

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

On each VenueCopy Anchor Link

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

What try doesCopy Anchor Link

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

Refuses whenCopy Anchor Link

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 waitsCopy Anchor Link

Returns in one response; nothing waits.

ExampleCopy Anchor Link

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

Retire my cloned voice; we record live from now on.

{
  "mode": "send",
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/action_Sd3kQ9vT2w",
    "operation": "Voice.retire",
    "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 byCopy Anchor Link

None.

RelatedCopy Anchor Link

• Video.draftWrites a Video’s timeline from your records, your Brand and a Template, with a draft mark on every frame.
• Video.finalizeLifts a Video’s draft mark once every claim it makes reads from a live record, so its cuts can publish.
• File.generateMakes an image, a clip, speech or music from a prompt and your reference Files, and records how it was made.
• File.editMakes a new File from one you have, by instruction, such as upscaling or animating a still; the original stays.
• Voice.cloneTrains a Voice on a real speaker’s recordings, after the speaker records consent in that same voice.