Skip to main content
GET
https://app.hoox.video
/
api
/
public
/
v1
/
voice
/
{id}
curl -X GET "https://app.hoox.video/api/public/v1/voice/voice_fr_female_01" \
  -H "Authorization: Bearer your_api_key"
{
  "id": "voice_fr_female_01",
  "name": "Charlotte",
  "language": "fr",
  "gender": "female",
  "tags": ["friendly", "warm"],
  "source": "config"
}

Overview

This endpoint retrieves details for a specific voice by its id. Results can come from your space (custom voices) or from the public catalog filtered by your plan.

Authentication

This endpoint requires API key authentication. Include your API key in the Authorization header.

Path Parameters

id
string
required
The identifier of the voice to retrieve.

Response

id
string
Unique identifier of the voice.
name
string
Display name of the voice.
language
string
Language code of the voice (e.g., fr, en).
gender
string
Gender of the voice: male or female.
tags
array
Array of tags associated with the voice (e.g., [\"friendly\", \"warm\"]).
source
string
Source of the voice: space (custom voice) or config (public catalog).

Example

curl -X GET "https://app.hoox.video/api/public/v1/voice/voice_fr_female_01" \
  -H "Authorization: Bearer your_api_key"
{
  "id": "voice_fr_female_01",
  "name": "Charlotte",
  "language": "fr",
  "gender": "female",
  "tags": ["friendly", "warm"],
  "source": "config"
}