Eleven Labs

ElevenLabsTools enable an Agent to perform audio generation tasks using ElevenLabs

Prerequisites

You need to install the elevenlabs library and an API key which can be obtained from Eleven Labs

1uv pip install elevenlabs

Set the ELEVEN_LABS_API_KEY environment variable.

1export ELEVEN_LABS_API_KEY=****

Example

The following agent will use Eleven Labs to generate audio based on a user prompt.

1from kern.agent import Agent
2from kern.tools.eleven_labs import ElevenLabsTools
3
4# Create an Agent with the ElevenLabs tool
5agent = Agent(tools=[
6    ElevenLabsTools(
7        voice_id="JBFqnCBsd6RMkjVDRZzb", model_id="eleven_multilingual_v2", target_directory="audio_generations"
8    )
9], name="ElevenLabs Agent")
10
11agent.print_response("Generate a audio summary of the big bang theory", markdown=True)

Toolkit Params

Parameter	Type	Default	Description
`api_key`	`str`	`None`	The Eleven Labs API key for authentication
`voice_id`	`str`	`JBFqnCBsd6RMkjVDRZzb`	The voice ID to use for the audio generation
`target_directory`	`Optional[str]`	`None`	The directory to save the audio file
`model_id`	`str`	`eleven_multilingual_v2`	The model's id to use for the audio generation
`output_format`	`str`	`mp3_44100_64`	The output format to use for the audio generation (check out the docs for more information)
`enable_text_to_speech`	`bool`	`True`	Enable the text_to_speech functionality.
`enable_generate_sound_effect`	`bool`	`True`	Enable the generate_sound_effect functionality.
`enable_get_voices`	`bool`	`True`	Enable the get_voices functionality.
`all`	`bool`	`False`	Enable all functionality.

Toolkit Functions

Function	Description
`text_to_speech`	Convert text to speech
`generate_sound_effect`	Generate sound effect audio from a text prompt.
`get_voices`	Get the list of voices available

Developer Resources

View Tools