---
title: "Remove every library voice that can no longer speak."
method: DELETE
path: "/voices/retired"
tags: ["Voices"]
---

# Remove every library voice that can no longer speak.

`DELETE /voices/retired`

## Request

- Base URL: `https://docs.sleeperhit.studio/api/v1`
- URL: `https://docs.sleeperhit.studio/api/v1/voices/retired`
- Auth: HTTP bearer

A voice whose provider retired it can never speak again. TWO CALLS, free: without `confirmed` it answers `applied: false` with every such voice and where it is still named (`uses`) and changes nothing; with `confirmed: true` (`?confirmed=true`) it removes them all. Each cast canon person pinned to one is unpinned, so the next read casts them a voice that speaks; a read keeps the recording it has. Scope: `story:write`.

## Query parameters

- `confirmed` boolean

## Response `200`

The retired voices, removed or (without `confirmed`) listed.

- RetiredVoicesRemovalResponse: Every library voice whose provider retired it, with where each is still named. `applied: false` changed nothing; `applied: true` removed them. Free (`credits` is 0).
  - `applied` boolean, required
  - `voices` object[], required
    - `voiceId` string, required
    - `name` string, required
    - `uses` VoiceUses, required
      - `canon` object[], required
        - `projectId` string, required
        - `projectName` string, required
        - `character` string, required
      - `reads` object[], required
        - `jobId` string, required
        - `artifactId` string, nullable, required
        - `characters` string[], required
  - `credits` 0, required
  - `note` string, required

## Other responses

- `401`: Missing, malformed, revoked, or expired API key.
- `403`: API key is valid but lacks the scope, is blocked by IP allowlist, or the account is disabled.
- `429`: Rate limit for this API key + IP + route family was exceeded.
- `500`: The API failed unexpectedly. Safe to retry with the same Idempotency-Key.

---

[API](https://skmtc.dev/sleeperhit/apis/sleeper-hit-studio-story-api.md) · [All operations](https://skmtc.dev/sleeperhit/apis/sleeper-hit-studio-story-api/llms.txt) · [OpenAPI document](https://skmtc.dev/sleeperhit/apis/sleeper-hit-studio-story-api/revisions/4534f5d25540?raw)