İçeriğe geç
Lumean API

Açıklamalar İngilizce

Bölümün arayüzü dilinize çevrildi, ancak işlem, şema ve hata açıklamaları yalnızca Rusça ve İngilizce mevcut — burada İngilizce sürüm gösteriliyor.
GET/voices/heygen

HeyGen Voices

The HeyGen voice catalogue with filters by language, accent, gender and render engine.

voices.read

Fetch the accepted filter values from GET /voices/heygen/filters first — the spelling there is the provider's (English, en-US). Pages are numbered from zero.

Required key permission: voices.read.

Bu sayfada(3)

Parametreler

Giriş alanları doğrudan istek satırında yer alır: bir değer girin, hazır URL'yi alın. Aşağıda her parametrenin türü, zorunlu olup olmadığı ve izin verilen değerleri var.

GEThttps://api.lumean.app/api/public/voices/heygen
  • stringsorgudaisteğe bağlı≤ 32 karakter

    Voice gender.

    İzin verilen değerler
  • stringsorgudaisteğe bağlı≤ 64 karakter

    Voice language in HeyGen spelling (English, Spanish, …). Listed by GET /voices/heygen/filters.

  • stringsorgudaisteğe bağlı≤ 16 karakter

    Region/accent (en-US, en-GB, …). Listed by GET /voices/heygen/filters.

  • stringsorgudaisteğe bağlı≤ 512 karakter

    Render engine; several values comma-separated. Listed by GET /voices/heygen/filters.

  • stringsorgudaisteğe bağlı≤ 128 karakter

    Search by voice name and internal voice_name.

  • stringsorgudaisteğe bağlı

    Ordering. Defaults to default.

    İzin verilen değerler
  • integersorgudaisteğe bağlı≥ 0

    Page number. Numbered from zero.

  • integersorgudaisteğe bağlı1..200

    Page size. Defaults to 55.

Olası yanıtlar

200

Success. The payload is in data.

Gövde örneği
{
  "success": true,
  "message": "HeyGen voices retrieved successfully.",
  "data": {
    "voices": [
      {
        "voice_id": "7f3a9c1e2b8d4f56a0c3e7f91b2d5a68",
        "voice_name": "Yb56nzJ2XkQ0Fh1PmT8L",
        "display_name": "Cassidy Pro",
        "gender": "female",
        "language": "English",
        "locale": null,
        "accent": "en-US",
        "flag_url": "https://resource2.heygen.ai/flags/us.png",
        "preview_url": "https://api.lumean.app/api/voice-preview?u=eyJpdiI6IjZmM2E5YzFlMmI4ZDRmNTYiLCJ2YWx1ZSI6ImZha2UifQ%3D%3D&signature=9f8e7d6c5b4a3928170f6e5d4c3b2a1908f7e6d5c4b3a2918f7e6d5c4b3a2918",
        "voice_engines": [
          "elevenLabs"
        ],
        "labels": [
          "Conversational",
          "Warm"
        ],
        "support_realtime": true,
        "emotion_support": false,
        "support_locale": false
      },
      {
        "voice_id": "c159d4a2f6b7483d95e0a1c8f4b2d637",
        "voice_name": "Xt4Wq8LmZ2VbPc6RfShu",
        "display_name": "Marcus Energetic",
        "gender": "male",
        "language": "English",
        "locale": null,
        "accent": "en-GB",
        "flag_url": "https://resource2.heygen.ai/flags/gb.png",
        "preview_url": "https://api.lumean.app/api/voice-preview?u=eyJpdiI6ImMxNTlkNGEyZjZiNzQ4M2QiLCJ2YWx1ZSI6ImZha2UifQ%3D%3D&signature=1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b1c2d3e4f5a6b7c8d9e0f1a2b",
        "voice_engines": [
          "elevenLabs",
          "azure"
        ],
        "labels": [
          "Energetic"
        ],
        "support_realtime": false,
        "emotion_support": true,
        "support_locale": true
      }
    ],
    "total": 2,
    "page": 0,
    "page_size": 55,
    "has_more": false
  }
}
Yanıt alanları
successzorunlu

Success flag. Branch on the HTTP status code instead: any 2xx response carries true here, while an error comes back in a different shape that need not contain this field at all.

boolean
messagezorunlu

A human-readable note in the account language. Fine to show to a user; do not parse it — the wording changes without notice and is not an error code.

string
datazorunlu

The response payload.

object
voiceszorunlu

Voices from the HeyGen catalogue.

array<object>
dizi öğesi
voice_idzorunlu

Voice identifier — goes into a heygen template’s config.voice_id.

string
voice_namezorunlu

The provider’s original name for the voice.

string
display_namezorunlu

Display name of the voice.

string
genderzorunlu

Voice gender. Usable as a value for the gender filter.

string
languagezorunlu

Language in the provider’s spelling (English, Spanish). This is exactly what the language filter accepts — take it from here or from /voices/heygen/filters instead of guessing.

string
localezorunlu

Voice locale, when the provider supplies one.

string
accentzorunlu

Accent in the provider’s spelling (en-US). The value for the accent filter.

string
flag_urlzorunlu

Link to the language flag icon — for decorating a list.

string
preview_urlzorunlu

Preview clip of the voice. The link points at our server, not the provider.

string
voice_engineszorunlu

Rendering engines available for this voice. The values work as voice_engine filter input.

array<string>
labelszorunlu

Provider-supplied labels: delivery, use case, emotion.

array<string>
support_realtimezorunlu

Whether the voice supports the provider’s streaming mode.

boolean
emotion_supportzorunlu

Whether the voice accepts emotion directives.

boolean
support_localezorunlu

Whether a locale can be set for the voice independently of the language.

boolean
totalzorunlu

How many voices match the filters, across all pages.

integer
pagezorunlu

Page number, zero-based.

integer
page_sizezorunlu

Page size the server applied.

integer
has_morezorunlu

Whether another page exists.

boolean
401

The key is missing, unknown, disabled or expired.

Bu yanıtı çözümle
Gövde örneği
{
  "success": false,
  "message": "API key is missing. Provide it in the X-API-KEY header.",
  "data": null
}
Yanıt alanları
successzorunlu

Always false in error responses.

boolean
messagezorunlu

Error text in the key's language (set through the X-Locale header).

string
datazorunlu

Always null when the request is rejected before processing.

null olabilir
null
403

The key lacks the required permission, or the object belongs to another user.

Bu yanıtı çözümle
Gövde örneği
{
  "success": false,
  "message": "This API key does not have permission to perform this action."
}
Yanıt alanları
successzorunlu

Always false in error responses.

boolean
messagezorunlu

Error text in the key's language (set through the X-Locale header).

string
422

Validation error. Offending fields are listed in errors.

Bu yanıtı çözümle
Gövde örneği
{
  "message": "string",
  "errors": {}
}
Yanıt alanları
messagezorunlu

Errors overview.

string
errorszorunlu

A detailed description of each field that failed validation.

object
*isteğe bağlı
rastgele anahtarlar
array<string>

İlgili içerik

Düz anlatımla

Bu sayfayı yapay zekâya verin

.md sürümünü açllm.md

spesifikasyon 0.0.1