runapi-elevenlabs 0.2.6 → 0.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2229b7034723a96b61a1e969d19787c9765f713c50c6ef6fe14c1b75678d5807
-  data.tar.gz: 7d95a8156738a7b4c503320c77f6e49f917e88239d5664a85cc79efca740a93e
+  metadata.gz: 6ca6826a8bff9028eb05ea1e9bd629b04e9351d7180975e850273fad2bee2785
+  data.tar.gz: 9be4ec71de7f881583737af7a5badc4961aa57d36c4c20a6d8c764c2a3634b3e
 SHA512:
-  metadata.gz: 664cda394dfc9e26655b26f41c8267fb60f55e1c50b6c9bcbca6d55f3aec28e91a64b3e48bf0fb57348b8a5cc0042596e133787cfe33407777ed4bc7e523069d
-  data.tar.gz: '0781f940b42c14ed9b87a2992b6345f15679d9da86622e938c312f6f626cb3ff700ff6efac92871f6d6331302bd5ce38ca790e391106510e12779bff5bfe4e84'
+  metadata.gz: 7c8f2a8795d4a78ab60d02c9319e3b85e20905b8a5ae890bb65b3f5641dbf862a90728e16c9b6aee688418a9e0b86ecaea52872503a426ef33d56a163971ac65
+  data.tar.gz: 552966e452b88bebabe28bcc213bfbbe444b335c27a900823cd5d12d54c0217bbf04166c623d34dbc1e11478dbefd95a046c2061dea9b433fe9e460ee972a212

data/README.md

@@ -1,8 +1,8 @@
-# Elevenlabs API Ruby SDK for RunAPI
+# ElevenLabs Ruby SDK for RunAPI
 
-The elevenlabs api Ruby SDK is the language-specific package for ElevenLabs on RunAPI. Use this elevenlabs api package for voice, dialogue, transcription, sound effect, and cleanup flows when your application needs JSON request bodies, task status lookup, and consistent RunAPI errors in Ruby.
+The ElevenLabs Ruby SDK is the language-specific package for ElevenLabs on RunAPI. Use this package for voice, dialogue, transcription, sound effect, and audio cleanup workflows when your application needs request bodies, task status lookup, and consistent RunAPI errors in Ruby.
 
-This elevenlabs api README is the Ruby package guide inside the public `elevenlabs-sdk` repository. For the repository overview, start at `../README.md`; for model details, use https://runapi.ai/models/elevenlabs; for API reference, use https://runapi.ai/docs#elevenlabs; for SDK docs, use https://runapi.ai/docs#sdk-elevenlabs.
+This README is the Ruby package guide inside the public `elevenlabs-sdk` repository. For the repository overview, start at `../README.md`; for model details, use https://runapi.ai/models/elevenlabs; for API reference, use https://runapi.ai/docs#elevenlabs; for SDK docs, use https://runapi.ai/docs#sdk-elevenlabs.
 
 ## Install
 
@@ -13,20 +13,22 @@ gem install runapi-elevenlabs
 ## Quick start
 
 ```ruby
-require "runapi-elevenlabs"
+require "runapi/elevenlabs"
 
 client = RunApi::Elevenlabs::Client.new
-task = client.speeches.create(
+task = client.text_to_speech.create(
   # Pass the ElevenLabs JSON request body from https://runapi.ai/docs#elevenlabs.
 )
-status = client.speeches.get(task.id)
+status = client.text_to_speech.get(task.id)
 ```
 
 Use `create` when you want to submit a task and return quickly, `get` when you need the latest task state, and `run` when a script should create and poll until completion. In web request handlers, prefer `create` plus webhook or later `get` polling so a worker is not held open.
 
+RunAPI-generated file URLs are temporary. Download and store generated images, videos, audio, or other files in your own durable storage within 7 days; do not treat returned URLs as long-term assets.
+
 ## Language notes
 
-Use Ruby keyword arguments and the `RunApi::Elevenlabs` error classes when building audio jobs, Rails workers, or scripts. The available resources include speeches, dialogues, sound effects, transcriptions, and audio isolations. Keep `RUNAPI_API_KEY` in the environment or your secret manager; never commit API keys or callback secrets.
+Use Ruby keyword arguments and the `RunApi::Elevenlabs` error classes when building audio jobs, Rails workers, or scripts. The available resources are `text_to_speech`, `text_to_dialogue`, `text_to_sound`, `speech_to_text`, and `isolate_audio`. Keep `RUNAPI_API_KEY` in the environment or your secret manager; never commit API keys or callback secrets.
 
 ## Links
 

data/lib/runapi/elevenlabs/client.rb

@@ -2,14 +2,30 @@
 
 module RunApi
   module Elevenlabs
-    class Client
-      attr_reader :text_to_speech, :text_to_dialogue, :text_to_sound, :speech_to_text, :isolate_audio
+    # ElevenLabs audio API client for speech synthesis, multi-speaker dialogue,
+    # sound effects, transcription, and vocal isolation.
+    #
+    # @example
+    #   client = RunApi::Elevenlabs::Client.new(api_key: "sk-...")
+    #   result = client.text_to_speech.run(
+    #     model: "text-to-speech-turbo-v2.5",
+    #     text: "Hello, world!"
+    #   )
+    #   puts result.audios.first.url
+    class Client < RunApi::Core::Client
+      # @return [Resources::TextToSpeech] Single-speaker speech synthesis operations.
+      attr_reader :text_to_speech
+      # @return [Resources::TextToDialogue] Multi-speaker dialogue synthesis operations.
+      attr_reader :text_to_dialogue
+      # @return [Resources::TextToSound] Sound effect generation operations.
+      attr_reader :text_to_sound
+      # @return [Resources::SpeechToText] Audio transcription operations.
+      attr_reader :speech_to_text
+      # @return [Resources::IsolateAudio] Vocal isolation operations.
+      attr_reader :isolate_audio
 
       def initialize(api_key: nil, **options)
-        @api_key = Core::Auth.resolve_api_key(api_key)
-
-        client_options = Core::ClientOptions.new(api_key: @api_key, **options)
-        http = client_options.http_client || Core::HttpClient.new(client_options)
+        super
 
         @text_to_speech = Resources::TextToSpeech.new(http)
         @text_to_dialogue = Resources::TextToDialogue.new(http)

data/lib/runapi/elevenlabs/contract_gen.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module RunApi
+  module Elevenlabs
+    CONTRACT = {
+      "isolate-audio" => {
+        "models" => ["audio-isolation"],
+        "fields_by_model" => {
+          "audio-isolation" => {
+            "source_audio_url" => {
+              "required" => true
+            }
+          }
+        }
+      },
+      "speech-to-text" => {
+        "models" => ["speech-to-text"],
+        "fields_by_model" => {
+          "speech-to-text" => {
+            "source_audio_url" => {
+              "required" => true
+            }
+          }
+        }
+      },
+      "text-to-dialogue" => {
+        "models" => ["text-to-dialogue-v3"],
+        "fields_by_model" => {
+          "text-to-dialogue-v3" => {
+            "dialogue" => {
+              "required" => true
+            },
+            "stability" => {
+              "enum" => [0.0, 0.5, 1.0]
+            }
+          }
+        }
+      },
+      "text-to-sound" => {
+        "models" => ["sound-effect-v2"],
+        "fields_by_model" => {
+          "sound-effect-v2" => {
+            "output_format" => {
+              "enum" => ["mp3_22050_32", "mp3_44100_32", "mp3_44100_64", "mp3_44100_96", "mp3_44100_128", "mp3_44100_192", "pcm_8000", "pcm_16000", "pcm_22050", "pcm_24000", "pcm_44100", "pcm_48000", "ulaw_8000", "alaw_8000", "opus_48000_32", "opus_48000_64", "opus_48000_96", "opus_48000_128", "opus_48000_192"]
+            },
+            "text" => {
+              "required" => true
+            }
+          }
+        }
+      },
+      "text-to-speech" => {
+        "models" => ["text-to-speech-multilingual-v2", "text-to-speech-turbo-v2.5"],
+        "fields_by_model" => {
+          "text-to-speech-multilingual-v2" => {
+            "text" => {
+              "required" => true
+            }
+          },
+          "text-to-speech-turbo-v2.5" => {
+            "text" => {
+              "required" => true
+            }
+          }
+        },
+        "rules" => [{
+          "when" => {
+            "model" => "text-to-speech-multilingual-v2"
+          },
+          "required" => ["voice"]
+        }]
+      }
+    }.freeze
+  end
+end

data/lib/runapi/elevenlabs/resources/isolate_audio.rb

@@ -14,19 +14,19 @@ module RunApi
           @http = http
         end
 
-        def run(**params)
-          task = create(**params)
-          poll_until_complete { get(task.id) }
+        def run(options: nil, **params)
+          task = create(options: options, **params)
+          poll_until_complete { get(task.id, options: options) }
         end
 
-        def create(**params)
+        def create(options: nil, **params)
           params = compact_params(params)
           raise Core::ValidationError, "source_audio_url is required" unless param(params, :source_audio_url)
-          request(:post, ENDPOINT, body: params)
+          request(:post, ENDPOINT, body: params, options: options)
         end
 
-        def get(id)
-          request(:get, "#{ENDPOINT}/#{id}")
+        def get(id, options: nil)
+          request(:get, "#{ENDPOINT}/#{id}", options: options)
         end
       end
     end

data/lib/runapi/elevenlabs/resources/speech_to_text.rb

@@ -14,19 +14,19 @@ module RunApi
           @http = http
         end
 
-        def run(**params)
-          task = create(**params)
-          poll_until_complete { get(task.id) }
+        def run(options: nil, **params)
+          task = create(options: options, **params)
+          poll_until_complete { get(task.id, options: options) }
         end
 
-        def create(**params)
+        def create(options: nil, **params)
           params = compact_params(params)
           raise Core::ValidationError, "source_audio_url is required" unless param(params, :source_audio_url)
-          request(:post, ENDPOINT, body: params)
+          request(:post, ENDPOINT, body: params, options: options)
         end
 
-        def get(id)
-          request(:get, "#{ENDPOINT}/#{id}")
+        def get(id, options: nil)
+          request(:get, "#{ENDPOINT}/#{id}", options: options)
         end
       end
     end

data/lib/runapi/elevenlabs/resources/text_to_dialogue.rb

@@ -14,19 +14,19 @@ module RunApi
           @http = http
         end
 
-        def run(**params)
-          task = create(**params)
-          poll_until_complete { get(task.id) }
+        def run(options: nil, **params)
+          task = create(options: options, **params)
+          poll_until_complete { get(task.id, options: options) }
         end
 
-        def create(**params)
+        def create(options: nil, **params)
           params = compact_params(params)
           raise Core::ValidationError, "dialogue is required" unless param(params, :dialogue)
-          request(:post, ENDPOINT, body: params)
+          request(:post, ENDPOINT, body: params, options: options)
         end
 
-        def get(id)
-          request(:get, "#{ENDPOINT}/#{id}")
+        def get(id, options: nil)
+          request(:get, "#{ENDPOINT}/#{id}", options: options)
         end
       end
     end

data/lib/runapi/elevenlabs/resources/text_to_sound.rb

@@ -14,22 +14,22 @@ module RunApi
           @http = http
         end
 
-        def run(**params)
-          task = create(**params)
-          poll_until_complete { get(task.id) }
+        def run(options: nil, **params)
+          task = create(options: options, **params)
+          poll_until_complete { get(task.id, options: options) }
         end
 
-        def create(**params)
+        def create(options: nil, **params)
           params = compact_params(params)
           raise Core::ValidationError, "text is required" unless param(params, :text)
           if param(params, :output_format) && !Types::TEXT_TO_SOUND_OUTPUT_FORMATS.include?(param(params, :output_format))
             raise Core::ValidationError, "Invalid output_format"
           end
-          request(:post, ENDPOINT, body: params)
+          request(:post, ENDPOINT, body: params, options: options)
         end
 
-        def get(id)
-          request(:get, "#{ENDPOINT}/#{id}")
+        def get(id, options: nil)
+          request(:get, "#{ENDPOINT}/#{id}", options: options)
         end
       end
     end

data/lib/runapi/elevenlabs/resources/text_to_speech.rb

@@ -14,29 +14,28 @@ module RunApi
           @http = http
         end
 
-        def run(**params)
-          task = create(**params)
-          poll_until_complete { get(task.id) }
+        def run(options: nil, **params)
+          task = create(options: options, **params)
+          poll_until_complete { get(task.id, options: options) }
         end
 
-        def create(**params)
+        def create(options: nil, **params)
           params = compact_params(params)
           validate_params!(params)
-          request(:post, ENDPOINT, body: params)
+          request(:post, ENDPOINT, body: params, options: options)
         end
 
-        def get(id)
-          request(:get, "#{ENDPOINT}/#{id}")
+        def get(id, options: nil)
+          request(:get, "#{ENDPOINT}/#{id}", options: options)
         end
 
         private
 
         def validate_params!(params)
-          model = param(params, :model)
-          raise Core::ValidationError, "model is required" unless model
-          raise Core::ValidationError, "Invalid model: #{model}" unless Types::TEXT_TO_SPEECH_MODELS.include?(model)
-          raise Core::ValidationError, "text is required" unless param(params, :text)
-          raise Core::ValidationError, "voice is required for text-to-speech-multilingual-v2" if model == "text-to-speech-multilingual-v2" && !param(params, :voice)
+          validate_contract!(CONTRACT["text-to-speech"], params)
+          if param(params, :model) == "text-to-speech-multilingual-v2" && !param(params, :voice)
+            raise Core::ValidationError, "voice is required for text-to-speech-multilingual-v2"
+          end
         end
       end
     end

data/lib/runapi/elevenlabs/types.rb

@@ -3,7 +3,6 @@
 module RunApi
   module Elevenlabs
     module Types
-      TEXT_TO_SPEECH_MODELS = %w[text-to-speech-turbo-v2.5 text-to-speech-multilingual-v2].freeze
       DEFAULT_TEXT_TO_SPEECH_VOICE = "EkK5I93UQWFDigLMpZcX"
       TEXT_TO_SOUND_OUTPUT_FORMATS = %w[
         mp3_22050_32 mp3_44100_32 mp3_44100_64 mp3_44100_96 mp3_44100_128 mp3_44100_192

data/lib/runapi/elevenlabs.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "runapi/core"
+require_relative "elevenlabs/contract_gen"
 require_relative "elevenlabs/types"
 require_relative "elevenlabs/resources/text_to_speech"
 require_relative "elevenlabs/resources/text_to_dialogue"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: runapi-elevenlabs
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.2.8
 platform: ruby
 authors:
 - RunAPI
@@ -15,18 +15,18 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.5
+        version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.5
-description: The elevenlabs api Ruby SDK is the language-specific package for ElevenLabs
-  on RunAPI. Use this elevenlabs api package for voice, dialogue, transcription, sound
-  effect, and cleanup flows when your application needs JSON request bodies, task
-  status lookup, and consistent RunAPI errors in Ruby.
+        version: 0.3.0
+description: The ElevenLabs Ruby SDK is the language-specific package for ElevenLabs
+  on RunAPI. Use this package for voice, dialogue, transcription, sound effect, and
+  audio cleanup workflows when your application needs request bodies, task status
+  lookup, and consistent RunAPI errors in Ruby.
 email:
 - contact@runapi.ai
 executables: []
@@ -39,6 +39,7 @@ files:
 - lib/runapi-elevenlabs.rb
 - lib/runapi/elevenlabs.rb
 - lib/runapi/elevenlabs/client.rb
+- lib/runapi/elevenlabs/contract_gen.rb
 - lib/runapi/elevenlabs/resources/isolate_audio.rb
 - lib/runapi/elevenlabs/resources/speech_to_text.rb
 - lib/runapi/elevenlabs/resources/text_to_dialogue.rb
@@ -49,9 +50,11 @@ homepage: https://runapi.ai/models/elevenlabs
 licenses:
 - Apache-2.0
 metadata:
+  runapi_slug: elevenlabs
   homepage_uri: https://runapi.ai/models/elevenlabs
   documentation_uri: https://github.com/runapi-ai/elevenlabs-sdk/blob/main/ruby/README.md
   source_code_uri: https://github.com/runapi-ai/elevenlabs-sdk
+  bug_tracker_uri: https://github.com/runapi-ai/elevenlabs-sdk/issues
   changelog_uri: https://github.com/runapi-ai/elevenlabs-sdk/blob/main/CHANGELOG.md
 rdoc_options: []
 require_paths:
@@ -67,7 +70,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.10
+rubygems_version: 4.0.17
 specification_version: 4
-summary: Elevenlabs API Ruby SDK for RunAPI
+summary: ElevenLabs Ruby SDK for RunAPI
 test_files: []