Documentation Index Fetch the complete documentation index at: https://mintlify.com/elevenlabs/elevenlabs-python/llms.txt
Use this file to discover all available pages before exploring further.
Overview
The voices.get() method returns metadata about a specific voice, including its name, category, labels, samples, and other configuration details.
Method Signature
client.voices.get(
voice_id: str ,
with_settings: Optional[ bool ] = None ,
request_options: Optional[RequestOptions] = None
) -> Voice
Parameters
Returns
Voice object containing detailed metadata about the voice. The category of the voice. Possible values:
premade - Pre-made voice
cloned - Cloned voice
generated - Generated voice
professional - Professional voice
The description of the voice.
Labels associated with the voice. Common keys include:
language - The language of the voice
accent - The accent type
gender - The gender of the voice
age - The age range
The preview URL of the voice audio sample.
List of audio samples associated with the voice. Each sample includes:
sample_id - Unique identifier for the sample
file_name - Original filename
mime_type - MIME type of the audio
size_bytes - Size in bytes
hash - Hash of the sample
The current settings for the voice, including:
stability - Voice stability (0.0 to 1.0)
similarity_boost - Similarity enhancement (0.0 to 1.0)
style - Style exaggeration (0.0 to 1.0)
speed - Speech speed multiplier
use_speaker_boost - Whether speaker boost is enabled
Fine-tuning information for professional voice clones.
Information about voice sharing settings.
high_quality_base_model_ids
The base model IDs for high-quality voices.
verified_languages
List[VerifiedVoiceLanguageResponseModel]
The verified languages for the voice.
The IDs of collections this voice belongs to.
The safety controls applied to the voice.
voice_verification
VoiceVerificationResponse
Voice verification status and details.
The permission level on this voice resource.
Whether the current user is the owner of the voice.
Whether the voice is a legacy voice.
Whether the voice is a mixed voice.
Timestamp when the voice was marked as favorite (Unix time).
The creation time of the voice (Unix time).
Whether the voice is bookmarked by the current user. Only relevant for community (library-copied) voices.
The subscription tiers the voice is available for.
Examples
Basic Usage
Retrieve metadata for a specific voice:
from elevenlabs import ElevenLabs
client = ElevenLabs( api_key = "YOUR_API_KEY" )
voice = client.voices.get( voice_id = "21m00Tcm4TlvDq8ikWAM" )
print ( f "Voice: { voice.name } " )
print ( f "Category: { voice.category } " )
print ( f "Description: { voice.description } " )
Access Voice Labels
Retrieve and display voice labels:
from elevenlabs import ElevenLabs
client = ElevenLabs( api_key = "YOUR_API_KEY" )
voice = client.voices.get( voice_id = "21m00Tcm4TlvDq8ikWAM" )
if voice.labels:
print ( "Voice Labels:" )
for key, value in voice.labels.items():
print ( f " { key } : { value } " )
Check Voice Settings
Inspect the current settings for a voice:
from elevenlabs import ElevenLabs
client = ElevenLabs( api_key = "YOUR_API_KEY" )
voice = client.voices.get( voice_id = "21m00Tcm4TlvDq8ikWAM" )
if voice.settings:
print ( "Voice Settings:" )
print ( f " Stability: { voice.settings.stability } " )
print ( f " Similarity Boost: { voice.settings.similarity_boost } " )
print ( f " Style: { voice.settings.style } " )
print ( f " Speed: { voice.settings.speed } " )
print ( f " Speaker Boost: { voice.settings.use_speaker_boost } " )
List Voice Samples
Retrieve information about voice samples:
from elevenlabs import ElevenLabs
client = ElevenLabs( api_key = "YOUR_API_KEY" )
voice = client.voices.get( voice_id = "21m00Tcm4TlvDq8ikWAM" )
if voice.samples:
print ( f "Voice has { len (voice.samples) } samples:" )
for sample in voice.samples:
print ( f " - { sample.file_name } ( { sample.size_bytes } bytes)" )
Check Ownership
Verify if you own a voice:
from elevenlabs import ElevenLabs
client = ElevenLabs( api_key = "YOUR_API_KEY" )
voice = client.voices.get( voice_id = "21m00Tcm4TlvDq8ikWAM" )
if voice.is_owner:
print ( f "You own the voice: { voice.name } " )
else :
print ( f "This is a shared or default voice: { voice.name } " )
Async Usage
Retrieve voice metadata asynchronously:
import asyncio
from elevenlabs import AsyncElevenLabs
client = AsyncElevenLabs( api_key = "YOUR_API_KEY" )
async def main ():
voice = await client.voices.get( voice_id = "21m00Tcm4TlvDq8ikWAM" )
print ( f "Voice: { voice.name } " )
print ( f "Category: { voice.category } " )
asyncio.run(main())