Skip to main content


Sinapsis
Sinapsis Elevenlabs

Use hosted ElevenLabs speech generation and speech-to-speech APIs.

Overview

sinapsis-elevenlabs — Generate realistic voices from text, other speeches, and more using the Elevenlabs library.

An API-backed voice service is useful when voice generation or transformation belongs inside a larger Agent. Templates abstract request preparation and map audio results back into Sinapsis data packets.

Where it fits

It needs a provider API key and supported endpoint access. Latency, rate limits and voice/model permissions are controlled by the provider.

Installation

Requires Python 3.13 or later, as declared in this package’s manifest. Install the base distribution using your preferred package manager:

uv pip install sinapsis-elevenlabs
# or
pip install sinapsis-elevenlabs

Optional features and dependencies

The base installation includes the dependencies required by the package. The following extras are declared in this package’s pyproject.toml; install only those needed by your workflow. They are standard Python optional dependencies, not separate execution profiles.

Extra Adds / when to select it
data-tools Media readers/writers or data utilities for a complete pipeline. Dependencies: sinapsis-data-readers, sinapsis-data-writers[soundfile]
all Bundle declared by this package; its manifest includes data-tools.

For example:

uv pip install "sinapsis-elevenlabs[data-tools]"

The manifest also defines development-only dependency groups: dev (pre-commit, ruff, ty). These support source development and testing and are not runtime extras.

🚀 Features

Templates Supported

  • ElevenLabsSTS: Template for transforming a voice into a different character or style using the ElevenLabs Speech-to-Speech API.

    Attributes
    • api_key(Optional): The API key used to authenticate with ElevenLabs' API. Although this parameter is optional in the function signature, the API key must be provided either through this argument or the ELEVENLABS_API_KEY environmental variable. If neither is provided, an error will be logged, and no speech will be generated.
    • model(Optional): The model identifier to use for speech synthesis (default: eleven_multilingual_sts_v2). Options: eleven_english_sts_v2, eleven_multilingual_sts_v2.
    • output_format(Optional): The output audio format and quality (default: mp3_44100_128). Options: mp3_22050_32, mp3_44100_32, mp3_44100_64, mp3_44100_96, mp3_44100_128, mp3_44100_192, pcm_16000, pcm_22050, pcm_24000, pcm_44100, ulaw_8000.
    • output_folder(Optional): The folder where generated audio files will be saved (default: SINAPSIS_CACHE_DIR/elevenlabs/ audios).
    • stream(Optional): If True, the audio is returned as a stream; otherwise, saved to a file (default: False).
    • streaming_latency(Optional): Latency optimization for streaming (default: None).
    • voice(Optional): Voice for speech synthesis. Can be a voice ID (str), name (str), or ElevenLabs voice object (Voice) (default: None).
    • voice_settings(Optional):Dictionary of voice control settings:
      • stability: Controls voice randomness and emotional range (range: 0.0 to 1.0).
      • similarity_boost: Adjusts how closely the voice matches the original (range: 0.0 to 1.0).
      • style: Amplifies the speaker’s style, consuming more resources (range: 0.0 to 1.0).
      • use_speaker_boost: Increases similarity to the speaker with higher computational cost (boolean: True or False).
      • speed: Adjusts speech speed (range: 0.7 to 1.2, default: 1.0).
  • ElevenLabsTTS: Template for converting text into speech using ElevenLabs' voice models.

    Attributes
    • api_key(Optional): The API key used to authenticate with ElevenLabs' API. Although this parameter is optional in the function signature, the API key must be provided either through this argument or the ELEVENLABS_API_KEY environmental variable. If neither is provided, an error will be logged, and no speech will be generated.
    • model(Optional): The model identifier to use for speech synthesis (default: eleven_turbo_v2_5). Options: eleven_turbo_v2_5, eleven_multilingual_v2, eleven_turbo_v2, eleven_monolingual_v1, eleven_multilingual_v1.
    • output_format(Optional): The output audio format and quality (default: mp3_44100_128). Options: mp3_22050_32, mp3_44100_32, mp3_44100_64, mp3_44100_96, mp3_44100_128, mp3_44100_192, pcm_16000, pcm_22050, pcm_24000, pcm_44100, ulaw_8000.
    • output_folder(Optional): The folder where generated audio files will be saved (default: SINAPSIS_CACHE_DIR/elevenlabs/audios).
    • stream(Optional): If True, the audio is returned as a stream; otherwise, saved to a file (default: False).
    • voice(Optional): Voice for speech synthesis. Can be a voice ID (str), name (str), or ElevenLabs voice object (Voice) (default: None).
    • voice_settings(Optional):Dictionary of voice control settings:
      • stability: Controls voice randomness and emotional range (range: 0.0 to 1.0).
      • similarity_boost: Adjusts how closely the voice matches the original (range: 0.0 to 1.0).
      • style: Amplifies the speaker’s style, consuming more resources (range: 0.0 to 1.0).
      • use_speaker_boost: Increases similarity to the speaker with higher computational cost (boolean: True or False).
      • speed: Adjusts speech speed (range: 0.7 to 1.2, default: 1.0).
  • ElevenLabsVoiceClone: Template for creating a synthetic copy of an existing voice using the ElevenLabs API.

    Attributes
    • api_key(Optional): The API key used to authenticate with ElevenLabs' API. Although this parameter is optional in the function signature, the API key must be provided either through this argument or the ELEVENLABS_API_KEY environmental variable. If neither is provided, an error will be logged, and no speech will be generated.
    • description(Optional): Description for the cloned voice (default: None).
    • model(Optional): The model identifier to use for speech synthesis (default: eleven_turbo_v2_5). Options: eleven_turbo_v2_5, eleven_multilingual_v2, eleven_turbo_v2, eleven_monolingual_v1, eleven_multilingual_v1.
    • name(Optional): Name for the cloned voice (default: None). If None, a default name may be used.
    • output_format(Optional): The output audio format and quality (default: mp3_44100_128). Options: mp3_22050_32, mp3_44100_32, mp3_44100_64, mp3_44100_96, mp3_44100_128, mp3_44100_192, pcm_16000, pcm_22050, pcm_24000, pcm_44100, ulaw_8000.
    • output_folder(Optional): The folder where generated audio files will be saved (default: SINAPSIS_CACHE_DIR/elevenlabs/audios).
    • remove_background_noise(Optional): Whether to remove background noise from samples (default: False).
    • stream(Optional): If True, the audio is returned as a stream; otherwise, saved to a file (default: False).
    • voice(Optional): Voice for speech synthesis. Can be a voice ID (str), name (str), or ElevenLabs voice object (Voice) (default: None).
    • voice_description(Required): A description of the voice to be used for synthesis. This field is mandatory and helps to define the voice's characteristics or style.
    • voice_settings(Optional):Dictionary of voice control settings:
      • stability: Controls voice randomness and emotional range (range: 0.0 to 1.0).
      • similarity_boost: Adjusts how closely the voice matches the original (range: 0.0 to 1.0).
      • style: Amplifies the speaker’s style, consuming more resources (range: 0.0 to 1.0).
      • use_speaker_boost: Increases similarity to the speaker with higher computational cost (boolean: True or False).
      • speed: Adjusts speech speed (range: 0.7 to 1.2, default: 1.0).
  • ElevenLabsVoiceGeneration: Template for generating custom synthetic voices based on user-provided descriptions.

    Attributes
    • api_key(Optional): The API key used to authenticate with ElevenLabs' API. Although this parameter is optional in the function signature, the API key must be provided either through this argument or the ELEVENLABS_API_KEY environmental variable. If neither is provided, an error will be logged, and no speech will be generated.
    • model(Optional): The model identifier to use for speech synthesis (default: eleven_turbo_v2_5). Options: eleven_turbo_v2_5, eleven_multilingual_v2, eleven_turbo_v2, eleven_monolingual_v1, eleven_multilingual_v1.
    • output_format(Optional): The output audio format and quality (default: mp3_44100_128). Options: mp3_22050_32, mp3_44100_32, mp3_44100_64, mp3_44100_96, mp3_44100_128, mp3_44100_192, pcm_16000, pcm_22050, pcm_24000, pcm_44100, ulaw_8000.
    • output_folder(Optional): The folder where generated audio files will be saved (default: SINAPSIS_CACHE_DIR/elevenlabs/audios).
    • stream(Optional): If True, the audio is returned as a stream; otherwise, saved to a file (default: False).
    • voice(Optional): Voice for speech synthesis. Can be a voice ID (str), name (str), or ElevenLabs voice object (Voice) (default: None).
    • voice_description(Required): A description of the voice to be used for synthesis. This field is mandatory and helps to define the voice's characteristics or style.
    • voice_settings(Optional):Dictionary of voice control settings:
      • stability: Controls voice randomness and emotional range (range: 0.0 to 1.0).
      • similarity_boost: Adjusts how closely the voice matches the original (range: 0.0 to 1.0).
      • style: Amplifies the speaker’s style, consuming more resources (range: 0.0 to 1.0).
      • use_speaker_boost: Increases similarity to the speaker with higher computational cost (boolean: True or False).
      • speed: Adjusts speech speed (range: 0.7 to 1.2, default: 1.0).

For example, for ElevenLabsTTS use sinx templates example-config ElevenLabsTTS to produce an example config like:

agent:
  name: my_sinapsis_elevenlabs_agent
templates:
- template_name: InputTemplate
  class_name: InputTemplate
  attributes: {}
- template_name: ElevenLabsTTS
  class_name: ElevenLabsTTS
  template_input: InputTemplate
  attributes:
    api_key: null
    voice: null
    voice_settings:
      stability: null
      similarity_boost: null
      style: null
      use_speaker_boost: null
      speed: null
    model: eleven_turbo_v2_5
    output_format: mp3_44100_128
    output_folder: ~/.cache/sinapsis/elevenlabs/audios
    stream: false

Example Agent

The following is adapted directly from the package’s shipped voice_generation_demo.yaml configuration. Save it as my_elevenlabs_agent.yaml. The example may require model checkpoints, input files, additional Template packages, or provider credentials as described in its configuration.

agent:
  name: my_elevenlabs_agent
  description: voice generation agent using Elevenlabs

templates:
- template_name: InputTemplate
  class_name: InputTemplate
  attributes: {}

- template_name: ElevenLabsVoiceGeneration
  class_name: ElevenLabsVoiceGeneration
  template_input: InputTemplate
  attributes:
    voice_description: A clear and professional British middle-aged male voice, smooth and well-spoken. Perfect for narrations, audiobooks, and corporate content, offering a balanced and engaging delivery.
sinx jobs run my_elevenlabs_agent.yaml

More configurations: voice_generation_demo.yaml, elevenlabs_tts_demo.yaml, elevenlabs_voice_clone_demo.yaml, elevenlabs_sts_demo.yaml, elevenlabs_voice_generation.yaml, elevenlabs_tts.yaml, elevenlabs_voice_clone.yaml, elevenlabs_sts.yaml.

Documentation

License

Sinapsis open-source components are available under your choice of the MIT License or the Apache License 2.0, unless otherwise noted.

Metadata

Release files for sinapsis-elevenlabs 1.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for sinapsis-elevenlabs 1.0.0
File Size Uploaded Provenance Actions
sinapsis_elevenlabs-1.0.0.tar.gz 78.7 kB Without provenance Details for sinapsis_elevenlabs-1.0.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for sinapsis-elevenlabs 1.0.0
File Interpreter ABI Platform Actions
sinapsis_elevenlabs-1.0.0-py3-none-any.whl Python 3 none any Details for sinapsis_elevenlabs-1.0.0-py3-none-any.whl

Total release size: 104.1 kB

Release files / sinapsis_elevenlabs-1.0.0.tar.gz

Download URL sinapsis_elevenlabs-1.0.0.tar.gz
Size 78.7 kB
Tags Source
SHA-256 checksum
How to use checksums
e4d4777316831de6e4b06edec285e173081512fdb537273638c1b62db233104c
BLAKE2b-256 checksum
How to use checksums
9305260f7b3c2d610ea01343ef8ec1010f5eb7f9e9c7e2a050c1c918c632001b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.6.17

Release files / sinapsis_elevenlabs-1.0.0-py3-none-any.whl

Download URL sinapsis_elevenlabs-1.0.0-py3-none-any.whl
Size 25.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
2feafc4e59a170259ef58df0fbeead87999aab9dc700ac7cd9375eab0ea18561
BLAKE2b-256 checksum
How to use checksums
7253d851985b13160f477a291cd4df5920604bc529885f27d6300bae85426105
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.6.17

Security for sinapsis-elevenlabs 1.0.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page