Class ElevenLabsVoicesApi

java.lang.Object

org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi

public class ElevenLabsVoicesApi
extends Object

Client for the ElevenLabs Voices API.

Author:

Alexandros Pappas

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ElevenLabsVoicesApi.Builder	Builder to construct ElevenLabsVoicesApi instance.
static enum	ElevenLabsVoicesApi.CategoryEnum
static final record	ElevenLabsVoicesApi.FineTuning
static final record	ElevenLabsVoicesApi.ManualVerification
static final record	ElevenLabsVoicesApi.ManualVerificationFile
static final record	ElevenLabsVoicesApi.ReaderResource
static final record	ElevenLabsVoicesApi.Recording
static enum	ElevenLabsVoicesApi.SafetyControlEnum
static final record	ElevenLabsVoicesApi.Sample
static final record	ElevenLabsVoicesApi.VerificationAttempt
static final record	ElevenLabsVoicesApi.VerifiedVoiceLanguage
static final record	ElevenLabsVoicesApi.Voice	Represents a single voice from the ElevenLabs API.
static final record	ElevenLabsVoicesApi.Voices	Represents the response from the /v1/voices endpoint.
static final record	ElevenLabsVoicesApi.VoiceSettings
static final record	ElevenLabsVoicesApi.VoiceSharing
static final record	ElevenLabsVoicesApi.VoiceSharingModerationCheck
static final record	ElevenLabsVoicesApi.VoiceVerification

Constructor Summary

Constructors

Constructor	Description
ElevenLabsVoicesApi(String baseUrl, ApiKey apiKey, org.springframework.http.HttpHeaders headers, org.springframework.web.client.RestClient.Builder restClientBuilder, org.springframework.web.client.ResponseErrorHandler responseErrorHandler)	Create a new ElevenLabs Voices API client.
ElevenLabsVoicesApi(org.springframework.web.client.RestClient restClient)	Create a new ElevenLabs Voices API client.

Method Summary

Modifier and Type	Method	Description
static ElevenLabsVoicesApi.Builder	builder()
org.springframework.http.ResponseEntity<ElevenLabsVoicesApi.VoiceSettings>	getDefaultVoiceSettings()	Gets the default settings for voices.
org.springframework.http.ResponseEntity<ElevenLabsVoicesApi.Voice>	getVoice(String voiceId)	Returns metadata about a specific voice.
org.springframework.http.ResponseEntity<ElevenLabsVoicesApi.Voices>	getVoices()	Retrieves a list of all available voices from the ElevenLabs API.
org.springframework.http.ResponseEntity<ElevenLabsVoicesApi.VoiceSettings>	getVoiceSettings(String voiceId)	Returns the settings for a specific voice.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ElevenLabsVoicesApi

public ElevenLabsVoicesApi(String baseUrl,
 ApiKey apiKey,
 org.springframework.http.HttpHeaders headers,
 org.springframework.web.client.RestClient.Builder restClientBuilder,
 org.springframework.web.client.ResponseErrorHandler responseErrorHandler)

Create a new ElevenLabs Voices API client.

Parameters:

baseUrl - The base URL for the ElevenLabs API.

apiKey - Your ElevenLabs API key.

headers - the http headers to use.

restClientBuilder - A builder for the Spring RestClient.

responseErrorHandler - A custom error handler for API responses.

ElevenLabsVoicesApi

public ElevenLabsVoicesApi(org.springframework.web.client.RestClient restClient)

Create a new ElevenLabs Voices API client.

Parameters:

restClient - Spring RestClient instance.

Method Details

builder

public static ElevenLabsVoicesApi.Builder builder()

getVoices

public org.springframework.http.ResponseEntity<ElevenLabsVoicesApi.Voices> getVoices()

Retrieves a list of all available voices from the ElevenLabs API.

Returns:

A ResponseEntity containing a Voices object, which contains the list of voices.

getDefaultVoiceSettings

public org.springframework.http.ResponseEntity<ElevenLabsVoicesApi.VoiceSettings> getDefaultVoiceSettings()

Gets the default settings for voices. "similarity_boost" corresponds to ”Clarity + Similarity Enhancement” in the web app and "stability" corresponds to "Stability" slider in the web app.

Returns:

ResponseEntity containing the ElevenLabsVoicesApi.VoiceSettings record.

getVoiceSettings

public org.springframework.http.ResponseEntity<ElevenLabsVoicesApi.VoiceSettings> getVoiceSettings(String voiceId)

Returns the settings for a specific voice. "similarity_boost" corresponds to "Clarity + Similarity Enhancement" in the web app and "stability" corresponds to the "Stability" slider in the web app.

Parameters:

voiceId - The ID of the voice to get settings for. Required.

Returns:

ResponseEntity containing the ElevenLabsVoicesApi.VoiceSettings record.

getVoice

public org.springframework.http.ResponseEntity<ElevenLabsVoicesApi.Voice> getVoice(String voiceId)

Returns metadata about a specific voice.

Parameters:

voiceId - ID of the voice to be used. You can use the Get voices endpoint list all the available voices. Required.

Returns:

ResponseEntity containing the ElevenLabsVoicesApi.Voice record.