Installation
JavaScript / TypeScript
npm install @elevenlabs/elevenlabs-jsImportant: Always use
@elevenlabs/elevenlabs-js. The oldelevenlabsnpm package (v1.x) is deprecated and should not be used.
import { ElevenLabsClient } from "@elevenlabs/elevenlabs-js";
// Option 1: Environment variable (recommended)
// Set ELEVENLABS_API_KEY in your environment
const client = new ElevenLabsClient();
// Option 2: Pass directly
const client = new ElevenLabsClient({ apiKey: "your-api-key" });Migrating from deprecated packages
If you have old packages installed, remove them:
# Remove deprecated packages
npm uninstall elevenlabs
# Install the current packages
npm install @elevenlabs/elevenlabs-jsImport changes:
// OLD (deprecated)
import { ElevenLabsClient } from "elevenlabs";
// NEW (current)
import { ElevenLabsClient } from "@elevenlabs/elevenlabs-js";Python
pip install elevenlabsfrom elevenlabs import ElevenLabs
# Option 1: Environment variable (recommended)
# Set ELEVENLABS_API_KEY in your environment
client = ElevenLabs()
# Option 2: Pass directly
client = ElevenLabs(api_key="your-api-key")cURL / REST API
Set your API key as an environment variable:
export ELEVENLABS_API_KEY="your-api-key"Include in requests via the xi-api-key header:
curl -X POST "https://api.elevenlabs.io/v1/text-to-speech/{voice_id}" \
-H "xi-api-key: $ELEVENLABS_API_KEY" \
-H "Content-Type: application/json" \
-d '{"text": "Hello world", "model_id": "eleven_multilingual_v2"}'Getting an API Key
- Sign up at elevenlabs.io
- Go to API Keys
- Click Create API Key
- Copy and store securely
Or use the setup-api-key skill for guided setup.
Environment Variables
| Variable | Description |
|---|---|
ELEVENLABS_API_KEY |
Your ElevenLabs API key (required) |