The official JS API for ElevenLabs text-to-speech software. Eleven brings the most compelling, rich and lifelike voices to creators and developers in just a few lines of code.
Check out the HTTP API documentation.
npm install elevenlabs
# or
yarn add elevenlabs
We support two main models: the newest eleven_multilingual_v2
, a single foundational model supporting 29 languages including English, Chinese, Spanish, Hindi, Portuguese, French, German, Japanese, Arabic, Korean, Indonesian, Italian, Dutch, Turkish, Polish, Swedish, Filipino, Malay, Russian, Romanian, Ukrainian, Greek, Czech, Danish, Finnish, Bulgarian, Croatian, Slovak, and Tamil; and eleven_monolingual_v1
, a low-latency model specifically trained for English speech.
import { ElevenLabsClient, play } from "elevenlabs";
const elevenlabs = new ElevenLabsClient({
apiKey: "YOUR_API_KEY" // Defaults to process.env.ELEVENLABS_API_KEY
})
const audio = await elevenlabs.generate({
voice: "Rachel",
text: "Hello! 你好! Hola! नमस्ते! Bonjour! こんにちは! مرحبا! 안녕하세요! Ciao! Cześć! Привіт! வணக்கம்!",
model_id: "eleven_multilingual_v2"
});
await play(audio);
Play
Don't forget to unmute the player!
audio.3.webm
List all your available voices with voices()
.
import { ElevenLabsClient } from "elevenlabs";
const elevenlabs = new ElevenLabsClient({
apiKey: "YOUR_API_KEY" // Defaults to process.env.ELEVENLABS_API_KEY
})
const voices = await elevenlabs.voices.getAll();
Show output
{
voices: [
{
voice_id: '21m00Tcm4TlvDq8ikWAM',
name: 'Rachel',
samples: null,
category: 'premade',
fine_tuning: [Object],
labels: [Object],
description: null,
preview_url: 'https://storage.googleapis.com/eleven-public-prod/premade/voices/21m00Tcm4TlvDq8ikWAM/df6788f9-5c96-470d-8312-aab3b3d8f50a.mp3',
available_for_tiers: [],
settings: null,
sharing: null,
high_quality_base_model_ids: []
},
{
voice_id: '29vD33N1CtxCmqQRPOHJ',
name: 'Drew',
samples: null,
category: 'premade',
fine_tuning: [Object],
labels: [Object],
description: null,
preview_url: 'https://storage.googleapis.com/eleven-public-prod/premade/voices/29vD33N1CtxCmqQRPOHJ/e8b52a3f-9732-440f-b78a-16d5e26407a1.mp3',
available_for_tiers: [],
settings: null,
sharing: null,
high_quality_base_model_ids: []
},
...
]
}
Stream audio in real-time, as it's being generated.
import { ElevenLabsClient, stream } from "elevenlabs";
const audioStream = await elevenlabs.generate({
stream: true,
voice: "Bella",
text: "This is a... streaming voice",
model_id: "eleven_multilingual_v2"
});
stream(audioStream)
The SDK also exposes an HTTP client that you can use to query our various endpoints directly.
import { ElevenLabsClient, stream } from "@elevenlabs/api";
const models = await eleven.models.getAll();
const audioStream = await elevenlabs.textToSpeech.convert('21m00Tcm4TlvDq8ikWAM', {
text: "This is a... streaming voice!!",
model_id: "eleven_multilingual_v2"
});
stream(audioStream)
All of the ElevenLabs models are nested within the ElevenLabs
namespace.
We support 29 languages and 100+ accents. Explore all languages.
While we value open-source contributions to this SDK, this library is generated programmatically. Additions made directly to this library would have to be moved over to our generation code, otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a proof of concept, but know that we will not be able to merge it as-is. We suggest opening an issue first to discuss with us!
On the other hand, contributions to the README are always very welcome!