Overview
This endpoint retrieves a list of available voices. It returns your custom space voices first (if any), followed by voices from the public catalog filtered according to your plan. Results can be filtered by language, gender, and tags.
Authentication
This endpoint requires API key authentication. Include your API key in the Authorization header.
Query Parameters
Filter by language code (e.g., fr, en, es).
Filter by gender: male or female.
Filter by tags. Provide a comma-separated list (e.g., friendly,warm).
If true, returns only public catalog voices (excludes custom space voices). Defaults to false (returns both space and public voices).
Response
Returns an array of voice objects.
Unique identifier of the voice. Use this as voice_id in video generation.
Display name of the voice.
Language code of the voice (e.g., fr, en, es).
Gender of the voice: male or female.
Array of tags associated with the voice (e.g., ["friendly", "warm"]).
Source of the voice: space (custom voice) or config (public catalog).
Example
curl -X GET "https://app.hoox.video/api/public/v1/voice/list?language=fr&gender=female&tags=friendly,warm" \
-H "Authorization: Bearer your_api_key"
[
{
"id": "voice_id",
"name": "Charlotte",
"language": "fr",
"gender": "female",
"tags": ["friendly", "warm"],
"source": "config"
},
{
"id": "custom_voice_123",
"name": "My Custom Voice",
"language": "fr",
"gender": "male",
"tags": ["professional"],
"source": "space"
}
]
Notes
- By default, custom voices from your space are returned first, followed by public catalog voices
- Set
onlyPublic=true to return only public catalog voices (excludes custom space voices)
- Available voices depend on your plan:
- Free: Only free tier voices
- Start: Free + Start tier voices
- Pro: Free + Start + Pro tier voices
- Enterprise: All voices
- Use the
id field as voice_id when creating videos with the /generation/start endpoint
- The
source field helps distinguish between your custom voices and public catalog voices