Skip to main content
Server path: /elevenlabs-voices | Type: Application | PCID required: Yes

Tools


elevenlabs_voices_add_sharing_voice

Add Shared Voice Parameters:
ParameterTypeRequiredDefaultDescription
public_user_idstringYesPublic user ID used to publicly identify ElevenLabs users.
voice_idstringYesVoice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices.
bookmarkedbooleanNoThe bookmarked value
new_namestringYesThe name that identifies this voice. This will be displayed in the dropdown of the website.

elevenlabs_voices_add_voice

Add Voice Parameters:
ParameterTypeRequiredDefaultDescription
descriptionobjectNoA description of the voice.
filesany[]YesA list of file paths to audio recordings intended for voice cloning.
labelsobjectNoLabels for the voice. Keys can be language, accent, gender, or age.
namestringYesThe name that identifies this voice. This will be displayed in the dropdown of the website.
remove_background_noisebooleanNoIf 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.

elevenlabs_voices_create_voice

Create A New Voice From Voice Preview Parameters:
ParameterTypeRequiredDefaultDescription
generated_voice_idstringYesThe generated_voice_id to create, call POST /v1/text-to-voice/create-previews and fetch the generated_voice_id from the response header if don’t have one yet.
labelsobjectNoOptional, metadata to add to the created voice. Defaults to None.
played_not_selected_voice_idsobjectNoList of voice ids that the user has played but not selected. Used for RLHF.
voice_descriptionstringYesDescription to use for the created voice.
voice_namestringYesName to use for the created voice.

elevenlabs_voices_delete_sample

Delete Sample Parameters:
ParameterTypeRequiredDefaultDescription
voice_idstringYesVoice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices.
sample_idstringYesSample ID to be used, you can use GET https://api.elevenlabs.io/v1/voices/{voice_id} to list all the available samples for a voice.

elevenlabs_voices_delete_voice

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

elevenlabs_voices_edit_voice

Edit Voice Parameters:
ParameterTypeRequiredDefaultDescription
voice_idstringYesVoice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices.
descriptionobjectNoA description of the voice.
filesany[]NoAudio files to add to the voice
labelsobjectNoLabels for the voice. Keys can be language, accent, gender, or age.
namestringYesThe name that identifies this voice. This will be displayed in the dropdown of the website.
remove_background_noisebooleanNoIf 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.

elevenlabs_voices_edit_voice_settings

Edit Voice Settings Parameters:
ParameterTypeRequiredDefaultDescription
voice_idstringYesVoice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices.
similarity_boostobjectNoDetermines how closely the AI should adhere to the original voice when attempting to replicate it.
speedobjectNoAdjusts the speed of the voice. A value of 1.0 is the default speed, while values less than 1.0 slow down the speech, and values greater than 1.0 speed it up.
stabilityobjectNoDetermines how stable the voice is and the randomness between each generation. Lower values introduce broader emotional range for the voice. Higher values can result in a monotonous voice with limited emotion.
styleobjectNoDetermines the style exaggeration of the voice. This setting attempts to amplify the style of the original speaker. It does consume additional computational resources and might increase latency if set to anything other than 0.
use_speaker_boostobjectNoThis setting boosts the similarity to the original speaker. Using this setting requires a slightly higher computational load, which in turn increases latency.

elevenlabs_voices_get_audio_from_sample

Get Audio From Sample Parameters:
ParameterTypeRequiredDefaultDescription
voice_idstringYesVoice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices.
sample_idstringYesSample ID to be used, you can use GET https://api.elevenlabs.io/v1/voices/{voice_id} to list all the available samples for a voice.

elevenlabs_voices_get_library_voices

Get Voices Parameters:
ParameterTypeRequiredDefaultDescription
page_sizeintegerNoHow many shared voices to return at maximum. Can not exceed 100, defaults to 30.
categoryobjectNoVoice category used for filtering
genderobjectNoGender used for filtering
ageobjectNoAge used for filtering
accentobjectNoAccent used for filtering
languageobjectNoLanguage used for filtering
localeobjectNoLocale used for filtering
searchobjectNoSearch term used for filtering
use_casesobjectNoUse-case used for filtering
descriptivesobjectNoSearch term used for filtering
featuredbooleanNoFilter featured voices
min_notice_period_daysobjectNoFilter voices with a minimum notice period of the given number of days.
include_custom_ratesobjectNoInclude/exclude voices with custom rates
include_live_moderatedobjectNoInclude/exclude voices that are live moderated
reader_app_enabledbooleanNoFilter voices that are enabled for the reader app
owner_idobjectNoFilter voices by public owner ID
sortobjectNoSort criteria
pageintegerNoPage number for pagination

elevenlabs_voices_get_models

Get Models

elevenlabs_voices_get_similar_library_voices

Get Similar Library Voices Parameters:
ParameterTypeRequiredDefaultDescription
audio_filestringNoAudio File
similarity_thresholdobjectNoThreshold for voice similarity between provided sample and library voices. Values range from 0 to 2. The smaller the value the more similar voices will be returned.
top_kobjectNoNumber of most similar voices to return. If similarity_threshold is provided, less than this number of voices may be returned. Values range from 1 to 100.

elevenlabs_voices_get_user_info

Get User Info

elevenlabs_voices_get_user_subscription_info

Get User Subscription Info

elevenlabs_voices_get_user_voices_v2

Get Voices V2 Parameters:
ParameterTypeRequiredDefaultDescription
next_page_tokenobjectNoThe next page token to use for pagination. Returned from the previous request. Use this in combination with the has_more flag for reliable pagination.
page_sizeintegerNoHow many voices to return at maximum. Can not exceed 100, defaults to 10. Page 0 may include more voices due to default voices being included.
searchobjectNoSearch term to filter voices by. Searches in name, description, labels, category.
sortobjectNoWhich field to sort by, one of ‘created_at_unix’ or ‘name’. ‘created_at_unix’ may not be available for older voices.
sort_directionobjectNoWhich direction to sort the voices in. ‘asc’ or ‘desc’.
voice_typeobjectNoType of the voice to filter by. One of ‘personal’, ‘community’, ‘default’, ‘workspace’, ‘non-default’, ‘saved’. ‘non-default’ is equal to all but ‘default’. ‘saved’ is equal to non-default, but includes default voices if they have been added to a collection.
categoryobjectNoCategory of the voice to filter by. One of ‘premade’, ‘cloned’, ‘generated’, ‘professional’
fine_tuning_stateobjectNoState of the voice’s fine tuning to filter by. Applicable only to professional voices clones. One of ‘draft’, ‘not_verified’, ‘not_started’, ‘queued’, ‘fine_tuning’, ‘fine_tuned’, ‘failed’, ‘delayed’
collection_idobjectNoCollection ID to filter voices by.
include_total_countbooleanNoWhether to include the total count of voices found in the response. NOTE: The total_count value is a live snapshot and may change between requests as users create, modify, or delete voices. For pagination, rely on the has_more flag instead. Only enable this when you actually need the total count (e.g., for display purposes), as it incurs a performance cost.
voice_idsobjectNoVoice IDs to lookup by. Maximum 100 voice IDs.

elevenlabs_voices_get_voice_by_id

Get Voice Parameters:
ParameterTypeRequiredDefaultDescription
voice_idstringYesVoice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices.
with_settingsbooleanNoThis parameter is now deprecated. It is ignored and will be removed in a future version.

elevenlabs_voices_get_voice_settings

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

elevenlabs_voices_get_voice_settings_default

Get Default Voice Settings.

elevenlabs_voices_get_voices

List Voices Parameters:
ParameterTypeRequiredDefaultDescription
show_legacyobjectNoIf set to true, legacy premade voices will be included in responses from /v1/voices

elevenlabs_voices_text_to_voice

Generate A Voice Preview From Description Parameters:
ParameterTypeRequiredDefaultDescription
output_formatstringNoOutput format of the generated audio. Formatted as codec_sample_rate_bitrate. So an mp3 with 22.05kHz sample rate at 32kbs is represented as mp3_22050_32. MP3 with 192kbps bitrate requires you to be subscribed to Creator tier or above. PCM with 44.1kHz sample rate requires you to be subscribed to Pro tier or above. Note that the μ-law format (sometimes written mu-law, often approximated as u-law) is commonly used for Twilio audio inputs.
auto_generate_textbooleanNoWhether to automatically generate a text suitable for the voice description.
guidance_scalenumberNoControls how closely the AI follows the prompt. Lower numbers give the AI more freedom to be creative, while higher numbers force it to stick more to the prompt. High numbers can cause voice to sound artificial or robotic. We recommend to use longer, more detailed prompts at lower Guidance Scale.
loudnessnumberNoControls the volume level of the generated voice. -1 is quietest, 1 is loudest, 0 corresponds to roughly -24 LUFS.
qualitynumberNoHigher quality results in better voice output but less variety.
seedobjectNoRandom number that controls the voice generation. Same seed with same inputs produces same voice.
should_enhancebooleanNoWhether to enhance the voice description using AI to add more detail and improve voice generation quality. When enabled, the system will automatically expand simple prompts into more detailed voice descriptions. Defaults to False
textobjectNoText to generate, text length has to be between 100 and 1000.
voice_descriptionstringYesDescription to use for the created voice.

elevenlabs_voices_text_to_voice_design

Design A Voice. Parameters:
ParameterTypeRequiredDefaultDescription
output_formatstringNoOutput format of the generated audio. Formatted as codec_sample_rate_bitrate. So an mp3 with 22.05kHz sample rate at 32kbs is represented as mp3_22050_32. MP3 with 192kbps bitrate requires you to be subscribed to Creator tier or above. PCM with 44.1kHz sample rate requires you to be subscribed to Pro tier or above. Note that the μ-law format (sometimes written mu-law, often approximated as u-law) is commonly used for Twilio audio inputs.
auto_generate_textbooleanNoWhether to automatically generate a text suitable for the voice description.
guidance_scalenumberNoControls how closely the AI follows the prompt. Lower numbers give the AI more freedom to be creative, while higher numbers force it to stick more to the prompt. High numbers can cause voice to sound artificial or robotic. We recommend to use longer, more detailed prompts at lower Guidance Scale.
loudnessnumberNoControls the volume level of the generated voice. -1 is quietest, 1 is loudest, 0 corresponds to roughly -24 LUFS.
model_idstringNoModel to use for the voice generation. Possible values: eleven_multilingual_ttv_v2, eleven_ttv_v3.
prompt_strengthobjectNoControls the balance of prompt versus reference audio when generating voice samples. 0 means almost no prompt influence, 1 means almost no reference audio influence. Only supported when using the eleven_ttv_v3 model.
qualityobjectNoHigher quality results in better voice output but less variety.
reference_audio_base64objectNoReference audio to use for the voice generation. The audio should be base64 encoded. Only supported when using the eleven_ttv_v3 model.
remixing_session_idobjectNoThe remixing session id.
remixing_session_iteration_idobjectNoThe id of the remixing session iteration where these generations should be attached to. If not provided, a new iteration will be created.
seedobjectNoRandom number that controls the voice generation. Same seed with same inputs produces same voice.
should_enhancebooleanNoWhether to enhance the voice description using AI to add more detail and improve voice generation quality. When enabled, the system will automatically expand simple prompts into more detailed voice descriptions. Defaults to False
stream_previewsbooleanNoDetermines whether the Text to Voice previews should be included in the response. If true, only the generated IDs will be returned which can then be streamed via the /v1/text-to-voice/:generated_voice_id/stream endpoint.
textobjectNoText to generate, text length has to be between 100 and 1000.
voice_descriptionstringYesDescription to use for the created voice.

elevenlabs_voices_text_to_voice_preview_stream

Text To Voice Preview Streaming Parameters:
ParameterTypeRequiredDefaultDescription
generated_voice_idstringYesThe generated_voice_id to stream.

elevenlabs_voices_text_to_voice_remix

Remix A Voice. Parameters:
ParameterTypeRequiredDefaultDescription
voice_idstringYesVoice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices.
output_formatstringNoOutput format of the generated audio. Formatted as codec_sample_rate_bitrate. So an mp3 with 22.05kHz sample rate at 32kbs is represented as mp3_22050_32. MP3 with 192kbps bitrate requires you to be subscribed to Creator tier or above. PCM with 44.1kHz sample rate requires you to be subscribed to Pro tier or above. Note that the μ-law format (sometimes written mu-law, often approximated as u-law) is commonly used for Twilio audio inputs.
auto_generate_textbooleanNoWhether to automatically generate a text suitable for the voice description.
guidance_scalenumberNoControls how closely the AI follows the prompt. Lower numbers give the AI more freedom to be creative, while higher numbers force it to stick more to the prompt. High numbers can cause voice to sound artificial or robotic. We recommend to use longer, more detailed prompts at lower Guidance Scale.
loudnessnumberNoControls the volume level of the generated voice. -1 is quietest, 1 is loudest, 0 corresponds to roughly -24 LUFS.
prompt_strengthobjectNoControls the balance of prompt versus reference audio when generating voice samples. 0 means almost no prompt influence, 1 means almost no reference audio influence. Only supported when using the eleven_ttv_v3 model.
remixing_session_idobjectNoThe remixing session id.
remixing_session_iteration_idobjectNoThe id of the remixing session iteration where these generations should be attached to. If not provided, a new iteration will be created.
seedobjectNoRandom number that controls the voice generation. Same seed with same inputs produces same voice.
stream_previewsbooleanNoDetermines whether the Text to Voice previews should be included in the response. If true, only the generated IDs will be returned which can then be streamed via the /v1/text-to-voice/:generated_voice_id/stream endpoint.
textobjectNoText to generate, text length has to be between 100 and 1000.
voice_descriptionstringYesDescription of the changes to make to the voice.