voices

Get Similar Library Voices

Changed on

Returns a list of shared voices similar to the provided audio sample. If neither similarity_threshold nor top_k is provided, we will apply default values.

post/v1/similar-voices

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/similar-voices
  • Auth
    none declared

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

audio_filestring binary
similarity_thresholdnumber nullable

Threshold 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_kinteger nullable

Number 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.

Example request

{
  "similarity_threshold": 0.5,
  "top_k": 10
}

Response

Successful Response

has_moreboolean required

Whether there are more shared voices in subsequent pages.

total_countinteger

The total number of shared voices matching the query.

last_sort_idstring nullable

Example response

{
  "has_more": false,
  "total_count": 0,
  "voices": [
    {
      "accent": "american",
      "age": "young",
      "category": "professional",
      "cloned_by_count": 11,
      "date_unix": 1714423232,
      "description": "Perfectly calm, neutral and strong voice. Great for a young female protagonist.",
      "descriptive": "calm",
      "featured": false,
      "free_users_allowed": true,
      "gender": "Female",
      "language": "en",
      "live_moderation_enabled": false,
      "name": "Alita",
      "play_api_usage_character_count_1y": 12852,
      "preview_url": "https://storage.googleapis.com/eleven-public-prod/wqkMCd9huxXHX1dy5mLJn4QEQHj1/voices/sB1b5zUrxQVAFl2PhZFp/55e71aac-5cb7-4b3d-8241-429388160509.mp3",
      "public_owner_id": "63e84100a6bf7874ba37a1bab9a31828a379ec94b891b401653b655c5110880f",
      "rate": 1,
      "usage_character_count_1y": 12852,
      "usage_character_count_7d": 12852,
      "use_case": "characters_animation",
      "verified_languages": [
        {
          "accent": "american",
          "language": "en",
          "locale": "en-US",
          "model_id": "eleven_multilingual_v2",
          "preview_url": "https://storage.googleapis.com/eleven-public-prod/wqkMCd9huxXHX1dy5mLJn4QEQHj1/voices/sB1b5zUrxQVAFl2PhZFp/55e71aac-5cb7-4b3d-8241-429388160509.mp3"
        }
      ],
      "voice_id": "sB1b5zUrxQVAFl2PhZFp"
    }
  ]
}

Changes

  • deb5e58ddddfRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property // to the response with the status

  • 5b595807512cRevision changes
    • info

      api operation id Get_similar_library_voices_v1_similar_voices_post removed and replaced with get_similar_library_voices