ElevenLabs JS Library

LOGO

Note: This is the Node.js library for ElevenLabs. For the browser SDK, visit @11labs/client. For the React SDK, check out @11labs/react.

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.

📖 API & Docs

Check out the HTTP API documentation.

⚙️ Install

npm install elevenlabs
# or
yarn add elevenlabs

🗣️ Usage

Main Models

Eleven Multilingual v2 (eleven_multilingual_v2)
- Excels in stability, language diversity, and accent accuracy
- Supports 29 languages
- Recommended for most use cases
Eleven Turbo v2.5 (eleven_turbo_v2_5)
- High quality, lowest latency
- Ideal for developer use cases where speed is crucial
- Supports 32 languages

For more detailed information about these models and others, visit the ElevenLabs Models documentation.

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: "Sarah",
    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](https://github.com/elevenlabs/elevenlabs-python/assets/12028621/778fd3ed-0a3a-4d66-8f73-faee099dfdd6)

⚠️ elevenlabs-js requires MPV and ffmpeg.

🗣️ Voices

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();

For information about the structure of the voices output, please refer to the official ElevenLabs API documentation for Get Voices.

🚿 Streaming

Stream audio in real-time, as it's being generated.

const audioStream = await elevenlabs.generate({
    stream: true,
    voice: "Bella",
    text: "This is a... streaming voice",
    model_id: "eleven_multilingual_v2",
});

stream(audioStream);

Retries

This Node SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long as the request is deemed retriable and the number of retry attempts has not grown larger than the configured retry limit (default: 2).

A request is deemed retriable when any of the following HTTP status codes is returned:

408 (Timeout)
409 (Conflict)
429 (Too Many Requests)
5XX (Internal Server Errors)

Use the maxRetries request option to configure this behavior.

const response = await elevenlabs.voices.getAll({}, {
  maxRetries: 2 // Set the maximum number of retries
});

Timeouts

The SDK defaults to a 60 second timout. Use the timeoutInSeconds option to configure this behavior.

const response = await elevenlabs.voices.getAll({}, {
    timeoutInSeconds: 30, // override timeout to 30s
});

Runtime compatiblity

The SDK defaults to node-fetch but will use the global fetch client if present. The SDK works in the following runtimes:

The following runtimes are supported:

Node.js 15+
Vercel
Cloudflare Workers
Deno v1.25+
Bun 1.0+

Elevenlabs Namespace

All of the ElevenLabs models are nested within the ElevenLabs namespace.

Alt text

Languages Supported

We support 32 languages and 100+ accents. Explore all languages.