Skip to content

Voice.clone

Trains a Voice on a real speaker’s recordings, after the speaker records consent in that same voice.

Action class
None
Approval
Runs on its own
Emits
Voice.cloned
Price
Free
POST https://api.sb/{your-domain}/voices/clone

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

Inputs

NameTypeDefaultMeaning
speakerPersonRequiredThe person whose voice it is.
samplesFile[]RequiredRecordings of the speaker.
consentConsentRequiredThe speaker’s Consent, spoken in the voice being cloned.
scopestringRequiredWho may speak in it.

Outputs

FieldTypeWhat null means
voiceVoiceNever null: the Voice, training until the upstream finishes.

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

Refuses when the Consent is missing, withdrawn, or not spoken by the speaker. Moves the Voice to ready when training ends.

Emits

Voice.cloned with { voice }

Performed by

Content lead

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 Voice.cloned delivers the result.

You, to your agent
Clone my voice for the demo voiceovers, from the three recordings and my
recorded consent.
Response, in send mode
{
  "mode": "send",
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/action_Sd3kQ9vT2w",
    "operation": "Voice.clone",
    "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