runapi-infinitetalk 0.2.4 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4886911a34f5861168a03cef1d68c7805ea420b6dbf9a59c9bd80d2ed0c9e374
-  data.tar.gz: b61ac858fb14128cc2c26060c3bc7f1cb08e447084c783332195d69f69902c73
+  metadata.gz: e1a267d42796d65befec17a0e733b2db482e18c440d38edfb7be16c1a1fae597
+  data.tar.gz: a2f1b73ad67eb6f5a34fafae990e9b411f41dd4bc235b12370bc9de3ef408a30
 SHA512:
-  metadata.gz: 2c3fcab4e54358bc2fea170c5eb6ef9ccdabc1cbe16473c70d567668cfdd9a4de6731fa12772874bee4f3daf58616a674c13e9d0c4d758000d6e5c5f4cc43784
-  data.tar.gz: 2ef816878703fb34146ed3d41c80caf57dc1f617e796d2d0f32d9f80c39a94024481a5900ead8f6a1ff6efda10db96c828926ec14ac39a74b77d89fd7437dce3
+  metadata.gz: c2d66db62701612624579a88be2603250e752722233cfd11d379c4e95488b6dcb403265a344edc9491569b2eb9a87b393d4e669d160eec155caf635a35ccf145
+  data.tar.gz: 2bf5dab96aa4bd2b640e8ec70b9bfc6c2ad3ba62e491f452c6e02f1c38b17719557e3f57833e5053d1218e0d2a1f581b070a5105f55bfd68f71cc50e498b08f3

data/README.md

@@ -0,0 +1,45 @@
+# Infinitetalk API Ruby SDK for RunAPI
+
+The infinitetalk api Ruby SDK is the language-specific package for InfiniteTalk on RunAPI. Use this infinitetalk api package for text-to-video, image-to-video, video editing, and animation flows when your application needs JSON request bodies, task status lookup, and consistent RunAPI errors in Ruby.
+
+This infinitetalk api README is the Ruby package guide inside the public `infinitalk-sdk` repository. For the repository overview, start at `../README.md`; for model details, use https://runapi.ai/models/infinitalk; for API reference, use https://runapi.ai/docs#infinitalk; for SDK docs, use https://runapi.ai/docs#sdk-infinitalk.
+
+## Install
+
+```bash
+gem install runapi-infinitalk
+```
+
+## Quick start
+
+```ruby
+require "runapi-infinitalk"
+
+client = RunApi::Infinitalk::Client.new
+task = client.from_audios.create(
+  # Pass the InfiniteTalk JSON request body from https://runapi.ai/docs#infinitalk.
+)
+status = client.from_audios.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::Infinitalk` error classes when building video jobs, Rails workers, or scripts. The available resources include from audios. Keep `RUNAPI_API_KEY` in the environment or your secret manager; never commit API keys or callback secrets.
+
+## Links
+
+- Model page: https://runapi.ai/models/infinitalk
+- SDK docs: https://runapi.ai/docs#sdk-infinitalk
+- Product docs: https://runapi.ai/docs#infinitalk
+- Pricing and rate limits: https://runapi.ai/models/infinitalk
+- Provider comparison: https://runapi.ai/providers/meigen-ai
+- Full catalog: https://runapi.ai/models
+- Repository: https://github.com/runapi-ai/infinitalk-sdk
+
+## License
+
+Licensed under the Apache License, Version 2.0.

data/lib/runapi/infinitetalk/client.rb

@@ -2,14 +2,24 @@
 
 module RunApi
   module Infinitetalk
-    class Client
+    # InfiniteTalk lip-sync video generation client. Produces talking-head videos
+    # by animating a portrait image to match an audio track's speech or singing.
+    #
+    # @example
+    #   client = RunApi::Infinitetalk::Client.new(api_key: "sk-...")
+    #   result = client.audio_to_video.run(
+    #     model: "infinitetalk-from-audio",
+    #     source_image_url: "https://example.com/portrait.jpg",
+    #     source_audio_url: "https://example.com/voice.mp3",
+    #     prompt: "A young woman talking on a podcast"
+    #   )
+    #   puts result.videos.first.url
+    class Client < RunApi::Core::Client
+      # @return [Resources::AudioToVideo] Lip-synced video generation from a portrait image and audio track.
       attr_reader :audio_to_video
 
       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
         @audio_to_video = Resources::AudioToVideo.new(http)
       end
     end

data/lib/runapi/infinitetalk/resources/audio_to_video.rb

@@ -3,6 +3,8 @@
 module RunApi
   module Infinitetalk
     module Resources
+      # Generates lip-synced talking-head videos from a portrait image and an audio track.
+      # The output video shows the person speaking or singing in sync with the audio.
       class AudioToVideo
         include RunApi::Core::ResourceHelpers
 
@@ -40,15 +42,15 @@ module RunApi
             raise Core::ValidationError, "Invalid model: #{model}. Must be one of: #{Types::MODELS.join(", ")}"
           end
 
-          validate_required!(params, :image_url)
-          validate_required!(params, :audio_url)
+          validate_required!(params, :source_image_url)
+          validate_required!(params, :source_audio_url)
           prompt = param(params, :prompt)
           raise Core::ValidationError, "prompt is required" unless prompt.is_a?(String) && !prompt.empty?
           if prompt.length > PROMPT_MAX_LENGTH
             raise Core::ValidationError, "prompt must be at most #{PROMPT_MAX_LENGTH} characters"
           end
 
-          validate_optional!(params, :resolution, Types::RESOLUTIONS)
+          validate_optional!(params, :output_resolution, Types::RESOLUTIONS)
 
           seed = param(params, :seed)
           return if seed.nil?

data/lib/runapi/infinitetalk/types.rb

@@ -3,22 +3,28 @@
 module RunApi
   module Infinitetalk
     module Types
+      # Available model identifiers for audio-to-video generation.
       MODELS = %w[infinitetalk-from-audio].freeze
+      # Output resolution options. Higher resolution increases fidelity but takes longer.
       RESOLUTIONS = %w[480p 720p].freeze
 
+      # A generated video asset.
       class Video < RunApi::Core::BaseModel
         optional :url, String
       end
 
+      # Result of an audio-to-video generation task.
+      # While processing, +videos+ is nil; once completed, it contains the generated lip-synced video(s).
       class AudioToVideoResponse < RunApi::Core::TaskResponse
         required :id, String
         optional :status, String, enum: -> { RunApi::Core::TaskResponse::Status::ALL }
-        optional :videos, [ -> { Video } ]
+        optional :videos, [-> { Video }]
         optional :error, String
       end
 
+      # Narrowed response type guaranteed to contain completed videos.
       class CompletedAudioToVideoResponse < AudioToVideoResponse
-        required :videos, [ -> { Video } ]
+        required :videos, [-> { Video }]
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: runapi-infinitetalk
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.6
 platform: ruby
 authors:
 - RunAPI
@@ -15,22 +15,27 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.4
+        version: 0.2.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.4
-description: RunAPI InfiniteTalk SDK for JavaScript, Ruby, and Go
+        version: 0.2.6
+description: The infinitetalk api Ruby SDK is the language-specific package for InfiniteTalk
+  on RunAPI. Use this infinitetalk api package for text-to-video, image-to-video,
+  video editing, and animation flows when your application needs JSON request bodies,
+  task status lookup, and consistent RunAPI errors in Ruby.
 email:
 - contact@runapi.ai
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
 files:
 - LICENSE
+- README.md
 - lib/runapi-infinitetalk.rb
 - lib/runapi/infinitetalk.rb
 - lib/runapi/infinitetalk/client.rb
@@ -41,7 +46,7 @@ licenses:
 - Apache-2.0
 metadata:
   homepage_uri: https://runapi.ai/models/infinitetalk
-  documentation_uri: https://github.com/runapi-ai/infinitetalk-sdk/blob/main/README.md
+  documentation_uri: https://github.com/runapi-ai/infinitetalk-sdk/blob/main/ruby/README.md
   source_code_uri: https://github.com/runapi-ai/infinitetalk-sdk
   changelog_uri: https://github.com/runapi-ai/infinitetalk-sdk/blob/main/CHANGELOG.md
 rdoc_options: []
@@ -60,5 +65,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 4.0.10
 specification_version: 4
-summary: InfiniteTalk API SDKs for JavaScript, Ruby, and Go on RunAPI.
+summary: Infinitetalk API Ruby SDK for RunAPI
 test_files: []