runapi-seedance 0.2.6 → 0.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4118e285fccee6a45c55c4a823d935bb75d7cca1cfe5dfc4e82973214575c183
-  data.tar.gz: 6ca91fe558e2a4e53890b21d573b4809dc2af0335cce7f35baabde7797c54fec
+  metadata.gz: 7e72a064a5fb6661041862b4e66aa714e384ec015a136f91ec6619b8ff4dbca2
+  data.tar.gz: '0080e2a4576940e9d58314f6aad79773443c444a0b10333cb2c4cdc346cafdf8'
 SHA512:
-  metadata.gz: 0074a40fc6a32db226f372d2575aa2db218d3c0ec5b7abe2d3a6ffc1a9f962e5a137e7d03ab8ee714f80c6377180d88aed4899d513f84b008991452bc888c1b5
-  data.tar.gz: '06799aaa55a72f75efdef4e17311297e96c7a73b53bbfa1856157be770066adb09edc70128b9db546fe301359b8fd6eae7f84ec34d3251de19447568b340593d'
+  metadata.gz: 684eb54c618b6895b89cd55adf3a877664d3f82460207ed62bf5cbb87f3e2dc97df11c5fb5c399a5bd5fcc87f4fb87d081b683bf94c412b3a0a1d61968d18528
+  data.tar.gz: 6f419078f87ebf32b01f335fe1059da64c214f6d8505bf6e7ec8f74a8d53cef1b9a421c31b9df956ab53cb99d5a91a189a6bad23fd8a6247c0c81e9e4bd63394

data/README.md

@@ -1,8 +1,8 @@
-# Seedance API Ruby SDK for RunAPI
+# Seedance 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.
+The Seedance Ruby SDK is the language-specific package for Seedance on RunAPI. Use this package for video generation, animation, and video editing workflows when your application needs 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.
+This 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
 
@@ -13,20 +13,22 @@ gem install runapi-seedance
 ## Quick start
 
 ```ruby
-require "runapi-seedance"
+require "runapi/seedance"
 
 client = RunApi::Seedance::Client.new
-task = client.generations.create(
+task = client.text_to_video.create(
   # Pass the Seedance JSON request body from https://runapi.ai/docs#seedance.
 )
-status = client.generations.get(task.id)
+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::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.
+Use Ruby keyword arguments and the `RunApi::Seedance` error classes when building video jobs, Rails workers, or scripts. The available resources are `text_to_video`. Keep `RUNAPI_API_KEY` in the environment or your secret manager; never commit API keys or callback secrets.
 
 ## Links
 

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/contract_gen.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+module RunApi
+  module Seedance
+    CONTRACT = {
+      "text-to-video" => {
+        "models" => ["seedance-1.5-pro", "seedance-2-mini", "seedance-2.0", "seedance-2.0-fast", "seedance-v1-lite", "seedance-v1-pro", "seedance-v1-pro-fast"],
+        "fields_by_model" => {
+          "seedance-1.5-pro" => {
+            "aspect_ratio" => {
+              "enum" => ["1:1", "4:3", "3:4", "16:9", "9:16", "21:9"]
+            },
+            "duration_seconds" => {
+              "required" => true,
+              "min" => 4,
+              "max" => 12,
+              "type" => "integer"
+            },
+            "output_resolution" => {
+              "enum" => ["480p", "720p", "1080p"]
+            }
+          },
+          "seedance-2-mini" => {
+            "aspect_ratio" => {
+              "enum" => ["1:1", "4:3", "3:4", "16:9", "9:16", "21:9", "auto"]
+            },
+            "duration_seconds" => {
+              "min" => 4,
+              "max" => 15,
+              "type" => "integer"
+            },
+            "output_resolution" => {
+              "enum" => ["480p", "720p"]
+            }
+          },
+          "seedance-2.0" => {
+            "aspect_ratio" => {
+              "enum" => ["1:1", "4:3", "3:4", "16:9", "9:16", "21:9", "auto"]
+            },
+            "duration_seconds" => {
+              "min" => 4,
+              "max" => 15,
+              "type" => "integer"
+            },
+            "output_resolution" => {
+              "enum" => ["480p", "720p", "1080p"]
+            }
+          },
+          "seedance-2.0-fast" => {
+            "aspect_ratio" => {
+              "enum" => ["1:1", "4:3", "3:4", "16:9", "9:16", "21:9", "auto"]
+            },
+            "duration_seconds" => {
+              "min" => 4,
+              "max" => 15,
+              "type" => "integer"
+            },
+            "output_resolution" => {
+              "enum" => ["480p", "720p"]
+            }
+          },
+          "seedance-v1-lite" => {
+            "aspect_ratio" => {
+              "enum" => ["1:1", "4:3", "3:4", "16:9", "9:16", "9:21"]
+            },
+            "duration_seconds" => {
+              "enum" => [5, 10],
+              "required" => true,
+              "type" => "integer"
+            },
+            "output_resolution" => {
+              "enum" => ["480p", "720p", "1080p"]
+            },
+            "seed" => {
+              "type" => "integer"
+            }
+          },
+          "seedance-v1-pro" => {
+            "aspect_ratio" => {
+              "enum" => ["1:1", "4:3", "3:4", "16:9", "9:16", "21:9"]
+            },
+            "duration_seconds" => {
+              "enum" => [5, 10],
+              "required" => true,
+              "type" => "integer"
+            },
+            "output_resolution" => {
+              "enum" => ["480p", "720p", "1080p"]
+            },
+            "seed" => {
+              "type" => "integer"
+            }
+          },
+          "seedance-v1-pro-fast" => {
+            "duration_seconds" => {
+              "enum" => [5, 10],
+              "required" => true,
+              "type" => "integer"
+            },
+            "first_frame_image_url" => {
+              "required" => true
+            },
+            "output_resolution" => {
+              "enum" => ["720p", "1080p"]
+            }
+          }
+        }
+      }
+    }.freeze
+  end
+end

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

@@ -21,41 +21,38 @@ module RunApi
         #
         # @param params [Hash] generation parameters
         # @return [RunApi::Seedance::Types::CompletedTextToVideoResponse] completed generation with videos
-        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
 
         # Create a video generation task.
         #
         # @param params [Hash] generation parameters
         # @return [RunApi::Seedance::Types::TextToVideoResponse] task creation result with id
-        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
 
         # Get generation status by task ID.
         #
         # @param id [String] task ID
         # @return [RunApi::Seedance::Types::TextToVideoResponse] current generation status
-        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
-          unless Types::MODELS.include?(model)
-            raise Core::ValidationError, "Invalid model: #{model}. Must be one of: #{Types::MODELS.join(", ")}"
-          end
-
           prompt = param(params, :prompt)
           raise Core::ValidationError, "prompt is required" unless prompt
 
+          validate_contract!(CONTRACT["text-to-video"], params)
+
+          model = param(params, :model)
           max_prompt = case model
           when "seedance-1.5-pro" then Types::PROMPT_MAX_LENGTH_1_5
           when *Types::V1_MODELS then Types::PROMPT_MAX_LENGTH_V1
@@ -76,10 +73,6 @@ module RunApi
           model = param(params, :model)
           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 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
@@ -93,20 +86,6 @@ module RunApi
 
           reject_unsupported!(params, %i[lock_camera seed], model) if model == "seedance-v1-pro-fast"
 
-          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
-            aspect_ratios = (model == "seedance-v1-lite") ? Types::ASPECT_RATIOS_V1_LITE : Types::ASPECT_RATIOS_V1_PRO
-            validate_optional!(params, :aspect_ratio, aspect_ratios)
-          end
-
-          resolutions = (model == "seedance-v1-pro-fast") ? Types::RESOLUTIONS_V1_PRO_FAST : Types::RESOLUTIONS_V1
-          validate_optional!(params, :output_resolution, resolutions)
-
           seed = param(params, :seed)
           if seed
             unless seed.is_a?(Integer) && Types::SEED_RANGE.cover?(seed)
@@ -116,18 +95,6 @@ module RunApi
         end
 
         def validate_1_5_pro!(params)
-          validate_optional!(params, :aspect_ratio, Types::ASPECT_RATIOS_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
-
           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
@@ -137,18 +104,6 @@ module RunApi
         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, :output_resolution, resolutions)
-
-          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_seconds for seedance-2.0: #{duration_seconds}. Must be an integer between 4 and 15"
-            end
-          end
-
           unsupported = %i[source_image_urls lock_camera]
           reject_unsupported!(params, unsupported, param(params, :model))
 
@@ -171,15 +126,6 @@ module RunApi
             end
           end
         end
-
-        def field_present?(params, key)
-          value = param(params, key)
-          return false if value.nil?
-          return value.any? if value.is_a?(Array)
-          return !value.empty? if value.respond_to?(:empty?)
-
-          true
-        end
       end
     end
   end

data/lib/runapi/seedance/types.rb

@@ -2,43 +2,44 @@
 
 module RunApi
   module Seedance
+    # Type definitions and constants for Seedance video generation.
+    #
+    # Per-model enum, range, and required constraints live in the generated
+    # contract; the constants here back the bespoke checks the contract cannot
+    # express (per-model prompt length and seed range).
     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
-      MODELS = (%w[seedance-1.5-pro seedance-2.0 seedance-2.0-fast] + V1_MODELS).freeze
-
-      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_V1_LITE = %w[1:1 4:3 3:4 16:9 9:16 9:21].freeze
-      ASPECT_RATIOS_V1_PRO = %w[1:1 4:3 3:4 16:9 9:16 21:9].freeze
-
-      RESOLUTIONS_1_5 = %w[480p 720p 1080p].freeze
-      RESOLUTIONS_SEEDANCE_2 = %w[480p 720p 1080p].freeze
-      RESOLUTIONS_SEEDANCE_2_FAST = %w[480p 720p].freeze
-      RESOLUTIONS_V1 = %w[480p 720p 1080p].freeze
-      RESOLUTIONS_V1_PRO_FAST = %w[720p 1080p].freeze
-
-      DURATIONS_1_5 = [4, 8, 12].freeze
-      DURATION_2_RANGE = (4..15)
-      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
 
+      # 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_image_url, String

data/lib/runapi/seedance.rb

@@ -2,6 +2,7 @@
 
 require "runapi/core"
 require_relative "seedance/types"
+require_relative "seedance/contract_gen"
 require_relative "seedance/resources/text_to_video"
 require_relative "seedance/client"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: runapi-seedance
 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.2.9
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.5
-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.
+        version: 0.2.9
+description: The Seedance Ruby SDK is the language-specific package for Seedance on
+  RunAPI. Use this package for video generation, animation, and video editing workflows
+  when your application needs request bodies, task status lookup, and consistent RunAPI
+  errors in Ruby.
 email:
 - contact@runapi.ai
 executables: []
@@ -39,15 +39,18 @@ files:
 - lib/runapi-seedance.rb
 - lib/runapi/seedance.rb
 - lib/runapi/seedance/client.rb
+- lib/runapi/seedance/contract_gen.rb
 - lib/runapi/seedance/resources/text_to_video.rb
 - lib/runapi/seedance/types.rb
 homepage: https://runapi.ai/models/seedance
 licenses:
 - Apache-2.0
 metadata:
+  runapi_slug: seedance
   homepage_uri: https://runapi.ai/models/seedance
   documentation_uri: https://github.com/runapi-ai/seedance-sdk/blob/main/ruby/README.md
   source_code_uri: https://github.com/runapi-ai/seedance-sdk
+  bug_tracker_uri: https://github.com/runapi-ai/seedance-sdk/issues
   changelog_uri: https://github.com/runapi-ai/seedance-sdk/blob/main/CHANGELOG.md
 rdoc_options: []
 require_paths:
@@ -65,5 +68,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 4.0.10
 specification_version: 4
-summary: Seedance API Ruby SDK for RunAPI
+summary: Seedance Ruby SDK for RunAPI
 test_files: []