API Platform

List Voices

Query the voices available to the current tenant. Voices are uniformly identified by a voice id, referenced by endpoints such as Single-speaker Speech.

GET
/v1/audio/voices

List the voices available to the current tenant. Returns a list object; for security boundaries, voice URLs are not returned.

Authentication

Add Authorization: Bearer <API_KEY> to the request headers to authenticate. You can generate a key on the console "API Keys" page.

Example
curl https://api.mosi.cn/v1/audio/voices \
  -H "Authorization: Bearer $MOSS_API_KEY"

Request fields

QueryTypeRequiredDescription
limitintegerNo

Number of results to return; defaults to 20.

offsetintegerNo

Offset.

afterstringNo

Pagination cursor; use the next_cursor returned by the previous page.

statusstringNo

Filter by voice status; the exact allowed values are subject to the server.

Request example

curl "https://api.mosi.cn/v1/audio/voices?limit=20&status=ready" \
  -H "Authorization: Bearer $MOSS_API_KEY"

Response fields

FieldTypeAlways returnedDescription
objectstringYes

Fixed as list.

data[].idstringYes

voice id; referenced by the TTS/TTSD/voice-generation endpoints.

data[].objectstringYes

Fixed as audio.voice.

data[].namestringYes

Human-readable name; may be an empty string.

data[].created_atintegerYes

Creation time, a Unix timestamp in seconds.

has_morebooleanYes

Whether there are more voices.

first_idstringWhen data is non-empty

The first voice id on the current page.

last_idstringWhen data is non-empty

The last voice id on the current page.

next_cursorstringWhen there is a next page

Cursor for the next page; can be passed as after in the next request.

Response example

Response example
{
  "object": "list",
  "data": [
    {
      "id": "<voice_id>",
      "object": "audio.voice",
      "name": "Alice",
      "created_at": 1710000000
    }
  ],
  "first_id": "<voice_id>",
  "last_id": "<voice_id>",
  "has_more": false
}

Next steps