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.
- stringin queryrequired
Voice provider:
elevenlabs,heygen,cartesia,fishaudioorlumvoice.Allowed values
Possible responses
200Success. The payload is in data.
Success. The payload is in data.
{
"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
}
]
}
]
}
}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.
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.
datarequiredThe response payload.
object
The response payload.
The provider whose filters are described.
Filters of the provider’s voice catalogue.
401The key is missing, unknown, disabled or expired.
The key is missing, unknown, disabled or expired.
{
"success": false,
"message": "API key is missing. Provide it in the X-API-KEY header.",
"data": null
}Always false in error responses.
Error text in the key's language (set through the X-Locale header).
Always null when the request is rejected before processing.
403The key lacks the required permission, or the object belongs to another user.
The key lacks the required permission, or the object belongs to another user.
{
"success": false,
"message": "This API key does not have permission to perform this action."
}Always false in error responses.
Error text in the key's language (set through the X-Locale header).
404Not found, or not reachable with this key.
Not found, or not reachable with this key.
{
"success": false,
"message": "Resource not found."
}Always false in error responses.
Error text in the key's language (set through the X-Locale header).
Machine-readable reason — present on business refusals (for example, invalid_order_status); other errors omit it. Branch on it, not on the message text.
The same machine-readable code as in reason — a second name for the field. Arrives together with reason; the values always match.
422Validation error. Offending fields are listed in errors.
Validation error. Offending fields are listed in errors.
{
"message": "string",
"errors": {
"key": [
"string"
]
}
}A summary of the validation errors in words, in the response language (X-Locale).
errorsrequiredA per-field breakdown: the key names a request field, the value lists the complaints about it.
object
A per-field breakdown: the key names a request field, the value lists the complaints about it.
Nearby
The same in words
Neighbouring operations
This page for AI
API version 1.0.0