URL: /code/apps/media/retire · Id: `page:/code/apps/media/retire`

# Voice.retire

> Deletes a Voice’s trained copy and refuses new speech in it, keeping the record and every File it made.

POST https://api.sb/{your-domain}/voices/{voice}/retire

Deletes a [Voice](https://startupbuilder.dev/business/nouns/voice)’s trained copy and refuses new speech in it, keeping the record and every [File](https://startupbuilder.dev/business/nouns/file) it made.

- **Action class:** None
- **Approval:** Runs on its own
- **Emits:** `Voice.retired`
- **Price:** Free

```text title="Run it · Ask"
Retire my cloned voice; we record live from now on.
```

```ts title="Run it · SDK"
import { $ } from 'startup-builder'

const result = await $.try.Voice.retire({ voice: 'https://api.sb/leaseline.app/voices/voice_Do8kV3cE5f', reason: 'Recording live voiceovers from now on.' })
```

```json title="Run it · Response"
{
  "api": "https://api.sb/leaseline.app",
  "voice": {
    "$id": "https://api.sb/leaseline.app/voices/voice_Do8kV3cE5f",
    "$type": "Voice",
    "state": "retired"
  },
  "action": {
    "operation": "Voice.retire",
    "mode": "try",
    "status": "done"
  }
}
```

Its Inputs, Outputs, Effects and guards quote [the hub’s `Voice.retire`](https://startupbuilder.dev/business/nouns/voice/retire); this page adds what each Venue honors, its limits and a worked call. It is one of the [Verbs](https://startupbuilder.dev/business/nouns/verb) of [Media](/code/apps/media#verbs).

## Inputs
| Name | Type | Meaning |
| --- | --- | --- |
| `voice` | `Voice` | Required. The Voice to retire. |
| `reason` | `text` | Why, such as Consent withdrawn. Optional. |

## Outputs
| Field | Type | What `null` means |
| --- | --- | --- |
| `voice` | `Voice` | Never null: the Voice, now `retired`. |

## 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.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](https://startupbuilder.dev/agents/legal/privacy-officer)

**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.retired` delivers the result.

**Ask**

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

**API**

```bash
curl -X POST "https://api.sb/leaseline.app/voices/voice_Do8kV3cE5f/retire?mode=send" \
  -H "Authorization: Bearer $SB_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "reason": "Recording live voiceovers from now on."
}'
```

**CLI**

```bash
npx startup-builder do Voice.retire --send --data '{
  "reason": "Recording live voiceovers from now on."
}'
```

`--send` returns the pending Action at once.

**MCP**

```json
{
  "name": "do",
  "arguments": {
    "mode": "send",
    "code": "return await $.Voice.retire({ reason: 'Recording live voiceovers from now on.' })"
  }
}
```

**SDK**

```ts
import { $ } from 'startup-builder'

const result = await $.send.Voice.retire({
  voice: 'https://api.sb/leaseline.app/voices/voice_Do8kV3cE5f',
  reason: 'Recording live voiceovers from now on.',
})
```


```json title="Response, in send mode"
{
  "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 by
None.

## Related
[`Video.draft`](/code/apps/media/draft) · [`Video.finalize`](/code/apps/media/finalize) · [`File.generate`](/code/apps/media/generate) · [`File.edit`](/code/apps/media/edit) · [`Voice.clone`](/code/apps/media/clone)