---
title: "Keep a voice"
method: PUT
path: "/v1/collections/{id}/voice"
tags: ["Voice"]
deprecated: true
---

# Keep a voice

`PUT /v1/collections/{id}/voice`

## Request

- Base URL: `https://api.masko.ai`
- URL: `https://api.masko.ai/v1/collections/{id}/voice`
- Auth: HTTP bearer

> **Deprecated.**

Keeps one sample from POST /v1/collections/{id}/voice/samples as the voice of the mascot. It replaces the voice it had. Samples can be kept for 24 hours. No credit cost.

## Path parameters

- `id` string, uuid, required

## Request body

- KeepVoiceBody
  - `sample_id` string, uuid, required: A sample from POST .../voice/samples.
  - `name` string: Defaults to "<name>'s voice".

## Response `200`

The kept voice

- object
  - `data` Voice, nullable, required
    - `object` 'voice', required
    - `name` string, required
    - `description` string, required: The words the voice was designed from.
    - `sample_url` string, uri, nullable, required: A short recording of the voice. Signed; fetch the voice again for a fresh link.
    - `source` 'original' | 'variant' | 'creator', required: Whose voice this is: the mascot's own (original), the variant's own (variant), or the marketplace creator's (creator).
    - `created_at` string, required

## Other responses

- `400`: Invalid request
- `401`: Authentication required
- `403`: The key lacks permission, or the voice belongs to the Marketplace creator
- `404`: Mascot, variant or sample not found
- `409`: The variant is not approved yet, or the sample expired
- `429`: Too many voice requests; retry later
- `502`: Masko could not write the ideas or the adjustment; retry
- `503`: The voice service is unavailable; retry later

---

[API](https://skmtc.dev/masko/apis/masko-api.md) · [All operations](https://skmtc.dev/masko/apis/masko-api/llms.txt) · [OpenAPI document](https://skmtc.dev/masko/apis/masko-api/revisions/84832e255613?raw)