Skip to main content
POST
List system voices

Authorizations

Authorization
string
header
required

Send your API Key in the Authorization header (Bearer <api_key>). See Authentication.

Body

application/json
voiceId
string

Filter by preset voiceId. See Voices

searchName
string

Search by display or local name

locale
string

Filter by locale (BCP-47). See Supported languages

Example:

"en-US"

age
string

young / adult / senior

gender
string

Filter by gender

quality
string

any / high

category
string

Filter by voice category

emotionPrompt
string

exclude / include

topIds
string[]

Pin these preset voiceId values to the top. See Voices

currentPage
integer
default:1

Page number (1-based)

pageSize
integer
default:10

Page size

orderBy
string

voiceId / score / create_time / update_time / is_preferred

order
string
default:desc

Sort direction: asc or desc

Response

200 - application/json

Success

code
integer
required

Business code; 200 means success

Example:

200

message
string

Human-readable detail when code is not success

Example:

""

data
object