İç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/filters

HeyGen Voice Filters

The reference of filter values for the HeyGen catalogue: render engines, languages, accents and labels — each with a count of publicly visible voices.

Call this before GET /voices/heygen so you know what to put into language, accent and voice_engine: the spelling is the provider's (English, en-US) and is not worth guessing.

Required key permission: voices.read.

Bu sayfada(2)

Olası yanıtlar

200

Success. The payload is in data.

Gövde örneği
{
  "success": true,
  "message": "HeyGen voice filters retrieved successfully.",
  "data": {
    "voice_engines": [
      {
        "value": "elevenLabs",
        "count": 1820
      },
      {
        "value": "azure",
        "count": 410
      },
      {
        "value": "cartesia",
        "count": 98
      }
    ],
    "genders": [
      {
        "value": "female",
        "count": 1240
      },
      {
        "value": "male",
        "count": 1080
      },
      {
        "value": "unknown",
        "count": 10
      }
    ],
    "languages": [
      {
        "value": "English",
        "count": 640
      },
      {
        "value": "Spanish",
        "count": 210
      },
      {
        "value": "French",
        "count": 150
      }
    ],
    "accents": [
      {
        "value": "en-US",
        "count": 420
      },
      {
        "value": "en-GB",
        "count": 180
      },
      {
        "value": "es-ES",
        "count": 110
      }
    ],
    "labels": [
      {
        "value": "Conversational",
        "count": 530
      },
      {
        "value": "Warm",
        "count": 340
      },
      {
        "value": "Energetic",
        "count": 275
      }
    ]
  }
}
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
voice_engineszorunlu

Allowed values for the voice_engine filter, each with a voice count.

array<object>
dizi öğesi
valuezorunlu

The value to put into the filter.

string
countzorunlu

How many voices remain when this value is applied.

integer
genderszorunlu

Allowed values for the gender filter, with counts.

array<object>
dizi öğesi
valuezorunlu

The value to put into the filter.

string
countzorunlu

How many voices remain when this value is applied.

integer
languageszorunlu

Allowed values for the language filter — in the provider’s spelling, with counts.

array<object>
dizi öğesi
valuezorunlu

The value to put into the filter.

string
countzorunlu

How many voices remain when this value is applied.

integer
accentszorunlu

Allowed values for the accent filter, with counts.

array<object>
dizi öğesi
valuezorunlu

The value to put into the filter.

string
countzorunlu

How many voices remain when this value is applied.

integer
labelszorunlu

Voice labels with counts. There is no dedicated filter for them — use search instead.

array<object>
dizi öğesi
valuezorunlu

The label value.

string
countzorunlu

How many voices carry this label.

integer
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

Bu sayfayı yapay zekâya verin

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

spesifikasyon 0.0.1