# Update a voice

`PATCH https://api.vidmoat.com/v1/speech/voices/{id}`

- Scope: `speech.voices.write`
- Cost: Free

Rename a voice or update its description.

### Path parameters

- `id` (string, required): A voice or generation ID belonging to the credential owner.

### Body

- `name` (string, required): 1 to 60 characters.
- `description` (string, optional): Up to 300 characters.

## Response

Returns `200`.

## Errors

Besides the errors any request can get ([authentication](https://developer.vidmoat.com/developer/docs/authentication#when-a-request-is-refused), [rate limits](https://developer.vidmoat.com/developer/docs/rate-limits)):

| Status | Code | When |
| --- | --- | --- |
| 409 | [`conflict`](https://developer.vidmoat.com/developer/docs/errors#conflict) | The idempotency key belongs to different inputs, or the job is not in the required state. |
| 503 | [`unavailable`](https://developer.vidmoat.com/developer/docs/errors#unavailable) | Inference, private storage, configured pilot billing or the limiter is unavailable. Nothing new is charged before admission. |

## Request examples

```bash curl
curl --fail-with-body -X PATCH "https://api.vidmoat.com/v1/speech/voices/$ID" -H "Authorization: Bearer $VIDMOAT_KEY" -H "Content-Type: application/json" -d '{"name":"My narration voice"}'
```

```js Node
const ID = 'YOUR_PROJECT_ID';

const res = await fetch(`https://api.vidmoat.com/v1/speech/voices/${ID}`, {
  method: 'PATCH',
  headers: {
    Authorization: `Bearer ${process.env.VIDMOAT_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    name: 'My narration voice',
  }),
});
const data = await res.json();
if (!res.ok) throw new Error(data.error?.message ?? `HTTP ${res.status}`);
console.log(data);
```

```python Python
import os
import requests

ID = "YOUR_PROJECT_ID"

res = requests.patch(
    f"https://api.vidmoat.com/v1/speech/voices/{ID}",
    headers={"Authorization": f"Bearer {os.environ['VIDMOAT_KEY']}"},
    json={
      "name": "My narration voice",
    },
    timeout=60,
)
res.raise_for_status()
print(res.json())
```

---

Source: https://developer.vidmoat.com/developer/docs/api/speech/update-voice
Previous: [Get a personal voice](https://developer.vidmoat.com/developer/docs/api/speech/get-voice.md)
Next: [Delete a voice](https://developer.vidmoat.com/developer/docs/api/speech/delete-voice.md)
All documentation: https://developer.vidmoat.com/llms-full.txt