https://github.com/lugia19/elevenlabslib
Full python wrapper for the elevenlabs API.
https://github.com/lugia19/elevenlabslib
api-wrapper elevenlabs python text-to-speech tts
Last synced: 11 days ago
JSON representation
Full python wrapper for the elevenlabs API.
- Host: GitHub
- URL: https://github.com/lugia19/elevenlabslib
- Owner: lugia19
- License: mit
- Created: 2023-02-17T22:33:30.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2025-03-02T01:12:32.000Z (8 months ago)
- Last Synced: 2025-05-09T10:07:38.165Z (5 months ago)
- Topics: api-wrapper, elevenlabs, python, text-to-speech, tts
- Language: Python
- Homepage:
- Size: 559 KB
- Stars: 157
- Watchers: 3
- Forks: 28
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# elevenlabslib
Python wrapper for the full elevenlabs API.
### NOTE: There's now an official wrapper, but this project will continue to be maintained.
The main reason is the different approach to playback. By doing playback purely within python instead of piping to an external process, there are a couple of important extra things that can be done, such as:
- Playback on a specific output device
- Running functions exactly when the playback begins and ends
- Controlling the playback from within python
### **Documentation now available at https://elevenlabslib.readthedocs.io/en/latest/**
# Installation
Just run `pip install elevenlabslib`, it's on [pypi](https://pypi.org/project/elevenlabslib/).
Note: On Linux, you may need to install portaudio. On debian and derivatives, it's `sudo apt-get install libportaudio2`, and possibly also `sudo apt-get install python3-pyaudio`.
**IMPORTANT**: The library requires libsndfile `v1.1.0` or newer, as that is when mp3 support was introduced. This won't be an issue on Windows, but may be relevant on other platforms. Check the [soundfile](https://github.com/bastibe/python-soundfile#installation) repo for more information.
# Usage
For a far more comprehensive example, check [example.py](https://github.com/lugia19/elevenlabslib/blob/master/example.py) or [the docs](https://elevenlabslib.readthedocs.io/en/latest/).
Here is a very simple usage sample.
- Retrieves a voice based on the name
- Plays back (using the included playback functions that use sounddevice) all its samples (and the preview)
- Generates and plays back a new audio
- Deletes the newly created audio from the user history
```py
from elevenlabslib import *
user = User("API_KEY")
voice = user.get_voices_by_name_v2("Rachel")[0] # This is a list because multiple voices can have the same name
voice.generate_play_audio_v2("Test.", playbackOptions=PlaybackOptions(runInBackground=False))
for historyItem in user.get_history_items_paginated():
if historyItem.text == "Test.":
# The first items are the newest, so we can stop as soon as we find one.
historyItem.delete()
break
```