---
title: "Update one of your voices"
method: PATCH
path: "/voices/{voiceId}"
---

# Update one of your voices

`PATCH /voices/{voiceId}`

## Request

- Base URL: `https://api.lazybird.app/v1`
- URL: `https://api.lazybird.app/v1/voices/{voiceId}`
- Auth: one of:
  - API key in header `X-API-Key`
  - API key in query parameter `api_key`

Changes the name, description, labels, language or avatar of one of your own voices. Send only the fields to change. Edits to a published voice show in the public library right away. For the avatar, upload an image as multipart `avatar`, or send a public `avatarUrl`; either way it is cropped to a 200×200 square.

## Path parameters

- `voiceId` string, required

## Request body

- UpdateVoiceRequest: Send only the fields to change
  - `name` string
  - `description` string
  - `labels` string[]: Replaces the voice's labels
  - `language` string: Primary locale such as `en-US` or `ja-JP`; an empty string clears it
  - `avatarUrl` string, uri: Public PNG, JPEG or WebP image URL

## Response `200`

The updated voice

- object
  - `voice` Voice
    - `id` string, required: Pass as `voiceId`. Treat as opaque.
    - `displayName` string, required
    - `description` string
    - `labels` string[]
    - `language` string: Primary locale, e.g. `en-US`
    - `secondaryLocaleList` string[]: Other locales the voice can speak via `settings.locale`
    - `gender` string
    - `styleList` string[]: Values accepted by `settings.style`
    - `previewText` string
    - `previewUrl` string, uri
    - `avatar` string
    - `scope` string: `global`, `community` or `user`
    - `published` boolean
    - `mine` boolean

## Other responses

- `400`: Invalid input
- `401`: Missing or invalid API key
- `422`: Plan limit reached (credits, voice slots or plan feature)
- `429`: Too many requests; retry after `Retry-After` seconds
- `500`: Server error

---

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