Lista röster

GET

/v2/voices

GET

/v2/voices

curl -G https://api.elevenlabs.io/v2/voices \
     -d accent=american \
     -d age=young \
     -d gender=male \
     -d high_quality=true \
     -d include_custom_rates=true \
     -d include_live_moderated=true \
     -d include_total_count=true \
     -d language=en \
     -d language=es \
     -d min_notice_period_days=30 \
     -d next_page_token=0 \
     -d sort=created_at_unix \
     -d sort_direction=desc \
     -d use_cases=conversational \
     -d use_cases=narrative_story

{
  "voices": [
    {
      "voice_id": "string",
      "name": "string",
      "samples": [
        {
          "sample_id": "string",
          "file_name": "string",
          "mime_type": "string",
          "size_bytes": 1,
          "hash": "string",
          "duration_secs": 1.1,
          "remove_background_noise": true,
          "has_isolated_audio": true,
          "has_isolated_audio_preview": true,
          "speaker_separation": {
            "voice_id": "DCwhRBWXzGAHq8TQ4Fs18",
            "sample_id": "DCwhRBWXzGAHq8TQ4Fs18",
            "status": "not_started"
          },
          "trim_start": 1,
          "trim_end": 1
        }
      ],
      "category": "generated",
      "fine_tuning": {
        "is_allowed_to_fine_tune": true,
        "state": {
          "eleven_multilingual_v2": "fine_tuned"
        },
        "verification_failures": [],
        "verification_attempts_count": 2,
        "manual_verification_requested": false
      },
      "labels": {},
      "description": "string",
      "preview_url": "string",
      "available_for_tiers": [
        "string"
      ],
      "settings": {
        "stability": 1,
        "use_speaker_boost": true,
        "similarity_boost": 1,
        "style": 0,
        "speed": 1
      },
      "sharing": {
        "status": "enabled",
        "history_item_sample_id": "DCwhRBWXzGAHq8TQ4Fs18",
        "date_unix": 1714204800,
        "whitelisted_emails": [
          "example@example.com"
        ],
        "public_owner_id": "DCwhRBWXzGAHq8TQ4Fs18",
        "original_voice_id": "DCwhRBWXzGAHq8TQ4Fs18",
        "financial_rewards_enabled": true,
        "free_users_allowed": true,
        "live_moderation_enabled": true,
        "rate": 0.05,
        "notice_period": 30,
        "disable_at_unix": 1714204800,
        "voice_mixing_allowed": false,
        "featured": true,
        "category": "professional",
        "reader_app_enabled": true,
        "liked_by_count": 100,
        "cloned_by_count": 50,
        "name": "Rachel",
        "description": "A female voice with a soft and friendly tone.",
        "labels": {
          "accent": "American",
          "gender": "female"
        },
        "review_status": "allowed",
        "enabled_in_library": true,
        "moderation_check": {
          "date_checked_unix": 1714204800,
          "name_value": "Rachel",
          "name_check": true,
          "description_value": "A female voice with a soft and friendly tone.",
          "description_check": true,
          "sample_ids": [
            "sample1",
            "sample2"
          ],
          "sample_checks": [
            0.95,
            0.98
          ],
          "captcha_ids": [
            "captcha1",
            "captcha2"
          ],
          "captcha_checks": [
            0.95,
            0.98
          ]
        },
        "reader_restricted_on": [
          {
            "resource_type": "read",
            "resource_id": "FCwhRBWXzGAHq8TQ4Fs18"
          }
        ]
      },
      "high_quality_base_model_ids": [
        "string"
      ],
      "verified_languages": [
        {
          "language": "string",
          "model_id": "string",
          "accent": "string",
          "locale": "string",
          "preview_url": "string"
        }
      ],
      "collection_ids": [
        "string"
      ],
      "safety_control": "NONE",
      "voice_verification": {
        "requires_verification": false,
        "is_verified": true,
        "verification_failures": [],
        "verification_attempts_count": 0,
        "language": "en",
        "verification_attempts": [
          {
            "text": "Hello, how are you?",
            "date_unix": 1714204800,
            "accepted": true,
            "similarity": 0.95,
            "levenshtein_distance": 2,
            "recording": {
              "recording_id": "CwhRBWXzGAHq8TQ4Fs17",
              "mime_type": "audio/mpeg",
              "size_bytes": 1000000,
              "upload_date_unix": 1714204800,
              "transcription": "Hello, how are you?"
            }
          }
        ]
      },
      "permission_on_resource": "string",
      "is_owner": true,
      "is_legacy": false,
      "is_mixed": false,
      "favorited_at_unix": 1,
      "created_at_unix": 1,
      "is_bookmarked": true,
      "recording_quality": "studio",
      "labelling_status": "in_review",
      "recording_quality_reason": "string"
    }
  ],
  "has_more": true,
  "total_count": 1,
  "next_page_token": "string"
}

Hämtar en lista över alla tillgängliga röster för en användare med sökning, filtrering och paginering.

Frågeparametrar

next_page_tokenstring or nullValfri

Nästa sidtoken som ska användas för paginering. Returneras från föregående begäran. Använd den tillsammans med flaggan has_more för tillförlitlig paginering.

page_sizeintegerValfriStandard är 10

Maximalt antal röster att returnera. Får inte överstiga 100, standardvärdet är 10. Sida 0 kan innehålla fler röster eftersom standardröster inkluderas.

searchstring or nullValfri

Sökterm för att filtrera röster. Söker i namn, beskrivning, etiketter och kategori.

sortstring or nullValfri

Vilket fält som ska sorteras efter: 'created_at_unix' eller 'name'. 'created_at_unix' kanske inte är tillgängligt för äldre röster.

sort_directionstring or nullValfri

Vilken riktning rösterna ska sorteras i: 'asc' eller 'desc'.

voice_typestring or nullValfri

Typ av röst att filtrera efter. Ett av följande: 'personal', 'community', 'default', 'workspace', 'non-default', 'non-community', 'saved'. 'non-default' motsvarar alla utom 'default'. 'non-community' motsvarar 'personal' och 'workspace' tillsammans (exkluderar bibliotekskopior). 'saved' motsvarar non-default, men inkluderar standardröster om de har lagts till i en samling.

categorystring or nullValfri

Kategori för rösten att filtrera efter. En av ”premade”, ”cloned”, ”generated”, ”professional”

fine_tuning_statestring or nullValfri

Status för röstens finjustering att filtrera efter. Gäller endast professionella röstkloner. Ett av följande: 'draft', 'not_verified', 'not_started', 'queued', 'fine_tuning', 'fine_tuned', 'failed', 'delayed'

collection_idstring or nullValfri

Samlings-ID att filtrera röster efter.

genderstring or nullValfri

Kön som används för filtrering, baserat på röstens 'gender'-etikett.

agestring or nullValfri

Ålder som används för filtrering, baserat på röstens etikett 'age'.

languagelist of strings or nullValfri

Språk som används för filtrering baserat på röstens ”language”-etikett. Röster som matchar något av de angivna språken returneras.

accentstring or nullValfri

Accent som används för filtrering, baserat på röstens etikett 'accent'.

use_caseslist of strings or nullValfri

Användningsfall som används för filtrering, baserat på röstens etikett 'use_case'. Röster som matchar något av de angivna användningsfallen returneras.

min_notice_period_daysinteger or nullValfri

Filtrera till röster vars uppsägningstid för delning är minst det angivna antalet dagar.

include_custom_ratesboolean or nullValfri

Om röster med en anpassad delningsnivå ska inkluderas. De inkluderas som standard.

include_live_moderatedboolean or nullValfri

Om röster med aktiv livemoderering ska inkluderas. De inkluderas som standard.

high_qualityboolean or nullValfri

När värdet är true returneras endast röster i studiokvalitet (de vars kategori är 'high_quality').

include_total_countbooleanValfriStandard är true

Om det totala antalet hittade röster ska inkluderas i svaret. OBS! Värdet total_count är en ögonblicksbild i realtid och kan ändras mellan förfrågningar när användare skapar, ändrar eller tar bort röster. Använd i stället flaggan has_more för paginering. Aktivera endast detta när du faktiskt behöver det totala antalet, till exempel för visning, eftersom det påverkar prestandan.

voice_idslist of strings or nullValfri

Röst-ID:n att slå upp. Högst 100 röst-ID:n.

Svar

Lyckat svar

voiceslist of objects

Listan över röster som matchar frågan.

has_moreboolean

Anger om det finns fler röster tillgängliga på efterföljande sidor. Använd denna flagga (och next_page_token) för tillförlitlig paginering i stället för att förlita dig på total_count.

total_countinteger

Det totala antalet röster som matchar frågan. Värdet är en ögonblicksbild som återspeglar databasens aktuella tillstånd och kan ändras mellan begäranden när användare skapar, ändrar eller raderar röster. Använd flaggan has_more för tillförlitlig paginering i stället för att förlita dig på detta värde. Begär bara detta fält när du faktiskt behöver det totala antalet, till exempel för visning, eftersom beräkningen medför en prestandakostnad.

next_page_tokenstring or nullValfri

Token för att hämta nästa resultatsida. Skicka detta värde i nästa begäran för att fortsätta sidindelningen. Null om det inte finns fler resultat.

Fel

422

Unprocessable Entity Error

Headers

Frågeparametrar

Svar

Fel