runapi-wan 0.2.6 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dbc05521adf750d4146cf35031cc55dad92fd762f83048f56cb5083e702e0d4f
-  data.tar.gz: b717b95a9b712d242de851922717953f0b6ef8dd7a77b70ccce17c169343287e
+  metadata.gz: f6a0a9c2970e6074e228f6d471414471703a9f255de8e157f0d222350f7c73f8
+  data.tar.gz: 5262e5103736aeb346183823f755e6e65e373e2d4da177e24609a8fcf0ad23a1
 SHA512:
-  metadata.gz: c4b5da04973ec6bde472f9ea0fd9cb746b749855a6292e69edeb0b08b303d8a7056d058a019e4de209d3a56f60091e756b9e6d566ffc68ae942273acf4063c55
-  data.tar.gz: b94bac6024b1adb20f4c8500b1e0e14f15f09344bb55a81285cbca87d1cb8feef4c35c9e6653d1f58cd904a1662550b753732f166d7e54a47e0dc141b5d90e94
+  metadata.gz: f1eed621ce410ac7962200c6930ed100c010f9348dd5b3a06e276918ad5d56ab5c3dae56ca52667b7f2184573d3cbc0a58a5b6c8193d5e2a97db077b61be7b0a
+  data.tar.gz: fbe4cff342e7da3c49bcfd27a334235f89f3838f4e5440de27c513d89a4db186f9bb8d03cc27123e892e2df055fac865fbd181861aa4392c43023bad96544338

data/README.md

@@ -24,6 +24,8 @@ status = client.text_to_video.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::Wan` error classes when building video jobs, Rails workers, or scripts. The available resources include text to videos, image to videos, speech to videos, animations, images, and video edits. Keep `RUNAPI_API_KEY` in the environment or your secret manager; never commit API keys or callback secrets.

data/lib/runapi/wan/client.rb

@@ -2,15 +2,33 @@
 
 module RunApi
   module Wan
-    class Client
-      attr_reader :text_to_video, :image_to_video,
-        :speech_to_video, :animate, :text_to_image, :edit_video
+    # Wan video and image generation API client.
+    #
+    # Spans multiple generation families (2.2 through 2.7) with progressive
+    # capability upgrades. Feature availability varies by model variant.
+    #
+    # @example
+    #   client = RunApi::Wan::Client.new(api_key: "your-api-key")
+    #   result = client.text_to_video.run(
+    #     model: "wan-2.6-text-to-video",
+    #     prompt: "A scenic mountain landscape with flowing rivers"
+    #   )
+    class Client < RunApi::Core::Client
+      # @return [Resources::TextToVideo] Generate videos from text prompts. Supports turbo (2.2) through 2.7 with progressive features.
+      attr_reader :text_to_video
+      # @return [Resources::ImageToVideo] Generate videos driven by a source image. Flash variants trade fidelity for speed.
+      attr_reader :image_to_video
+      # @return [Resources::SpeechToVideo] Generate lip-synced talking-head videos from a portrait image and speech audio.
+      attr_reader :speech_to_video
+      # @return [Resources::Animate] Transfer motion from a reference video onto a subject image (move or replace).
+      attr_reader :animate
+      # @return [Resources::TextToImage] Generate images with optional color palette, bounding box, and thinking mode.
+      attr_reader :text_to_image
+      # @return [Resources::EditVideo] Modify existing videos guided by text prompts and optional reference images.
+      attr_reader :edit_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
 
         @text_to_video = Resources::TextToVideo.new(http)
         @image_to_video = Resources::ImageToVideo.new(http)

data/lib/runapi/wan/resources/animate.rb

@@ -3,6 +3,9 @@
 module RunApi
   module Wan
     module Resources
+      # Transfers motion from a reference video onto a subject in the source image.
+      # Use wan-2.2-animate-move to preserve the subject and animate its motion,
+      # or wan-2.2-animate-replace to swap the subject with the reference video's subject.
       class Animate
         include RunApi::Core::ResourceHelpers
 
@@ -14,17 +17,29 @@ module RunApi
           @http = http
         end
 
+        # Transfer motion and wait until complete.
+        #
+        # @param params [Hash] animation parameters
+        # @return [RunApi::Wan::Types::CompletedVideoTaskResponse] completed animation result
         def run(**params)
           task = create(**params)
           poll_until_complete { get(task.id) }
         end
 
+        # Create an animation task.
+        #
+        # @param params [Hash] animation parameters
+        # @return [RunApi::Wan::Types::VideoTaskResponse] task creation result with id
         def create(**params)
           params = compact_params(params)
           validate_params!(params)
           request(:post, ENDPOINT, body: params)
         end
 
+        # Get animation status by task ID.
+        #
+        # @param id [String] task ID
+        # @return [RunApi::Wan::Types::VideoTaskResponse] current task status
         def get(id)
           request(:get, "#{ENDPOINT}/#{id}")
         end

data/lib/runapi/wan/resources/edit_video.rb

@@ -3,6 +3,9 @@
 module RunApi
   module Wan
     module Resources
+      # Modifies existing videos guided by a text prompt and optional reference image.
+      # The 2.6 models use source_video_urls (plural, required) while 2.7 uses
+      # source_video_url (singular, required). Flash variants support audio and multi-shot.
       class EditVideo
         include RunApi::Core::ResourceHelpers
 
@@ -14,17 +17,29 @@ module RunApi
           @http = http
         end
 
+        # Edit a video and wait until complete.
+        #
+        # @param params [Hash] video editing parameters
+        # @return [RunApi::Wan::Types::CompletedVideoTaskResponse] completed video edit
         def run(**params)
           task = create(**params)
           poll_until_complete { get(task.id) }
         end
 
+        # Create a video editing task.
+        #
+        # @param params [Hash] video editing parameters
+        # @return [RunApi::Wan::Types::VideoTaskResponse] task creation result with id
         def create(**params)
           params = compact_params(params)
           validate_params!(params)
           request(:post, ENDPOINT, body: params)
         end
 
+        # Get video editing status by task ID.
+        #
+        # @param id [String] task ID
+        # @return [RunApi::Wan::Types::VideoTaskResponse] current task status
         def get(id)
           request(:get, "#{ENDPOINT}/#{id}")
         end

data/lib/runapi/wan/resources/image_to_video.rb

@@ -3,6 +3,8 @@
 module RunApi
   module Wan
     module Resources
+      # Generates videos driven by a source image. Flash variants trade fidelity
+      # for speed; 2.7 adds last-frame control, video continuation, and audio features.
       class ImageToVideo
         include RunApi::Core::ResourceHelpers
 
@@ -14,17 +16,29 @@ module RunApi
           @http = http
         end
 
+        # Generate a video from an image and wait until complete.
+        #
+        # @param params [Hash] image-to-video parameters
+        # @return [RunApi::Wan::Types::CompletedVideoTaskResponse] completed video generation
         def run(**params)
           task = create(**params)
           poll_until_complete { get(task.id) }
         end
 
+        # Create an image-to-video generation task.
+        #
+        # @param params [Hash] image-to-video parameters
+        # @return [RunApi::Wan::Types::VideoTaskResponse] task creation result with id
         def create(**params)
           params = compact_params(params)
           validate_params!(params)
           request(:post, ENDPOINT, body: params)
         end
 
+        # Get image-to-video status by task ID.
+        #
+        # @param id [String] task ID
+        # @return [RunApi::Wan::Types::VideoTaskResponse] current task status
         def get(id)
           request(:get, "#{ENDPOINT}/#{id}")
         end

data/lib/runapi/wan/resources/speech_to_video.rb

@@ -3,6 +3,8 @@
 module RunApi
   module Wan
     module Resources
+      # Generates lip-synced talking-head videos from a portrait image and
+      # driving speech audio. Both source_image_url and source_audio_url are required.
       class SpeechToVideo
         include RunApi::Core::ResourceHelpers
 
@@ -14,17 +16,29 @@ module RunApi
           @http = http
         end
 
+        # Generate a lip-synced video and wait until complete.
+        #
+        # @param params [Hash] speech-to-video parameters
+        # @return [RunApi::Wan::Types::CompletedVideoTaskResponse] completed video generation
         def run(**params)
           task = create(**params)
           poll_until_complete { get(task.id) }
         end
 
+        # Create a speech-to-video generation task.
+        #
+        # @param params [Hash] speech-to-video parameters
+        # @return [RunApi::Wan::Types::VideoTaskResponse] task creation result with id
         def create(**params)
           params = compact_params(params)
           validate_params!(params)
           request(:post, ENDPOINT, body: params)
         end
 
+        # Get speech-to-video status by task ID.
+        #
+        # @param id [String] task ID
+        # @return [RunApi::Wan::Types::VideoTaskResponse] current task status
         def get(id)
           request(:get, "#{ENDPOINT}/#{id}")
         end

data/lib/runapi/wan/resources/text_to_image.rb

@@ -3,6 +3,9 @@
 module RunApi
   module Wan
     module Resources
+      # Generates images from text prompts with optional color palette and bounding
+      # box constraints. Supports batch generation via output_count. Pro model
+      # supports thinking_mode for enhanced prompt reasoning.
       class TextToImage
         include RunApi::Core::ResourceHelpers
 
@@ -14,17 +17,29 @@ module RunApi
           @http = http
         end
 
+        # Generate an image and wait until complete.
+        #
+        # @param params [Hash] text-to-image parameters
+        # @return [RunApi::Wan::Types::CompletedImageTaskResponse] completed image generation
         def run(**params)
           task = create(**params)
           poll_until_complete { get(task.id) }
         end
 
+        # Create a text-to-image generation task.
+        #
+        # @param params [Hash] text-to-image parameters
+        # @return [RunApi::Wan::Types::ImageTaskResponse] task creation result with id
         def create(**params)
           params = compact_params(params)
           validate_params!(params)
           request(:post, ENDPOINT, body: params)
         end
 
+        # Get text-to-image status by task ID.
+        #
+        # @param id [String] task ID
+        # @return [RunApi::Wan::Types::ImageTaskResponse] current task status
         def get(id)
           request(:get, "#{ENDPOINT}/#{id}")
         end

data/lib/runapi/wan/resources/text_to_video.rb

@@ -3,6 +3,9 @@
 module RunApi
   module Wan
     module Resources
+      # Generates videos from text prompts. Supports turbo (2.2) through 2.7
+      # with progressive feature upgrades including negative prompts, watermark
+      # control, background audio, and R2V multi-reference inputs.
       class TextToVideo
         include RunApi::Core::ResourceHelpers
 
@@ -14,17 +17,29 @@ module RunApi
           @http = http
         end
 
+        # Generate a video and wait until complete.
+        #
+        # @param params [Hash] text-to-video parameters
+        # @return [RunApi::Wan::Types::CompletedVideoTaskResponse] completed video generation
         def run(**params)
           task = create(**params)
           poll_until_complete { get(task.id) }
         end
 
+        # Create a text-to-video generation task.
+        #
+        # @param params [Hash] text-to-video parameters
+        # @return [RunApi::Wan::Types::VideoTaskResponse] task creation result with id
         def create(**params)
           params = compact_params(params)
           validate_params!(params)
           request(:post, ENDPOINT, body: params)
         end
 
+        # Get text-to-video status by task ID.
+        #
+        # @param id [String] task ID
+        # @return [RunApi::Wan::Types::VideoTaskResponse] current task status
         def get(id)
           request(:get, "#{ENDPOINT}/#{id}")
         end

data/lib/runapi/wan/types.rb

@@ -3,6 +3,8 @@
 module RunApi
   module Wan
     module Types
+      # Text-to-video variants: 2.2 turbo (fast, lower res) through 2.7 (highest quality)
+      # and R2V (accepts reference images, videos, first-frame, and audio).
       TEXT_TO_VIDEO_MODELS = %w[
         wan-2.2-a14b-text-to-video-turbo
         wan-2.5-text-to-video
@@ -11,6 +13,8 @@ module RunApi
         wan-2.7-r2v
       ].freeze
 
+      # Image-to-video variants. Flash trades fidelity for speed; 2.7 adds last-frame
+      # control, video continuation, driving/background audio, and watermark.
       IMAGE_TO_VIDEO_MODELS = %w[
         wan-2.2-a14b-image-to-video-turbo
         wan-2.5-image-to-video
@@ -19,23 +23,31 @@ module RunApi
         wan-2.7-image-to-video
       ].freeze
 
+      # Speech-driven lip-sync model for talking-head video generation.
       SPEECH_TO_VIDEO_MODELS = %w[wan-2.2-a14b-speech-to-video-turbo].freeze
+      # Motion transfer: move (preserves subject) and replace (swaps subject).
       ANIMATE_MODELS = %w[wan-2.2-animate-move wan-2.2-animate-replace].freeze
+      # Image generation: standard and pro. Pro model supports thinking_mode for enhanced reasoning.
       TEXT_TO_IMAGE_MODELS = %w[wan-2.7-image wan-2.7-image-pro].freeze
+      # Video editing: 2.6 uses source_video_urls (plural), 2.7 uses source_video_url (singular).
+      # Flash variants support audio generation and multi-shot mode.
       EDIT_VIDEO_MODELS = %w[
         wan-2.6-edit-video
         wan-2.6-flash-edit-video
         wan-2.7-edit-video
       ].freeze
 
+      # A single generated video result.
       class Video < RunApi::Core::BaseModel
         optional :url, String
       end
 
+      # A single generated image result.
       class Image < RunApi::Core::BaseModel
         optional :url, String
       end
 
+      # Task result for video generation and editing operations.
       class VideoTaskResponse < RunApi::Core::TaskResponse
         required :id, String
         optional :status, String, enum: -> { RunApi::Core::TaskResponse::Status::ALL }
@@ -43,6 +55,7 @@ module RunApi
         optional :error, String
       end
 
+      # Task result for text-to-image operations.
       class ImageTaskResponse < RunApi::Core::TaskResponse
         required :id, String
         optional :status, String, enum: -> { RunApi::Core::TaskResponse::Status::ALL }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: runapi-wan
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.2.7
 platform: ruby
 authors:
 - RunAPI
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.5
+        version: 0.2.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.5
+        version: 0.2.6
 description: The wan video api Ruby SDK is the language-specific package for Wan on
   RunAPI. Use this wan video api package for text-to-video, image-to-video, animation,
   and video editing flows when your application needs JSON request bodies, task status