Module: ElevenlabsClient

Defined in:
lib/elevenlabs_client.rb,
lib/elevenlabs_client/client.rb,
lib/elevenlabs_client/errors.rb,
lib/elevenlabs_client/version.rb,
lib/elevenlabs_client/settings.rb,
lib/elevenlabs_client/http_client.rb,
lib/elevenlabs_client/configuration.rb,
lib/elevenlabs_client/endpoints/dubs.rb,
lib/elevenlabs_client/endpoints/music.rb,
lib/elevenlabs_client/endpoints/voices.rb,
lib/elevenlabs_client/endpoints/admin/user.rb,
lib/elevenlabs_client/endpoints/admin/usage.rb,
lib/elevenlabs_client/endpoints/admin/models.rb,
lib/elevenlabs_client/endpoints/audio_native.rb,
lib/elevenlabs_client/endpoints/admin/history.rb,
lib/elevenlabs_client/endpoints/admin/samples.rb,
lib/elevenlabs_client/endpoints/text_to_voice.rb,
lib/elevenlabs_client/endpoints/admin/webhooks.rb,
lib/elevenlabs_client/endpoints/speech_to_text.rb,
lib/elevenlabs_client/endpoints/text_to_speech.rb,
lib/elevenlabs_client/endpoints/audio_isolation.rb,
lib/elevenlabs_client/endpoints/forced_alignment.rb,
lib/elevenlabs_client/endpoints/sound_generation.rb,
lib/elevenlabs_client/endpoints/speech_to_speech.rb,
lib/elevenlabs_client/endpoints/text_to_dialogue.rb,
lib/elevenlabs_client/endpoints/admin/voice_library.rb,
lib/elevenlabs_client/endpoints/agents_platform/tests.rb,
lib/elevenlabs_client/endpoints/agents_platform/tools.rb,
lib/elevenlabs_client/endpoints/admin/service_accounts.rb,
lib/elevenlabs_client/endpoints/admin/workspace_groups.rb,
lib/elevenlabs_client/endpoints/agents_platform/agents.rb,
lib/elevenlabs_client/endpoints/admin/workspace_invites.rb,
lib/elevenlabs_client/endpoints/admin/workspace_members.rb,
lib/elevenlabs_client/endpoints/agents_platform/secrets.rb,
lib/elevenlabs_client/endpoints/agents_platform/widgets.rb,
lib/elevenlabs_client/endpoints/admin/workspace_webhooks.rb,
lib/elevenlabs_client/endpoints/websocket_text_to_speech.rb,
lib/elevenlabs_client/endpoints/admin/workspace_resources.rb,
lib/elevenlabs_client/endpoints/agents_platform/llm_usage.rb,
lib/elevenlabs_client/endpoints/agents_platform/workspace.rb,
lib/elevenlabs_client/endpoints/agents_platform/mcp_servers.rb,
lib/elevenlabs_client/endpoints/agents_platform/batch_calling.rb,
lib/elevenlabs_client/endpoints/agents_platform/conversations.rb,
lib/elevenlabs_client/endpoints/agents_platform/phone_numbers.rb,
lib/elevenlabs_client/endpoints/admin/service_account_api_keys.rb,
lib/elevenlabs_client/endpoints/agents_platform/knowledge_base.rb,
lib/elevenlabs_client/endpoints/admin/pronunciation_dictionaries.rb,
lib/elevenlabs_client/endpoints/agents_platform/outbound_calling.rb,
lib/elevenlabs_client/endpoints/agents_platform/test_invocations.rb

Defined Under Namespace

Modules: Admin, Endpoints Classes: APIError, AudioIsolation, AudioNative, AuthenticationError, BadRequestError, Client, Configuration, Dubs, Error, ForbiddenError, ForcedAlignment, HttpClient, NotFoundError, PaymentRequiredError, RateLimitError, ServiceUnavailableError, Settings, SoundGeneration, SpeechToSpeech, SpeechToText, TextToDialogue, TextToSpeech, TextToVoice, TimeoutError, UnprocessableEntityError, ValidationError, Voices, WebSocketTextToSpeech

Constant Summary collapse

VERSION = 
"0.9.0"

Class Method Summary collapse

Class Method Details

.client ⇒ Object

Convenience method to get configured client



84
85
86
 
# File 'lib/elevenlabs_client.rb', line 84

def client
  new
end

.configuration ⇒ Object

Global configuration instance



73
74
75
 
# File 'lib/elevenlabs_client.rb', line 73

def configuration
  @configuration ||= Configuration.new
end

.configure {|configuration| ... } ⇒ Object

Configure the client globally

Yields:



67
68
69
 
# File 'lib/elevenlabs_client.rb', line 67

def configure(&block)
  Settings.configure(&block)
end

.configure_v1 {|Settings| ... } ⇒ Object

Configure the client globally Backward compatibility method

Yields:



119
120
121
 
# File 'lib/elevenlabs_client.rb', line 119

def configure(&block)
  Settings.configure(&block)
end

.health_check ⇒ Hash

Health check for the library

Returns:

  • (Hash) —

    Health status



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/elevenlabs_client.rb', line 99

def health_check
  begin
    client_instance = client
    api_health = client_instance.health_check
    
    {
      status: :ok,
      library_version: VERSION,
      api_health: api_health
    }
  rescue => e
    {
      status: :error,
      error: e.message,
      error_class: e.class.name
    }
  end
end

.new(**options) ⇒ Client

Create a new client instance

Parameters:

  • options (Hash) —

    Client configuration options

Returns:

  • (Client) —

    New client instance



61
62
63
 
# File 'lib/elevenlabs_client.rb', line 61

def new(**options)
  Client.new(**options)
end

.reset_configuration! ⇒ Object

Reset global configuration



78
79
80
 
# File 'lib/elevenlabs_client.rb', line 78

def reset_configuration!
  @configuration = Configuration.new
end

.version_info ⇒ Hash

Get version information

Returns:

  • (Hash) —

    Version and build information



90
91
92
93
94
95
 
# File 'lib/elevenlabs_client.rb', line 90

def version_info
  {
    version: VERSION,
    ruby_version: RUBY_VERSION
  }
end