voices

Get Voices

Changed on

Retrieves a list of shared voices.

get/v1/shared-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/shared-voices
  • Auth
    none declared

Query parameters

page_sizeinteger

How many shared voices to return at maximum. Can not exceed 100, defaults to 30.

category'professional' | 'famous' | 'high_quality' nullable

Voice category used for filtering

Example:professional
genderstring nullable

Gender used for filtering

Example:male
agestring nullable

Age used for filtering

Example:young
accentstring nullable

Accent used for filtering

Example:american
languagestring nullable

Language used for filtering

Example:en
localestring nullable

Locale used for filtering

Example:en-US
searchstring nullable

Search term used for filtering

Example:tiktok
use_casesstring[] nullable

Use-case used for filtering

descriptivesstring[] nullable

Search term used for filtering

featuredboolean

Filter featured voices

Example:true
min_notice_period_daysinteger nullable

Filter voices with a minimum notice period of the given number of days.

Example:30
include_custom_ratesboolean nullable

Include/exclude voices with custom rates

Example:true
include_live_moderatedboolean nullable

Include/exclude voices that are live moderated

Example:true
reader_app_enabledboolean

Filter voices that are enabled for the reader app

Example:true
owner_idstring nullable

Filter voices by public owner ID

Example:7c9fab611d9a0e1fb2e7448a0c294a8804efc2bcc324b0a366a5d5232b7d1532
sort'created_date' | 'usage_character_count_1y' | 'trending' | 'cloned_by_count' nullable

Sort criteria. Must be one of: created_date, usage_character_count_1y, trending, cloned_by_count.

Example:created_date
pageinteger

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.

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

  • 009bd651509aRevision changes
    • breaking

      the query request parameter sort was restricted to a list of enum values

    • breaking

      for the query request parameter sort, default value created_date was added

    • info

      added the new enum value cloned_by_count to the query request parameter sort

    • info

      added the new enum value created_date to the query request parameter sort

    • info

      added the new enum value trending to the query request parameter sort

    • info

      added the new enum value usage_character_count_1y to the query request parameter sort

  • deb5e58ddddfRevision changes
    • info

      added the optional property to the response with the status

    • info

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