runapi-seedance 0.2.4 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 689fa6085316cf89495e92c1bee496f46600830b843bc3acb2ddc94d17c22689
-  data.tar.gz: ff960a6b298b19d9b0a2b8bbda0f92f39601d01be419232dad1986ee61573555
+  metadata.gz: 4a4129f28a6815e05d711bf3c21304a59cc6f9d5250ba3c4efec1126a72227b5
+  data.tar.gz: 997e90de2aa928d79bbfe267a05d267d842137056f5beb470b1d2646254bec70
 SHA512:
-  metadata.gz: 3dfdde20cbf6972803d6d2306ca7d9521d48a4d62ecf89749f2e9084d01f9dbd0f67b69836f0d1b5f45b9f5672d4e41f90380fee7c81602e94bcdca9f968df7f
-  data.tar.gz: 0ab70a5d8eaf526669481af111c1262845e776a0214d095fcdc5fb4f73f3b75e001b655ff9ad59cf0be925b8e377d78e37e1edf15896f2f3d2cb16dd32094782
+  metadata.gz: e2b7f49b273915dabdca3e14b02eac8ae58733f5f4cea8c53a2b6b2ce5dcbc58a3c3e961304eadbfb32dbe1d5358585c399ef0b029a1b47c062a35a7f06485e0
+  data.tar.gz: b7c7f737b22359c3808c02bda601abcb2c7bc7155acf05b769813ba281d26dd242f3428ddc6a228b5983358c9bc0e2b26168328f5d1de8af414512ff64f636e3

data/README.md

@@ -0,0 +1,45 @@
+# Seedance API Ruby SDK for RunAPI
+
+The seedance api Ruby SDK is the language-specific package for Seedance on RunAPI. Use this seedance 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 seedance api README is the Ruby package guide inside the public `seedance-sdk` repository. For the repository overview, start at `../README.md`; for model details, use https://runapi.ai/models/seedance; for API reference, use https://runapi.ai/docs#seedance; for SDK docs, use https://runapi.ai/docs#sdk-seedance.
+
+## Install
+
+```bash
+gem install runapi-seedance
+```
+
+## Quick start
+
+```ruby
+require "runapi-seedance"
+
+client = RunApi::Seedance::Client.new
+task = client.generations.create(
+  # Pass the Seedance JSON request body from https://runapi.ai/docs#seedance.
+)
+status = client.generations.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::Seedance` error classes when building video jobs, Rails workers, or scripts. The available resources include generations. 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/seedance
+- SDK docs: https://runapi.ai/docs#sdk-seedance
+- Product docs: https://runapi.ai/docs#seedance
+- Pricing and rate limits: https://runapi.ai/models/seedance/v1-lite
+- Provider comparison: https://runapi.ai/providers/bytedance
+- Full catalog: https://runapi.ai/models
+- Repository: https://github.com/runapi-ai/seedance-sdk
+
+## License
+
+Licensed under the Apache License, Version 2.0.

data/lib/runapi/seedance/client.rb

@@ -9,15 +9,12 @@ module RunApi
     #   result = client.text_to_video.run(
     #     model: "seedance-2.0", prompt: "A cat walking through a garden"
     #   )
-    class Client
+    class Client < RunApi::Core::Client
       # @return [Resources::TextToVideo] Video generation operations.
       attr_reader :text_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
         @text_to_video = Resources::TextToVideo.new(http)
       end
     end

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

@@ -74,35 +74,29 @@ module RunApi
 
         def validate_v1!(params)
           model = param(params, :model)
-          has_image = field_present?(params, :input_urls)
+          has_image = field_present?(params, :first_frame_image_url)
 
           if model == "seedance-v1-pro-fast" && !has_image
-            raise Core::ValidationError, "seedance-v1-pro-fast requires input_urls (image-to-video only)"
-          end
-
-          if (value = param(params, :input_urls)).is_a?(Array) && value.size > 1
-            raise Core::ValidationError, "input_urls accepts at most 1 image for Seedance V1"
+            raise Core::ValidationError, "seedance-v1-pro-fast requires first_frame_image_url"
           end
 
           if has_image && field_present?(params, :aspect_ratio)
             raise Core::ValidationError, "aspect_ratio is not accepted in image-to-video mode; it is derived from the image"
           end
 
-          if field_present?(params, :last_frame_url) && !(model == "seedance-v1-lite" && has_image)
-            raise Core::ValidationError, "last_frame_url is only supported by seedance-v1-lite in image-to-video mode"
+          if field_present?(params, :last_frame_image_url) && !(model == "seedance-v1-lite" && has_image)
+            raise Core::ValidationError, "last_frame_image_url is only supported by seedance-v1-lite in image-to-video mode"
           end
 
-          unsupported = %i[first_frame_url reference_image_urls reference_video_urls reference_audio_urls web_search generate_audio]
+          unsupported = %i[source_image_urls reference_image_urls reference_video_urls reference_audio_urls web_search generate_audio]
           reject_unsupported!(params, unsupported, model)
 
-          if model == "seedance-v1-pro-fast"
-            reject_unsupported!(params, %i[lock_camera seed enable_safety_checker], model)
-          end
+          reject_unsupported!(params, %i[lock_camera seed], model) if model == "seedance-v1-pro-fast"
 
-          duration = param(params, :duration)
-          raise Core::ValidationError, "duration is required for Seedance V1; must be one of: #{Types::DURATIONS_V1.join(", ")}" unless duration
-          unless Types::DURATIONS_V1.include?(duration.to_s)
-            raise Core::ValidationError, "Invalid duration for #{model}: #{duration}. Must be one of: #{Types::DURATIONS_V1.join(", ")}"
+          duration_seconds = param(params, :duration_seconds)
+          raise Core::ValidationError, "duration_seconds is required for Seedance V1; must be one of: #{Types::DURATIONS_V1.join(", ")}" unless duration_seconds
+          unless Types::DURATIONS_V1.include?(duration_seconds)
+            raise Core::ValidationError, "Invalid duration_seconds for #{model}: #{duration_seconds}. Must be one of: #{Types::DURATIONS_V1.join(", ")}"
           end
 
           unless has_image
@@ -111,7 +105,7 @@ module RunApi
           end
 
           resolutions = (model == "seedance-v1-pro-fast") ? Types::RESOLUTIONS_V1_PRO_FAST : Types::RESOLUTIONS_V1
-          validate_optional!(params, :resolution, resolutions)
+          validate_optional!(params, :output_resolution, resolutions)
 
           seed = param(params, :seed)
           if seed
@@ -123,31 +117,39 @@ module RunApi
 
         def validate_1_5_pro!(params)
           validate_optional!(params, :aspect_ratio, Types::ASPECT_RATIOS_1_5)
-          validate_optional!(params, :resolution, Types::RESOLUTIONS_1_5)
+          validate_optional!(params, :output_resolution, Types::RESOLUTIONS_1_5)
+
+          duration_seconds = param(params, :duration_seconds)
+          unless duration_seconds
+            raise Core::ValidationError, "duration_seconds is required for seedance-1.5-pro; must be one of: #{Types::DURATIONS_1_5.join(", ")}"
+          end
+
+          if !Types::DURATIONS_1_5.include?(duration_seconds)
+            raise Core::ValidationError, "Invalid duration_seconds for seedance-1.5-pro: #{duration_seconds}. Must be one of: #{Types::DURATIONS_1_5.join(", ")}"
+          end
 
-          duration = param(params, :duration)
-          if duration && !Types::DURATIONS_1_5.include?(duration.to_s)
-            raise Core::ValidationError, "Invalid duration for seedance-1.5-pro: #{duration}. Must be one of: #{Types::DURATIONS_1_5.join(", ")}"
+          if (value = param(params, :source_image_urls)).is_a?(Array) && value.size > 2
+            raise Core::ValidationError, "source_image_urls accepts at most 2 images for seedance-1.5-pro"
           end
 
-          unsupported = %i[first_frame_url last_frame_url reference_image_urls reference_video_urls reference_audio_urls web_search]
+          unsupported = %i[first_frame_image_url last_frame_image_url reference_image_urls reference_video_urls reference_audio_urls web_search]
           reject_unsupported!(params, unsupported, "seedance-1.5-pro")
         end
 
         def validate_2!(params)
           validate_optional!(params, :aspect_ratio, Types::ASPECT_RATIOS_2)
           resolutions = (param(params, :model) == "seedance-2.0") ? Types::RESOLUTIONS_SEEDANCE_2 : Types::RESOLUTIONS_SEEDANCE_2_FAST
-          validate_optional!(params, :resolution, resolutions)
+          validate_optional!(params, :output_resolution, resolutions)
 
-          duration = param(params, :duration)
-          if duration
-            dur_int = duration.to_i
+          duration_seconds = param(params, :duration_seconds)
+          if duration_seconds
+            dur_int = duration_seconds.to_i
             unless Types::DURATION_2_RANGE.cover?(dur_int)
-              raise Core::ValidationError, "Invalid duration for seedance-2.0: #{duration}. Must be an integer between 4 and 15"
+              raise Core::ValidationError, "Invalid duration_seconds for seedance-2.0: #{duration_seconds}. Must be an integer between 4 and 15"
             end
           end
 
-          unsupported = %i[input_urls lock_camera]
+          unsupported = %i[source_image_urls lock_camera]
           reject_unsupported!(params, unsupported, param(params, :model))
 
           validate_mode_conflicts!(params)
@@ -158,7 +160,7 @@ module RunApi
           has_reference = Types::REFERENCE_FIELDS.any? { |f| field_present?(params, f) }
 
           if has_frame && has_reference
-            raise Core::ValidationError, "Cannot use frame mode (first_frame_url/last_frame_url) and reference mode (reference_image_urls/reference_video_urls/reference_audio_urls) at the same time"
+            raise Core::ValidationError, "Cannot use frame mode and reference mode at the same time"
           end
         end
 

data/lib/runapi/seedance/types.rb

@@ -2,55 +2,84 @@
 
 module RunApi
   module Seedance
+    # Type definitions and constants for Seedance video generation.
+    #
+    # Constants are grouped by model generation: 1.5, 2.0/2.0-fast, and V1.
+    # Each generation has its own aspect ratio, resolution, and duration
+    # constraints reflecting different rendering capabilities.
     module Types
+      # V1-generation model identifiers: lite (low-cost), pro (high-quality), and pro-fast (speed-optimized).
       V1_MODELS = %w[seedance-v1-lite seedance-v1-pro seedance-v1-pro-fast].freeze
+      # All supported model variants spanning 1.5, 2.0, and V1 generations.
       MODELS = (%w[seedance-1.5-pro seedance-2.0 seedance-2.0-fast] + V1_MODELS).freeze
 
+      # Aspect ratios for seedance-1.5-pro; required with every request.
       ASPECT_RATIOS_1_5 = %w[1:1 4:3 3:4 16:9 9:16 21:9].freeze
-      ASPECT_RATIOS_2 = [ *ASPECT_RATIOS_1_5, "auto" ].freeze
+      # Aspect ratios for 2.0/2.0-fast; includes "auto" for automatic selection.
+      ASPECT_RATIOS_2 = [*ASPECT_RATIOS_1_5, "auto"].freeze
+      # Aspect ratios for seedance-v1-lite; uses 9:21 (not 21:9) for tall portrait.
       ASPECT_RATIOS_V1_LITE = %w[1:1 4:3 3:4 16:9 9:16 9:21].freeze
+      # Aspect ratios for seedance-v1-pro and seedance-v1-pro-fast.
       ASPECT_RATIOS_V1_PRO = %w[1:1 4:3 3:4 16:9 9:16 21:9].freeze
 
+      # Output resolutions for seedance-1.5-pro.
       RESOLUTIONS_1_5 = %w[480p 720p 1080p].freeze
+      # Output resolutions for seedance-2.0.
       RESOLUTIONS_SEEDANCE_2 = %w[480p 720p 1080p].freeze
+      # Output resolutions for seedance-2.0-fast; capped at 720p for faster rendering.
       RESOLUTIONS_SEEDANCE_2_FAST = %w[480p 720p].freeze
+      # Output resolutions for seedance-v1-lite and seedance-v1-pro.
       RESOLUTIONS_V1 = %w[480p 720p 1080p].freeze
+      # Output resolutions for seedance-v1-pro-fast; minimum 720p.
       RESOLUTIONS_V1_PRO_FAST = %w[720p 1080p].freeze
 
-      DURATIONS_1_5 = %w[4 8 12].freeze
+      # Allowed duration values (seconds) for seedance-1.5-pro; discrete choices only.
+      DURATIONS_1_5 = [4, 8, 12].freeze
+      # Continuous duration range (seconds) for 2.0/2.0-fast; any integer 4-15 is accepted.
       DURATION_2_RANGE = (4..15)
-      DURATIONS_V1 = %w[5 10].freeze
+      # Allowed duration values (seconds) for V1 models; 5 or 10.
+      DURATIONS_V1 = [5, 10].freeze
+      # Valid seed range; -1 requests a random seed.
       SEED_RANGE = (-1..2_147_483_647)
 
+      # Minimum prompt length in characters, enforced across all models.
       PROMPT_MIN_LENGTH = 3
+      # Maximum prompt length for seedance-1.5-pro.
       PROMPT_MAX_LENGTH_1_5 = 2500
+      # Maximum prompt length for 2.0/2.0-fast (up to 20 000 characters).
       PROMPT_MAX_LENGTH_2 = 20000
+      # Maximum prompt length for V1 models (up to 10 000 characters).
       PROMPT_MAX_LENGTH_V1 = 10000
 
-      FRAME_FIELDS = %i[first_frame_url last_frame_url].freeze
+      # Fields that specify first/last frame images for frame-conditioned generation.
+      FRAME_FIELDS = %i[first_frame_image_url last_frame_image_url].freeze
+      # Fields for reference-conditioned generation (images, videos, and audio).
       REFERENCE_FIELDS = %i[reference_image_urls reference_video_urls reference_audio_urls].freeze
 
+      # A single generated video with its download URL.
       class Video < RunApi::Core::BaseModel
         optional :url, String
       end
 
+      # Base async response returned immediately after task creation and during polling.
       class AsyncTaskResponse < RunApi::Core::TaskResponse
         required :id, String
         optional :status, String, enum: -> { RunApi::Core::TaskResponse::Status::ALL }
       end
 
+      # Full response for a text-to-video task, including generated videos on completion.
       class TextToVideoResponse < AsyncTaskResponse
-        optional :videos, [ -> { Video } ]
-        optional :last_frame_url, String
+        optional :videos, [-> { Video }]
+        optional :last_frame_image_url, String
         optional :error, String
       end
 
       # Narrowed response returned by `text_to_video.run()` once polling observes
       # `status: "completed"`. `videos` is required so consumers never have to
-      # null-check it on a successful task. `last_frame_url` stays optional
+      # null-check it on a successful task. `last_frame_image_url` stays optional
       # because it may be absent.
       class CompletedTextToVideoResponse < TextToVideoResponse
-        required :videos, [ -> { Video } ]
+        required :videos, [-> { Video }]
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: runapi-seedance
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.7
 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 Seedance SDK for JavaScript, Ruby, and Go
+        version: 0.2.6
+description: The seedance api Ruby SDK is the language-specific package for Seedance
+  on RunAPI. Use this seedance 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-seedance.rb
 - lib/runapi/seedance.rb
 - lib/runapi/seedance/client.rb
@@ -41,7 +46,7 @@ licenses:
 - Apache-2.0
 metadata:
   homepage_uri: https://runapi.ai/models/seedance
-  documentation_uri: https://github.com/runapi-ai/seedance-sdk/blob/main/README.md
+  documentation_uri: https://github.com/runapi-ai/seedance-sdk/blob/main/ruby/README.md
   source_code_uri: https://github.com/runapi-ai/seedance-sdk
   changelog_uri: https://github.com/runapi-ai/seedance-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: Seedance API SDKs for JavaScript, Ruby, and Go on RunAPI.
+summary: Seedance API Ruby SDK for RunAPI
 test_files: []