Merge branch 'main' into api-options

Author: satendra02

.github/workflows/ci.yml

@@ -3,14 +3,14 @@ name: ci
 on: [push]
 jobs:
   compile:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-24.04
     steps:
       - name: Checkout repo
         uses: actions/checkout@v3
       - name: Set up python
         uses: actions/setup-python@v4
         with:
-          python-version: 3.7
+          python-version: 3.8
       - name: Bootstrap poetry
         run: |
           curl -sSL https://install.python-poetry.org | python - -y --version 1.5.1
@@ -19,14 +19,14 @@ jobs:
       - name: Compile
         run: poetry run mypy .
   test:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-24.04
     steps:
       - name: Checkout repo
         uses: actions/checkout@v3
       - name: Set up python
         uses: actions/setup-python@v4
         with:
-          python-version: 3.7
+          python-version: 3.8
       - name: Bootstrap poetry
         run: |
           curl -sSL https://install.python-poetry.org | python - -y --version 1.5.1
@@ -36,19 +36,19 @@ jobs:
       - name: Test
         run: poetry run pytest .
         env:
-          ELEVEN_API_KEY: ${{ secrets.TEST_API_KEY }}
+          ELEVENLABS_API_KEY: ${{ secrets.ELEVENLABS_API_KEY }}
 
   publish:
     needs: [compile, test]
     if: github.event_name == 'push' && contains(github.ref, 'refs/tags/')
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-24.04
     steps:
       - name: Checkout repo
         uses: actions/checkout@v3
       - name: Set up python
         uses: actions/setup-python@v4
         with:
-          python-version: 3.7
+          python-version: 3.8
       - name: Bootstrap poetry
         run: |
           curl -sSL https://install.python-poetry.org | python - -y --version 1.5.1

.github/workflows/tests.yml

@@ -3,7 +3,7 @@ name: Test SDK
 on: [push]
 jobs:
   compile:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-24.04
     steps:
       - name: Checkout repo
         uses: actions/checkout@v3
@@ -19,7 +19,7 @@ jobs:
       - name: Compile
         run: poetry run mypy .
   test:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-24.04
     steps:
       - name: Checkout repo
         uses: actions/checkout@v3
@@ -38,6 +38,6 @@ jobs:
 
       - name: Test
         env:
-          ELEVEN_API_KEY: ${{ secrets.TEST_API_KEY }}
+          ELEVENLABS_API_KEY: ${{ secrets.ELEVENLABS_API_KEY }}
         run: |
-            poetry run pytest .
+          poetry run pytest .

.gitignore

@@ -3,4 +3,3 @@ dist/
 __pycache__/
 poetry.toml
 .ruff_cache/
-.DS_Store

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 Elevenlabs.
+Copyright (c) 2025 Elevenlabs.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -41,18 +41,21 @@ pip install elevenlabs
 For more detailed information about these models and others, visit the [ElevenLabs Models documentation](https://elevenlabs.io/docs/speech-synthesis/models).
 
 ```py
-from elevenlabs import play
+from dotenv import load_dotenv
 from elevenlabs.client import ElevenLabs
+from elevenlabs import play
 
-client = ElevenLabs(
-  api_key="YOUR_API_KEY", # Defaults to ELEVEN_API_KEY or ELEVENLABS_API_KEY
-)
+load_dotenv()
 
-audio = client.generate(
-  text="Hello! 你好! Hola! नमस्ते! Bonjour! こんにちは! مرحبا! 안녕하세요! Ciao! Cześć! Привіт! வணக்கம்!",
-  voice="Brian",
-  model="eleven_multilingual_v2"
+client = ElevenLabs()
+
+audio = client.text_to_speech.convert(
+    text="The first move is what sets everything in motion.",
+    voice_id="JBFqnCBsd6RMkjVDRZzb",
+    model_id="eleven_multilingual_v2",
+    output_format="mp3_44100_128",
 )
+
 play(audio)
 ```
 
@@ -70,11 +73,10 @@ List all your available voices with `voices()`.
 from elevenlabs.client import ElevenLabs
 
 client = ElevenLabs(
-  api_key="YOUR_API_KEY", # Defaults to ELEVEN_API_KEY or ELEVENLABS_API_KEY
+  api_key="YOUR_API_KEY",
 )
 
 response = client.voices.get_all()
-audio = client.generate(text="Hello there!", voice=response.voices[0])
 print(response.voices)
 ```
 
@@ -83,25 +85,6 @@ For information about the structure of the voices output, please refer to the [o
 Build a voice object with custom settings to personalize the voice style, or call
 `client.voices.get_settings("your-voice-id")` to get the default settings for the voice.
 
-```py
-from elevenlabs import Voice, VoiceSettings, play
-from elevenlabs.client import ElevenLabs
-
-client = ElevenLabs(
-  api_key="YOUR_API_KEY", # Defaults to ELEVEN_API_KEY or ELEVENLABS_API_KEY
-)
-
-audio = client.generate(
-    text="Hello! My name is Brian.",
-    voice=Voice(
-        voice_id='nPczCjzI2devNBz1zQrb',
-        settings=VoiceSettings(stability=0.71, similarity_boost=0.5, style=0.0, use_speaker_boost=True)
-    )
-)
-
-play(audio)
-```
-
 </details>
 
 ## Clone Voice
@@ -113,42 +96,41 @@ from elevenlabs.client import ElevenLabs
 from elevenlabs import play
 
 client = ElevenLabs(
-  api_key="YOUR_API_KEY", # Defaults to ELEVEN_API_KEY or ELEVENLABS_API_KEY
+  api_key="YOUR_API_KEY", # Defaults ELEVENLABS_API_KEY
 )
 
 voice = client.clone(
     name="Alex",
     description="An old American male voice with a slight hoarseness in his throat. Perfect for news", # Optional
     files=["./sample_0.mp3", "./sample_1.mp3", "./sample_2.mp3"],
 )
-
-audio = client.generate(text="Hi! I'm a cloned voice!", voice=voice)
-
-play(audio)
 ```
 
 ## 🚿 Streaming
 
 Stream audio in real-time, as it's being generated.
 
 ```py
-from elevenlabs.client import ElevenLabs
 from elevenlabs import stream
+from elevenlabs.client import ElevenLabs
 
-client = ElevenLabs(
-  api_key="YOUR_API_KEY", # Defaults to ELEVEN_API_KEY or ELEVENLABS_API_KEY
-)
+client = ElevenLabs()
 
-audio_stream = client.generate(
-  text="This is a... streaming voice!!",
-  stream=True
+audio_stream = client.text_to_speech.convert_as_stream(
+    text="This is a test",
+    voice_id="JBFqnCBsd6RMkjVDRZzb",
+    model_id="eleven_multilingual_v2"
 )
 
+# option 1: play the streamed audio locally
 stream(audio_stream)
-```
 
-Note that `generate` is a helper function. If you'd like to access
-the raw method, simply use `client.text_to_speech.convert_as_stream`.
+# option 2: process the audio bytes manually
+for chunk in audio_stream:
+    if isinstance(chunk, bytes):
+        print(chunk)
+
+```
 
 ### Input streaming
 
@@ -159,7 +141,7 @@ from elevenlabs.client import ElevenLabs
 from elevenlabs import stream
 
 client = ElevenLabs(
-  api_key="YOUR_API_KEY", # Defaults to ELEVEN_API_KEY or ELEVENLABS_API_KEY
+  api_key="YOUR_API_KEY", # Defaults to ELEVENLABS_API_KEY
 )
 
 def text_stream():
@@ -176,9 +158,6 @@ audio_stream = client.generate(
 stream(audio_stream)
 ```
 
-Note that `generate` is a helper function. If you'd like to access
-the raw method, simply use `client.text_to_speech.convert_realtime`.
-
 ## Async Client
 
 Use `AsyncElevenLabs` if you want to make API calls asynchronously.
@@ -189,7 +168,7 @@ import asyncio
 from elevenlabs.client import AsyncElevenLabs
 
 eleven = AsyncElevenLabs(
-  api_key="MY_API_KEY" # Defaults to ELEVEN_API_KEY or ELEVENLABS_API_KEY
+  api_key="MY_API_KEY" # Defaults to ELEVENLABS_API_KEY
 )
 
 async def print_models() -> None: