voices
voices

Edit Voice

Changed on

Edit a voice created by you.

post/v1/voices/{voice_id}/edit

Request

  • Base URL
    https://api.elevenlabs.io (the document declares no server; this is the origin it was published from)
  • URL
    https://api.elevenlabs.io/v1/voices/{voice_id}/edit
  • Auth
    none declared

Path parameters

voice_idstring required

Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices.

Example:21m00Tcm4TlvDq8ikWAM

Headers

xi-api-keystring nullable

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Request body multipart/form-data

namestring required

The name that identifies this voice. This will be displayed in the dropdown of the website.

filesstring[]

Audio files to add to the voice

remove_background_noiseboolean

If set will remove background noise for voice samples using our audio isolation model. If the samples do not include background noise, it can make the quality worse.

descriptionstring nullable

A description of the voice.

moderate_metadataboolean

Run synchronous LLM moderation over the voice name and description when they change. Has no effect unless the voice_library_metadata_moderation feature flag is enabled for the user.

Example request

{
  "name": "John Smith",
  "remove_background_noise": true,
  "description": "An old American male voice with a slight hoarseness in his throat. Perfect for news."
}

Response

Successful Response

statusstring required

The status of the voice edit request. If the request was successful, the status will be 'ok'. Otherwise an error message with status 500 will be returned.

Example response

{
  "status": "ok"
}

Changes

  • 37fac3c5a2d7Revision changes
    • info

      added the new optional request property

  • 5b595807512cRevision changes
    • info

      api operation id Edit_voice_v1_voices__voice_id__edit_post removed and replaced with edit_voice

    • info

      request property list-of-types was widened by adding types object to media type multipart/form-data