Wyświetl głosy

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"
}

Pobiera listę wszystkich dostępnych głosów użytkownika z wyszukiwaniem, filtrowaniem i paginacją.

Parametry zapytania

next_page_tokenstring or nullOpcjonalny

Token następnej strony do użycia przy stronicowaniu. Zwracany przez poprzednie żądanie. Używaj go razem z flagą has_more, aby zapewnić niezawodne stronicowanie.

page_sizeintegerOpcjonalnyDomyślnie 10

Maksymalna liczba głosów do zwrócenia. Nie może przekraczać 100, domyślnie 10. Strona 0 może zawierać więcej głosów z uwagi na dołączone głosy domyślne.

searchstring or nullOpcjonalny

Fraza do filtrowania głosów. Wyszukuje w nazwie, opisie, etykietach i kategorii.

sortstring or nullOpcjonalny

Według którego pola sortować: ‘created_at_unix’ lub ‘name’. Pole ‘created_at_unix’ może nie być dostępne dla starszych głosów.

sort_directionstring or nullOpcjonalny

W jakim kierunku sortować głosy: ‘asc’ lub ‘desc’.

voice_typestring or nullOpcjonalny

Typ głosu, według którego chcesz filtrować. Jeden z: ‘personal’, ‘community’, ‘default’, ‘workspace’, ‘non-default’, ‘non-community’, ‘saved’. ‘non-default’ oznacza wszystkie poza ‘default’. ‘non-community’ oznacza połączenie ‘personal’ i ‘workspace’ (bez kopii z biblioteki). ‘saved’ oznacza to samo co non-default, ale obejmuje też domyślne głosy dodane do kolekcji.

Typ głosu, według którego chcesz filtrować. Jeden z: 'personal', 'community', 'default', 'workspace', 'non-default', 'non-community', 'saved'. 'non-default' oznacza wszystkie poza 'default'. 'non-community' oznacza połączenie 'personal' i 'workspace' (bez kopii z biblioteki). 'saved' oznacza to samo co non-default, ale obejmuje też domyślne głosy dodane do kolekcji.

categorystring or nullOpcjonalny

Kategoria głosu do filtrowania. Jedna z: „premade”, „cloned”, „generated”, „professional”

fine_tuning_statestring or nullOpcjonalny

Stan dostrajania głosu, według którego można filtrować. Dotyczy tylko profesjonalnych klonów głosu. Jedna z wartości: ‘draft’, ‘not_verified’, ‘not_started’, ‘queued’, ‘fine_tuning’, ‘fine_tuned’, ‘failed’, ‘delayed’

collection_idstring or nullOpcjonalny

ID kolekcji do filtrowania głosów.

genderstring or nullOpcjonalny

Płeć używana do filtrowania na podstawie etykiety „gender” głosu.

agestring or nullOpcjonalny

Wiek używany do filtrowania na podstawie etykiety „age” głosu.

languagelist of strings or nullOpcjonalny

Języki używane do filtrowania na podstawie etykiety „language” głosu. Zwracane są głosy pasujące do dowolnego z podanych języków.

accentstring or nullOpcjonalny

Akcent używany do filtrowania na podstawie etykiety „accent” głosu.

use_caseslist of strings or nullOpcjonalny

Przypadki użycia do filtrowania na podstawie etykiety głosu „use_case”. Zwracane są głosy pasujące do któregokolwiek z podanych przypadków użycia.

min_notice_period_daysinteger or nullOpcjonalny

Filtruj głosy, których okres wypowiedzenia udostępniania wynosi co najmniej podaną liczbę dni.

include_custom_ratesboolean or nullOpcjonalny

Czy uwzględniać głosy z niestandardową stawką udostępniania. Domyślnie są uwzględniane.

include_live_moderatedboolean or nullOpcjonalny

Czy uwzględniać głosy z włączoną moderacją na żywo. Domyślnie są uwzględniane.

high_qualityboolean or nullOpcjonalny

Gdy wartość to true, zwracaj tylko głosy jakości studyjnej (z kategorią „high_quality”).

include_total_countbooleanOpcjonalnyDomyślnie true

Czy uwzględniać w odpowiedzi łączną liczbę znalezionych głosów. UWAGA: wartość total_count to bieżąca migawka i może zmieniać się między żądaniami, gdy użytkownicy tworzą, modyfikują lub usuwają głosy. Do paginacji użyj zamiast tego flagi has_more. Włączaj tę opcję tylko, gdy naprawdę potrzebujesz łącznej liczby (np. do wyświetlenia), ponieważ wpływa ona na wydajność.

voice_idslist of strings or nullOpcjonalny

ID głosów do wyszukania. Maksymalnie 100 ID głosów.

Odpowiedź

Pomyślna odpowiedź

voiceslist of objects

Lista głosów pasujących do zapytania.

has_moreboolean

Wskazuje, czy kolejne strony zawierają więcej dostępnych głosów. Aby zapewnić niezawodne stronicowanie, użyj tej flagi (i next_page_token) zamiast polegać na total_count.

total_countinteger

Łączna liczba głosów pasujących do zapytania. Ta wartość jest bieżącą migawką stanu bazy danych i może się zmieniać między żądaniami, gdy użytkownicy tworzą, modyfikują lub usuwają głosy. Aby zapewnić niezawodną paginację, używaj flagi has_more zamiast tej wartości. Żądaj tego pola tylko wtedy, gdy rzeczywiście potrzebujesz łącznej liczby, np. do wyświetlenia, ponieważ jej obliczenie obciąża wydajność.

next_page_tokenstring or nullOpcjonalny

Token do pobrania następnej strony wyników. Przekaż tę wartość w kolejnym żądaniu, aby kontynuować stronicowanie. Null, jeśli nie ma więcej wyników.

Błędy

422

Unprocessable Entity Error

Nagłówki

Parametry zapytania

Odpowiedź

Błędy