Skip to main content
GET
/
v1
/
voices
/
search
Search Voices
curl --request GET \
  --url https://api.voxnexus.ai/v1/voices/search \
  --header 'Authorization: Bearer <token>'
{
  "voices": [
    {
      "voice_id": "vl-xiaoxiao",
      "name": "Xiaoxiao",
      "language": "zh-CN",
      "locale": "zh-CN",
      "display_name": "Xiaoxiao",
      "gender": "female",
      "age": "young",
      "description": "A cheerful and energetic voice",
      "styles": [
        "cheerful",
        "sad",
        "angry"
      ],
      "sample_url": "https://api.example.com/api/v1/samples/vl-xiaoxiao",
      "voice_config_schema": {}
    }
  ],
  "pagination": {
    "page": 1,
    "page_size": 20,
    "total": 150,
    "total_pages": 8
  }
}

Authorizations

Authorization
string
header
required

Authenticate using Bearer Token, where the token is an API Key

Query Parameters

q
string
required

Search keyword (required)

Example:

"xiaoxiao"

language
string

Language code (optional)

Example:

"zh-CN"

gender
enum<string>

Gender (optional)

Available options:
male,
female,
neutral
age
enum<string>

Age group (optional)

Available options:
child,
young,
adult,
senior
style
string

Voice style (optional)

page
integer
default:1

Page number (default 1)

Required range: x >= 1
page_size
integer
default:20

Items per page (default 20, max 100)

Required range: 1 <= x <= 100

Response

Successfully returns search results

voices
object[]
required

Voice list

pagination
object
required