# List all voicescurl "https://api.vibepeak.ai/v1/voices" \ -H "Authorization: Bearer vpk_live_xxxxx"# List public female voices in Englishcurl "https://api.vibepeak.ai/v1/voices?type=public&gender=female&language=en" \ -H "Authorization: Bearer vpk_live_xxxxx"# List cloned voices with paginationcurl "https://api.vibepeak.ai/v1/voices?type=cloned&limit=10&offset=0" \ -H "Authorization: Bearer vpk_live_xxxxx"
// List all voicesconst response = await fetch('https://api.vibepeak.ai/v1/voices', { headers: { 'Authorization': 'Bearer vpk_live_xxxxx' }});const data = await response.json();console.log(`Found ${data.pagination.total} voices`);for (const voice of data.voices) { console.log(`${voice.name} (${voice.voice_id}) - ${voice.language}`);}// Filter by gender and languageconst filteredResponse = await fetch( 'https://api.vibepeak.ai/v1/voices?type=public&gender=female&language=en', { headers: { 'Authorization': 'Bearer vpk_live_xxxxx' } });const filteredData = await filteredResponse.json();console.log(`Found ${filteredData.pagination.total} female English voices`);// Paginate through all voicesasync function getAllVoices(type = 'all') { const voices = []; let offset = 0; const limit = 50; while (true) { const res = await fetch( `https://api.vibepeak.ai/v1/voices?type=${type}&limit=${limit}&offset=${offset}`, { headers: { 'Authorization': 'Bearer vpk_live_xxxxx' } } ); const data = await res.json(); voices.push(...data.voices); if (!data.pagination.has_more) break; offset += limit; } return voices;}
import requests# List all voicesresponse = requests.get( 'https://api.vibepeak.ai/v1/voices', headers={'Authorization': 'Bearer vpk_live_xxxxx'})data = response.json()print(f"Found {data['pagination']['total']} voices")for voice in data['voices']: print(f"{voice['name']} ({voice['voice_id']}) - {voice['language']}")# Filter by gender and languageresponse = requests.get( 'https://api.vibepeak.ai/v1/voices', params={'type': 'public', 'gender': 'female', 'language': 'en'}, headers={'Authorization': 'Bearer vpk_live_xxxxx'})filtered_data = response.json()print(f"Found {filtered_data['pagination']['total']} female English voices")# Paginate through all cloned voicesdef get_all_voices(voice_type='all'): voices = [] offset = 0 limit = 50 while True: response = requests.get( 'https://api.vibepeak.ai/v1/voices', params={'type': voice_type, 'limit': limit, 'offset': offset}, headers={'Authorization': 'Bearer vpk_live_xxxxx'} ) data = response.json() voices.extend(data['voices']) if not data['pagination']['has_more']: break offset += limit return voices
{ "error": { "code": "INVALID_PARAMETER", "message": "Invalid value for 'type'. Must be 'public', 'cloned', or 'all'.", "request_id": "req_xyz123" }}
{ "error": { "code": "INVALID_API_KEY", "message": "Invalid or missing API key.", "request_id": "req_xyz123" }}
Voices
List Voices
Retrieve a paginated list of voices available for video narration
GET
/
v1
/
voices
# List all voicescurl "https://api.vibepeak.ai/v1/voices" \ -H "Authorization: Bearer vpk_live_xxxxx"# List public female voices in Englishcurl "https://api.vibepeak.ai/v1/voices?type=public&gender=female&language=en" \ -H "Authorization: Bearer vpk_live_xxxxx"# List cloned voices with paginationcurl "https://api.vibepeak.ai/v1/voices?type=cloned&limit=10&offset=0" \ -H "Authorization: Bearer vpk_live_xxxxx"
// List all voicesconst response = await fetch('https://api.vibepeak.ai/v1/voices', { headers: { 'Authorization': 'Bearer vpk_live_xxxxx' }});const data = await response.json();console.log(`Found ${data.pagination.total} voices`);for (const voice of data.voices) { console.log(`${voice.name} (${voice.voice_id}) - ${voice.language}`);}// Filter by gender and languageconst filteredResponse = await fetch( 'https://api.vibepeak.ai/v1/voices?type=public&gender=female&language=en', { headers: { 'Authorization': 'Bearer vpk_live_xxxxx' } });const filteredData = await filteredResponse.json();console.log(`Found ${filteredData.pagination.total} female English voices`);// Paginate through all voicesasync function getAllVoices(type = 'all') { const voices = []; let offset = 0; const limit = 50; while (true) { const res = await fetch( `https://api.vibepeak.ai/v1/voices?type=${type}&limit=${limit}&offset=${offset}`, { headers: { 'Authorization': 'Bearer vpk_live_xxxxx' } } ); const data = await res.json(); voices.push(...data.voices); if (!data.pagination.has_more) break; offset += limit; } return voices;}
import requests# List all voicesresponse = requests.get( 'https://api.vibepeak.ai/v1/voices', headers={'Authorization': 'Bearer vpk_live_xxxxx'})data = response.json()print(f"Found {data['pagination']['total']} voices")for voice in data['voices']: print(f"{voice['name']} ({voice['voice_id']}) - {voice['language']}")# Filter by gender and languageresponse = requests.get( 'https://api.vibepeak.ai/v1/voices', params={'type': 'public', 'gender': 'female', 'language': 'en'}, headers={'Authorization': 'Bearer vpk_live_xxxxx'})filtered_data = response.json()print(f"Found {filtered_data['pagination']['total']} female English voices")# Paginate through all cloned voicesdef get_all_voices(voice_type='all'): voices = [] offset = 0 limit = 50 while True: response = requests.get( 'https://api.vibepeak.ai/v1/voices', params={'type': voice_type, 'limit': limit, 'offset': offset}, headers={'Authorization': 'Bearer vpk_live_xxxxx'} ) data = response.json() voices.extend(data['voices']) if not data['pagination']['has_more']: break offset += limit return voices
{ "error": { "code": "INVALID_PARAMETER", "message": "Invalid value for 'type'. Must be 'public', 'cloned', or 'all'.", "request_id": "req_xyz123" }}
{ "error": { "code": "INVALID_API_KEY", "message": "Invalid or missing API key.", "request_id": "req_xyz123" }}
Retrieves a paginated list of voices. You can request public voices from our voice library, your custom cloned voices, or both.
Query Parameters
string
default:"all"
The type of voices to retrieve.Allowed values:public, cloned, all
public: Public library voices available to all users
cloned: Your custom cloned voices
all: Both public and cloned voices (default)
string
Filter voices by gender.Allowed values:male, female
string
Filter voices by age group.Allowed values:young, middle_aged, old
string
Filter voices by language (ISO 639-1 code).Allowed values:en, es, pt, de, fr, it, ca
integer
default:"20"
Maximum number of voices to return per page.Range: 1-100
integer
default:"0"
Number of voices to skip (for pagination).Minimum: 0
Response
array
required
List of voice objects.
Show Voice properties
string
Unique identifier for the voice. Use this ID when creating videos with narration.
string
Display name of the voice.
string
Voice type: public or cloned.
string
Primary language of the voice (ISO 639-1 code).
string | null
Accent of the voice (e.g., “american”, “british”). May be null if not specified.
string | null
Age group of the voice: young, middle_aged, or old. May be null if not specified.
string | null
Gender of the voice: male or female. May be null if not specified.
string | null
URL to a sample audio clip of the voice. May be null for cloned voices.
object
required
Pagination information.
Show Pagination properties
integer
Total number of voices available.
integer
Number of voices per page (as requested).
integer
Current offset (as requested).
boolean
Whether there are more voices available after this page.
# List all voicescurl "https://api.vibepeak.ai/v1/voices" \ -H "Authorization: Bearer vpk_live_xxxxx"# List public female voices in Englishcurl "https://api.vibepeak.ai/v1/voices?type=public&gender=female&language=en" \ -H "Authorization: Bearer vpk_live_xxxxx"# List cloned voices with paginationcurl "https://api.vibepeak.ai/v1/voices?type=cloned&limit=10&offset=0" \ -H "Authorization: Bearer vpk_live_xxxxx"
// List all voicesconst response = await fetch('https://api.vibepeak.ai/v1/voices', { headers: { 'Authorization': 'Bearer vpk_live_xxxxx' }});const data = await response.json();console.log(`Found ${data.pagination.total} voices`);for (const voice of data.voices) { console.log(`${voice.name} (${voice.voice_id}) - ${voice.language}`);}// Filter by gender and languageconst filteredResponse = await fetch( 'https://api.vibepeak.ai/v1/voices?type=public&gender=female&language=en', { headers: { 'Authorization': 'Bearer vpk_live_xxxxx' } });const filteredData = await filteredResponse.json();console.log(`Found ${filteredData.pagination.total} female English voices`);// Paginate through all voicesasync function getAllVoices(type = 'all') { const voices = []; let offset = 0; const limit = 50; while (true) { const res = await fetch( `https://api.vibepeak.ai/v1/voices?type=${type}&limit=${limit}&offset=${offset}`, { headers: { 'Authorization': 'Bearer vpk_live_xxxxx' } } ); const data = await res.json(); voices.push(...data.voices); if (!data.pagination.has_more) break; offset += limit; } return voices;}
import requests# List all voicesresponse = requests.get( 'https://api.vibepeak.ai/v1/voices', headers={'Authorization': 'Bearer vpk_live_xxxxx'})data = response.json()print(f"Found {data['pagination']['total']} voices")for voice in data['voices']: print(f"{voice['name']} ({voice['voice_id']}) - {voice['language']}")# Filter by gender and languageresponse = requests.get( 'https://api.vibepeak.ai/v1/voices', params={'type': 'public', 'gender': 'female', 'language': 'en'}, headers={'Authorization': 'Bearer vpk_live_xxxxx'})filtered_data = response.json()print(f"Found {filtered_data['pagination']['total']} female English voices")# Paginate through all cloned voicesdef get_all_voices(voice_type='all'): voices = [] offset = 0 limit = 50 while True: response = requests.get( 'https://api.vibepeak.ai/v1/voices', params={'type': voice_type, 'limit': limit, 'offset': offset}, headers={'Authorization': 'Bearer vpk_live_xxxxx'} ) data = response.json() voices.extend(data['voices']) if not data['pagination']['has_more']: break offset += limit return voices