Search Voices
curl --request GET \
--url https://api.voxnexus.ai/v1/voices/search \
--header 'X-Api-Key: <api-key>'import requests
url = "https://api.voxnexus.ai/v1/voices/search"
headers = {"X-Api-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};
fetch('https://api.voxnexus.ai/v1/voices/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.voxnexus.ai/v1/voices/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.voxnexus.ai/v1/voices/search"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Api-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.voxnexus.ai/v1/voices/search")
.header("X-Api-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.voxnexus.ai/v1/voices/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"voices": [
{
"voice_id": "vn-xiaoxiao",
"name": "Xiaoxiao",
"gender": "female",
"primary_locale": "zh-CN",
"display_name": "Xiaoxiao",
"category": "premade",
"description": "A warm and friendly female voice, suitable for general scenarios",
"is_multilingual": true,
"supported_locales": [
{
"locale": "zh-CN",
"language": "zh",
"locale_name": "Chinese (Simplified, China)",
"accent": "mandarin",
"preview_url": "https://api.voxnexus.ai/samples/vn-xiaoxiao/zh-CN.mp3",
"is_primary": true
}
],
"labels": {
"personalities": [
"warm",
"friendly"
],
"scenarios": [
"assistant",
"news"
]
},
"preview_url": "https://api.voxnexus.ai/samples/vn-xiaoxiao.mp3",
"config_schema": {
"style": {
"type": "string",
"description": "Speaking style",
"enum": [
"cheerful",
"sad"
]
}
},
"models": [
"vn-tts-basic",
"vn-tts-ultra"
]
}
],
"pagination": {
"page": 1,
"page_size": 20,
"total": 150,
"total_pages": 8
}
}{
"error": "Invalid request parameters",
"code": "INVALID_REQUEST",
"details": "Detailed error information",
"request_id": "req_1234567890"
}{
"error": "Invalid request parameters",
"code": "INVALID_REQUEST",
"details": "Detailed error information",
"request_id": "req_1234567890"
}{
"error": "Invalid request parameters",
"code": "INVALID_REQUEST",
"details": "Detailed error information",
"request_id": "req_1234567890"
}voices
Search Voices
Search voices by keyword
GET
/
v1
/
voices
/
search
Search Voices
curl --request GET \
--url https://api.voxnexus.ai/v1/voices/search \
--header 'X-Api-Key: <api-key>'import requests
url = "https://api.voxnexus.ai/v1/voices/search"
headers = {"X-Api-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};
fetch('https://api.voxnexus.ai/v1/voices/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.voxnexus.ai/v1/voices/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.voxnexus.ai/v1/voices/search"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Api-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.voxnexus.ai/v1/voices/search")
.header("X-Api-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.voxnexus.ai/v1/voices/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"voices": [
{
"voice_id": "vn-xiaoxiao",
"name": "Xiaoxiao",
"gender": "female",
"primary_locale": "zh-CN",
"display_name": "Xiaoxiao",
"category": "premade",
"description": "A warm and friendly female voice, suitable for general scenarios",
"is_multilingual": true,
"supported_locales": [
{
"locale": "zh-CN",
"language": "zh",
"locale_name": "Chinese (Simplified, China)",
"accent": "mandarin",
"preview_url": "https://api.voxnexus.ai/samples/vn-xiaoxiao/zh-CN.mp3",
"is_primary": true
}
],
"labels": {
"personalities": [
"warm",
"friendly"
],
"scenarios": [
"assistant",
"news"
]
},
"preview_url": "https://api.voxnexus.ai/samples/vn-xiaoxiao.mp3",
"config_schema": {
"style": {
"type": "string",
"description": "Speaking style",
"enum": [
"cheerful",
"sad"
]
}
},
"models": [
"vn-tts-basic",
"vn-tts-ultra"
]
}
],
"pagination": {
"page": 1,
"page_size": 20,
"total": 150,
"total_pages": 8
}
}{
"error": "Invalid request parameters",
"code": "INVALID_REQUEST",
"details": "Detailed error information",
"request_id": "req_1234567890"
}{
"error": "Invalid request parameters",
"code": "INVALID_REQUEST",
"details": "Detailed error information",
"request_id": "req_1234567890"
}{
"error": "Invalid request parameters",
"code": "INVALID_REQUEST",
"details": "Detailed error information",
"request_id": "req_1234567890"
}Authorizations
Authenticate using X-Api-Key header
Query Parameters
Search keyword (required)
Example:
"xiaoxiao"
Language code (optional)
Example:
"zh"
Locale code (optional, e.g., zh-CN, en-US)
Example:
"zh-CN"
Gender (optional)
Available options:
male, female, neutral Voice category (optional)
Available options:
premade, cloned, generated Voice style filter (optional). Filters voices that support the specified style in their config_schema.style.enum. Common styles: cheerful, sad, angry, friendly, newscast, etc.
Example:
"cheerful"
Page number (default 1)
Required range:
x >= 1Items per page (default 20, max 100)
Required range:
1 <= x <= 100⌘I