Skip to main content

Complete python wrapper for the elevenlabs API

Project description

elevenlabslib

Buy Me a Coffee at ko-fi.com PyPI - Downloads PyPI GitHub last commit

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.

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 repo for more information.

Usage

For a far more comprehensive example, check example.py or the docs.

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
from elevenlabslib import *

user = ElevenLabsUser("API_KEY")
voice = user.get_voices_by_name("Rachel")[0]  # This is a list because multiple voices can have the same name

voice.play_preview(playInBackground=False)

voice.generate_play_audio("Test.", playInBackground=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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

elevenlabslib-0.9.3.tar.gz (22.5 kB view hashes)

Uploaded Source

Built Distribution

elevenlabslib-0.9.3-py3-none-any.whl (24.3 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page