Skip to content
Lumean
GET/voices/filters

Voice Catalogue Filters

Descriptions of the filters of the chosen provider's voice catalogue: the parameter key, a label, the kind (text, select, multiselect) and the allowed values with counts. Pass provider (elevenlabs, heygen, cartesia, fishaudio, lumvoice) — the same values as in GET /voices?provider=….

Required key permission: voices.read.

Parameters

Values go straight into the request line, and the URL is built for you. Below are each parameter’s type, whether it is required, and its allowed values.

GEThttps://api.lumean.app/api/public/voices/filters
  • stringin queryrequired

    Voice provider: elevenlabs, heygen, cartesia, fishaudio or lumvoice.

    Allowed values

Possible responses

200

Success. The payload is in data.

Body example
{
  "success": true,
  "message": "Success",
  "data": {
    "provider": "cartesia",
    "filters": [
      {
        "key": "search",
        "label": "Search",
        "type": "text",
        "options": null
      },
      {
        "key": "language",
        "label": "Language",
        "type": "select",
        "options": [
          {
            "value": "ru",
            "label": "ru",
            "count": 58
          },
          {
            "value": "en",
            "label": "en",
            "count": 214
          }
        ]
      },
      {
        "key": "gender",
        "label": "Gender",
        "type": "select",
        "options": [
          {
            "value": "female",
            "label": "female",
            "count": 150
          },
          {
            "value": "male",
            "label": "male",
            "count": 122
          }
        ]
      }
    ]
  }
}
Response fields
successrequired

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
messagerequired

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
datarequired

The response payload.

object
providerrequired

The provider whose filters are described.

string
filtersrequired

Filters of the provider’s voice catalogue.

array<any>
401

The key is missing, unknown, disabled or expired.

Analyse this response
Body example
{
  "success": false,
  "message": "API key is missing. Provide it in the X-API-KEY header.",
  "data": null
}
Response fields
successrequired

Always false in error responses.

boolean
messagerequired

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

string
datarequired

Always null when the request is rejected before processing.

nullable
null
403

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

Analyse this response
Body example
{
  "success": false,
  "message": "This API key does not have permission to perform this action."
}
Response fields
successrequired

Always false in error responses.

boolean
messagerequired

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

string
404

Not found, or not reachable with this key.

Analyse this response
Body example
{
  "success": false,
  "message": "Resource not found."
}
Response fields
successrequired

Always false in error responses.

boolean
messagerequired

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

string
reasonoptional

Machine-readable reason — present on business refusals (for example, invalid_order_status); other errors omit it. Branch on it, not on the message text.

string
error_codeoptional

The same machine-readable code as in reason — a second name for the field. Arrives together with reason; the values always match.

string
422

Validation error. Offending fields are listed in errors.

Analyse this response
Body example
{
  "message": "string",
  "errors": {
    "key": [
      "string"
    ]
  }
}
Response fields
messagerequired

A summary of the validation errors in words, in the response language (X-Locale).

string
errorsrequired

A per-field breakdown: the key names a request field, the value lists the complaints about it.

object
*optional
arbitrary keys
array<string>

This page for AI

Open .mdllm.md

API version 1.0.0