Skip to main content
POST
/
add-community-voice
JavaScript
import Retell from 'retell-sdk';

const client = new Retell({
  apiKey: 'YOUR_RETELL_API_KEY',
});

const voiceResponse = await client.voice.addResource({
  provider_voice_id: 'provider_voice_id',
  voice_name: 'x',
});

console.log(voiceResponse.provider);
{
  "voice_id": "retell-Cimo",
  "voice_name": "Adrian",
  "provider": "elevenlabs",
  "gender": "male",
  "accent": "American",
  "age": "Young",
  "preview_audio_url": "https://retell-utils-public.s3.us-west-2.amazonaws.com/adrian.mp3"
}

Authorizations

​
Authorization
string
header
required

Authentication header containing API key (find it in dashboard). The format is "Bearer YOUR_API_KEY"

Body

application/json
​
provider_voice_id
string
required

Voice id assigned by the provider.

​
voice_name
string
required

A custom name for the voice.

Required string length: 1 - 200
​
voice_provider
enum<string>

Voice provider to add the voice from.

Available options:
elevenlabs,
cartesia,
minimax,
fish_audio
​
public_user_id
string

Required for ElevenLabs only. User id of the voice owner.

Response

Community voice added successfully

​
voice_id
string
required

Unique id for the voice.

Example:

"retell-Cimo"

​
voice_name
string
required

Name of the voice.

Example:

"Adrian"

​
provider
enum<string>
required

Indicates the provider of voice.

Available options:
elevenlabs,
openai,
deepgram,
cartesia,
minimax,
fish_audio,
platform
Example:

"elevenlabs"

​
gender
enum<string>
required

Gender of voice.

Available options:
male,
female
Example:

"male"

​
accent
string

Accent annotation of the voice.

Example:

"American"

​
age
string

Age annotation of the voice.

Example:

"Young"

​
preview_audio_url
string

URL to the preview audio of the voice.

Example:

"https://retell-utils-public.s3.us-west-2.amazonaws.com/adrian.mp3"