Get Voice

Returns metadata about a specific voice.

GET /v1/voices/{voice_id}

Try it

Get Voice

cURL

curl --request GET \
  --url https://api.elevenlabs.io/v1/voices/{voice_id}

200

{
  "voice_id": "<string>",
  "name": "<string>",
  "samples": [
    {
      "sample_id": "<string>",
      "file_name": "<string>",
      "mime_type": "<string>",
      "size_bytes": 123,
      "hash": "<string>"
    }
  ],
  "category": "<string>",
  "fine_tuning": {
    "is_allowed_to_fine_tune": true,
    "state": {},
    "verification_failures": [
      "<string>"
    ],
    "verification_attempts_count": 123,
    "manual_verification_requested": true,
    "language": "<string>",
    "progress": {},
    "message": {},
    "dataset_duration_seconds": 123,
    "verification_attempts": [
      {
        "text": "<string>",
        "date_unix": 123,
        "accepted": true,
        "similarity": 123,
        "levenshtein_distance": 123,
        "recording": {
          "recording_id": "<string>",
          "mime_type": "<string>",
          "size_bytes": 123,
          "upload_date_unix": 123,
          "transcription": "<string>"
        }
      }
    ],
    "slice_ids": [
      "<string>"
    ],
    "manual_verification": {
      "extra_text": "<string>",
      "request_time_unix": 123,
      "files": [
        {
          "file_id": "<string>",
          "file_name": "<string>",
          "mime_type": "<string>",
          "size_bytes": 123,
          "upload_date_unix": 123
        }
      ]
    }
  },
  "labels": {},
  "description": "<string>",
  "preview_url": "<string>",
  "available_for_tiers": [
    "<string>"
  ],
  "settings": {
    "stability": 123,
    "similarity_boost": 123,
    "style": 0,
    "use_speaker_boost": true
  },
  "sharing": {
    "status": "enabled",
    "history_item_sample_id": "<string>",
    "date_unix": 123,
    "whitelisted_emails": [
      "<string>"
    ],
    "public_owner_id": "<string>",
    "original_voice_id": "<string>",
    "financial_rewards_enabled": true,
    "free_users_allowed": true,
    "live_moderation_enabled": true,
    "rate": 123,
    "notice_period": 123,
    "disable_at_unix": 123,
    "voice_mixing_allowed": true,
    "featured": true,
    "category": "generated",
    "reader_app_enabled": true,
    "image_url": "<string>",
    "ban_reason": "<string>",
    "liked_by_count": 123,
    "cloned_by_count": 123,
    "name": "<string>",
    "description": "<string>",
    "labels": {},
    "review_status": "not_requested",
    "review_message": "<string>",
    "enabled_in_library": true,
    "instagram_username": "<string>",
    "twitter_username": "<string>",
    "youtube_username": "<string>",
    "tiktok_username": "<string>"
  },
  "high_quality_base_model_ids": [
    "<string>"
  ],
  "safety_control": "NONE",
  "voice_verification": {
    "requires_verification": true,
    "is_verified": true,
    "verification_failures": [
      "<string>"
    ],
    "verification_attempts_count": 123,
    "language": "<string>",
    "verification_attempts": [
      {
        "text": "<string>",
        "date_unix": 123,
        "accepted": true,
        "similarity": 123,
        "levenshtein_distance": 123,
        "recording": {
          "recording_id": "<string>",
          "mime_type": "<string>",
          "size_bytes": 123,
          "upload_date_unix": 123,
          "transcription": "<string>"
        }
      }
    ]
  },
  "owner_id": "<string>",
  "permission_on_resource": "<string>",
  "is_legacy": false
}

Headers

xi-api-key · string

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

Path Parameters

voice_id · string · required

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

Query Parameters

with_settings · boolean · default: false

If set will return settings information corresponding to the voice, requires authorization.

Response

200

application/json

Successful Response

voice_id · string · required

name · string · required

samples · SampleResponseModel · object[] · required

Show child attributes

samples. sample_id · string · required

samples. file_name · string · required

samples. mime_type · string · required

samples. size_bytes · integer · required

samples. hash · string · required

category · string · required

fine_tuning · FineTuningResponseModel · object · required

Show child attributes

fine_tuning. is_allowed_to_fine_tune · boolean · required

fine_tuning. state · State · object · required

Show child attributes

fine_tuning.state. {key} · enum<string>

Available options: not_started, queued, fine_tuning, fine_tuned, failed, delayed

fine_tuning. verification_failures · string[] · required

fine_tuning. verification_attempts_count · integer · required

fine_tuning. manual_verification_requested · boolean · required

fine_tuning. language · string

fine_tuning. progress · Progress · object

Show child attributes

fine_tuning.progress. {key} · number

fine_tuning. message · Message · object

Show child attributes

fine_tuning.message. {key} · string

fine_tuning. dataset_duration_seconds · number

fine_tuning. verification_attempts · VerificationAttemptResponseModel · object[]

Show child attributes

fine_tuning.verification_attempts. text · string · required

fine_tuning.verification_attempts. date_unix · integer · required

fine_tuning.verification_attempts. accepted · boolean · required

fine_tuning.verification_attempts. similarity · number · required

fine_tuning.verification_attempts. levenshtein_distance · number · required

fine_tuning.verification_attempts. recording · RecordingResponseModel · object

Show child attributes

fine_tuning.verification_attempts.recording. recording_id · string · required

fine_tuning.verification_attempts.recording. mime_type · string · required

fine_tuning.verification_attempts.recording. size_bytes · integer · required

fine_tuning.verification_attempts.recording. upload_date_unix · integer · required

fine_tuning.verification_attempts.recording. transcription · string · required

fine_tuning. slice_ids · string[]

fine_tuning. manual_verification · ManualVerificationResponseModel · object

Show child attributes

fine_tuning.manual_verification. extra_text · string · required

fine_tuning.manual_verification. request_time_unix · integer · required

fine_tuning.manual_verification. files · ManualVerificationFileResponseModel · object[] · required

Show child attributes

fine_tuning.manual_verification.files. file_id · string · required

fine_tuning.manual_verification.files. file_name · string · required

fine_tuning.manual_verification.files. mime_type · string · required

fine_tuning.manual_verification.files. size_bytes · integer · required

fine_tuning.manual_verification.files. upload_date_unix · integer · required

labels · Labels · object · required

Show child attributes

labels. {key} · string

description · string · required

preview_url · string · required

available_for_tiers · string[] · required

settings · VoiceSettingsResponseModel · object · required

Show child attributes

settings. stability · number · required

settings. similarity_boost · number · required

settings. style · number · default: 0

settings. use_speaker_boost · boolean · default: true

sharing · VoiceSharingResponseModel · object · required

Show child attributes

sharing. status · enum<string> · required

Available options: enabled, disabled, copied, copied_disabled

sharing. history_item_sample_id · string · required

sharing. date_unix · integer · required

sharing. whitelisted_emails · string[] · required

sharing. public_owner_id · string · required

sharing. original_voice_id · string · required

sharing. financial_rewards_enabled · boolean · required

sharing. free_users_allowed · boolean · required

sharing. live_moderation_enabled · boolean · required

sharing. rate · number · required

sharing. notice_period · integer · required

sharing. disable_at_unix · integer · required

sharing. voice_mixing_allowed · boolean · required

sharing. featured · boolean · required

sharing. category · enum<string> · required

Available options: generated, professional, high_quality, famous

sharing. reader_app_enabled · boolean · required

sharing. image_url · string · required

sharing. ban_reason · string · required

sharing. liked_by_count · integer · required

sharing. cloned_by_count · integer · required

sharing. name · string · required

sharing. description · string · required

sharing. labels · Labels · object · required

Show child attributes

sharing.labels. {key} · string

sharing. review_status · enum<string> · required

Available options: not_requested, pending, declined, allowed, allowed_with_changes

sharing. review_message · string · required

sharing. enabled_in_library · boolean · required

sharing. instagram_username · string

sharing. twitter_username · string

sharing. youtube_username · string

sharing. tiktok_username · string

high_quality_base_model_ids · string[] · required

safety_control · enum<string>

Available options: NONE, BAN, CAPTCHA, CAPTCHA_AND_MODERATION

voice_verification · VoiceVerificationResponseModel · object

Show child attributes

voice_verification. requires_verification · boolean · required

voice_verification. is_verified · boolean · required

voice_verification. verification_failures · string[] · required

voice_verification. verification_attempts_count · integer · required

voice_verification. language · string

voice_verification. verification_attempts · VerificationAttemptResponseModel · object[]

Show child attributes

voice_verification.verification_attempts. text · string · required

voice_verification.verification_attempts. date_unix · integer · required

voice_verification.verification_attempts. accepted · boolean · required

voice_verification.verification_attempts. similarity · number · required

voice_verification.verification_attempts. levenshtein_distance · number · required

voice_verification.verification_attempts. recording · RecordingResponseModel · object

Show child attributes

voice_verification.verification_attempts.recording. recording_id · string · required

voice_verification.verification_attempts.recording. mime_type · string · required

voice_verification.verification_attempts.recording. size_bytes · integer · required

voice_verification.verification_attempts.recording. upload_date_unix · integer · required

voice_verification.verification_attempts.recording. transcription · string · required

owner_id · string

permission_on_resource · string

is_legacy · boolean · default: false