GET
/
api
/
v1
/
voices
curl --request GET \
  --url https://api.play.ai/api/v1/voices \
  --header 'Authorization: Bearer <token>' \
  --header 'X-USER-ID: <api-key>'
[
  {
    "name": "Jun Conversational",
    "id": "s3://voice-cloning-zero-shot/00325021.../manifest.json",
    "sample": "<string>",
    "gender": "male",
    "accent": "<string>",
    "description": "<string>",
    "language": "afrikaans",
    "tags": [
      "<string>"
    ],
    "categories": [
      "<string>"
    ],
    "updatedDate": 123,
    "createdDate": 123
  }
]

Authorizations

​
Authorization
string
header
required

Your secret API key from PlayAI, formatted as Bearer YOUR_SECRET_API_KEY.

​
X-USER-ID
string
header
required

Your unique user ID from PlayAI.

Query Parameters

​
search
string | null

A search query to filter the voices by name.

Response

200 - application/json
A list of all pre-built voices.
​
name
string
required
Example:

"Jun Conversational"

​
id
string
required
Example:

"s3://voice-cloning-zero-shot/00325021.../manifest.json"

​
sample
string
required
​
gender
enum<string>
required
Available options:
male,
female
​
accent
string
required
​
description
string
required
​
language
enum<string>
required
Available options:
afrikaans,
albanian,
amharic,
arabic,
bengali,
bulgarian,
catalan,
croatian,
czech,
danish,
dutch,
english,
french,
galician,
german,
greek,
hebrew,
hindi,
hungarian,
indonesian,
italian,
japanese,
korean,
malay,
mandarin,
polish,
portuguese,
russian,
serbian,
spanish,
swedish,
tagalog,
thai,
turkish,
ukrainian,
urdu,
xhosa
​
tags
string[]
required
​
categories
string[]
required
​
updatedDate
number
required
​
createdDate
number
required

Was this page helpful?