runapi-kling 0.2.13 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ee363d9aca47d12b9532fe37133181c95bc914e233c127ce86dc7ef9cde3000
-  data.tar.gz: 06e2eea2612c5d2a6eaba6264a7c050d2d61b9cb80c26cfea581139a17baed20
+  metadata.gz: 140439beb109af76dad4b45b4e4f6f2ffb9ff6649b11fea5b7ed80b8a4000323
+  data.tar.gz: 4f4cfd9fa579b7c5c673243a24974529f0adee777666fec4c8da353cbf3a3711
 SHA512:
-  metadata.gz: 6bc711db4985a209433276045dfb1174b4295f7256075287da212e98f4f443e8b2670a99f3344410b6441d507cd10465f691b46b97b129b9b22066a7d5a1a085
-  data.tar.gz: b5e93c8807bacc42d3988ee2e1146011733ec0f0d5f9eda7d9fff97b7ad81ed72d6db39f7ee2ba1b2e334c69044026efde4c65fe2f7d250ad37762cb6d6552df
+  metadata.gz: af7e49904ef9611be7add201a6ca3abc5486bf5349a530201c252bfe551efb234879c55ebe70c0d04b44efc6dbfbe558d58a129e875515933191b6855da2ebe5
+  data.tar.gz: 52712ddf7503925a719b436867b4aa41191ab9931e0d56d18d5c9061f604b67f3dd782245df3bcdc5dd7f6561d057f5a21c8ba3382eeee6c651a8b34ef43325a

data/README.md

@@ -2,7 +2,7 @@
 
 The Kling Ruby SDK is the language-specific package for Kling 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 README is the Ruby package guide inside the public `kling-sdk` repository. For the repository overview, start at `../README.md`; for model details, use https://runapi.ai/models/kling; for API reference, use https://runapi.ai/docs#kling; for SDK docs, use https://runapi.ai/docs#sdk-kling.
+This README is the Ruby package guide inside the public `kling-sdk` repository. For the repository overview, start at `../README.md`; for model details, use https://runapi.ai/models/kling; for API reference, use https://runapi.ai/docs/api/kling/text-to-video; for SDK docs, use https://runapi.ai/docs/resources/sdks.
 
 ## Install
 
@@ -17,7 +17,7 @@ require "runapi/kling"
 
 client = RunApi::Kling::Client.new
 task = client.text_to_video.create(
-  # Pass the Kling JSON request body from https://runapi.ai/docs#kling.
+  # Pass the Kling JSON request body from https://runapi.ai/docs/api/kling/text-to-video.
 )
 status = client.text_to_video.get(task.id)
 ```
@@ -39,19 +39,23 @@ result = client.text_to_video.run(
 
 Number reference images in prompt order as `<<<image_1>>>`, `<<<image_2>>>`, and so on; the optional video is `<<<video_1>>>`. With a video, send at most four images. Do not combine `last_frame_image_url` with reference images or a reference video. A `feature` reference video may be used with the required first frame; `base` cannot be combined with frame inputs. O1 requests are five seconds and keep sound disabled. Pricing and limits: https://runapi.ai/models/kling/o1.
 
+## Kling V3 Omni source-video editing
+
+Use `kling-v3-omni-reference` with `text_to_video` for image-only reference inputs. For a source video, use `edit_video` with either `kling-v3-omni-reference` or `kling-v3-omni-edit`. The reference model keeps sound disabled for source-video requests.
+
 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::Kling` error classes when building video jobs, Rails workers, or scripts. The available resources are `text_to_video`, `ai_avatar`, `image_to_video`, and `motion_control`. 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::Kling` error classes when building video jobs, Rails workers, or scripts. The available resources are `text_to_video`, `edit_video`, `ai_avatar`, `image_to_video`, and `motion_control`. 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/kling
-- SDK docs: https://runapi.ai/docs#sdk-kling
-- Product docs: https://runapi.ai/docs#kling
+- SDK docs: https://runapi.ai/docs/resources/sdks
+- Product docs: https://runapi.ai/docs/api/kling/text-to-video
 - Pricing and rate limits: https://runapi.ai/models/kling/3.0
 - Provider comparison: https://runapi.ai/providers/kuaishou
 - Full catalog: https://runapi.ai/models

data/lib/runapi/kling/client.rb

@@ -19,6 +19,8 @@ module RunApi
       # @return [Resources::MotionControl] Motion control operations.
       attr_reader :motion_control
       attr_reader :extend_video
+      # @return [Resources::EditVideo] Source-video editing operations.
+      attr_reader :edit_video
 
       def initialize(api_key: nil, **options)
         super
@@ -27,6 +29,7 @@ module RunApi
         @image_to_video = Resources::ImageToVideo.new(http)
         @motion_control = Resources::MotionControl.new(http)
         @extend_video = Resources::ExtendVideo.new(http)
+        @edit_video = Resources::EditVideo.new(http)
       end
     end
   end

data/lib/runapi/kling/contract_gen.rb

@@ -64,6 +64,236 @@ module RunApi
           }
         }
       },
+      "edit-video" => {
+        "models" => ["kling-v3-omni-edit", "kling-v3-omni-reference"],
+        "fields_by_model" => {
+          "kling-v3-omni-edit" => {
+            "aspect_ratio" => {
+              "enum" => ["auto", "16:9", "9:16", "1:1"]
+            },
+            "duration_seconds" => {
+              "enum" => [3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15],
+              "type" => "integer"
+            },
+            "model" => {
+              "required" => true
+            },
+            "output_resolution" => {
+              "enum" => ["720p", "1080p", "4k"]
+            },
+            "prompt" => {
+              "required" => true,
+              "min" => 1,
+              "max" => 2500,
+              "length" => true
+            },
+            "reference_image_urls" => {
+              "min_items" => 1,
+              "max_items" => 4
+            }
+          },
+          "kling-v3-omni-reference" => {
+            "aspect_ratio" => {
+              "enum" => ["auto", "16:9", "9:16", "1:1"]
+            },
+            "duration_seconds" => {
+              "enum" => [3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15],
+              "type" => "integer"
+            },
+            "model" => {
+              "required" => true
+            },
+            "output_resolution" => {
+              "enum" => ["720p", "1080p", "4k"]
+            },
+            "prompt" => {
+              "required" => true,
+              "min" => 1,
+              "max" => 2500,
+              "length" => true
+            },
+            "reference_image_urls" => {
+              "min_items" => 1,
+              "max_items" => 4
+            }
+          }
+        },
+        "rules" => [{
+          "when" => {
+            "model" => "kling-v3-omni-edit",
+            "source_task_id" => {
+              "present" => false
+            },
+            "source_video_url" => {
+              "present" => false
+            }
+          },
+          "required_any" => ["source_video_url", "source_task_id"]
+        }, {
+          "when" => {
+            "model" => "kling-v3-omni-edit",
+            "source_video_url" => {
+              "present" => true
+            }
+          },
+          "forbidden" => ["source_task_id"]
+        }, {
+          "when" => {
+            "model" => "kling-v3-omni-edit",
+            "source_task_id" => {
+              "present" => true
+            }
+          },
+          "forbidden" => ["source_video_url"]
+        }, {
+          "enum" => {
+            "aspect_ratio" => ["auto"],
+            "duration_seconds" => [5]
+          },
+          "when" => {
+            "model" => "kling-v3-omni-edit",
+            "source_video_url" => {
+              "present" => true
+            },
+            "reference_image_urls" => {
+              "present" => false
+            }
+          },
+          "required" => ["aspect_ratio"]
+        }, {
+          "enum" => {
+            "aspect_ratio" => ["auto"],
+            "duration_seconds" => [5]
+          },
+          "when" => {
+            "model" => "kling-v3-omni-edit",
+            "source_task_id" => {
+              "present" => true
+            },
+            "reference_image_urls" => {
+              "present" => false
+            }
+          },
+          "required" => ["aspect_ratio"]
+        }, {
+          "enum" => {
+            "aspect_ratio" => ["16:9", "9:16", "1:1"]
+          },
+          "when" => {
+            "model" => "kling-v3-omni-edit",
+            "source_video_url" => {
+              "present" => true
+            },
+            "reference_image_urls" => {
+              "present" => true
+            }
+          },
+          "required" => ["aspect_ratio"]
+        }, {
+          "enum" => {
+            "aspect_ratio" => ["16:9", "9:16", "1:1"]
+          },
+          "when" => {
+            "model" => "kling-v3-omni-edit",
+            "source_task_id" => {
+              "present" => true
+            },
+            "reference_image_urls" => {
+              "present" => true
+            }
+          },
+          "required" => ["aspect_ratio"]
+        }, {
+          "when" => {
+            "model" => "kling-v3-omni-reference",
+            "source_task_id" => {
+              "present" => false
+            },
+            "source_video_url" => {
+              "present" => false
+            }
+          },
+          "required_any" => ["source_video_url", "source_task_id"]
+        }, {
+          "when" => {
+            "model" => "kling-v3-omni-reference",
+            "source_video_url" => {
+              "present" => true
+            }
+          },
+          "forbidden" => ["source_task_id"]
+        }, {
+          "when" => {
+            "model" => "kling-v3-omni-reference",
+            "source_task_id" => {
+              "present" => true
+            }
+          },
+          "forbidden" => ["source_video_url"]
+        }, {
+          "enum" => {
+            "aspect_ratio" => ["auto"],
+            "enable_sound" => [false],
+            "duration_seconds" => [5]
+          },
+          "when" => {
+            "model" => "kling-v3-omni-reference",
+            "source_video_url" => {
+              "present" => true
+            },
+            "reference_image_urls" => {
+              "present" => false
+            }
+          },
+          "required" => ["aspect_ratio"]
+        }, {
+          "enum" => {
+            "aspect_ratio" => ["auto"],
+            "enable_sound" => [false],
+            "duration_seconds" => [5]
+          },
+          "when" => {
+            "model" => "kling-v3-omni-reference",
+            "source_task_id" => {
+              "present" => true
+            },
+            "reference_image_urls" => {
+              "present" => false
+            }
+          },
+          "required" => ["aspect_ratio"]
+        }, {
+          "enum" => {
+            "aspect_ratio" => ["16:9", "9:16", "1:1"],
+            "enable_sound" => [false]
+          },
+          "when" => {
+            "model" => "kling-v3-omni-reference",
+            "source_video_url" => {
+              "present" => true
+            },
+            "reference_image_urls" => {
+              "present" => true
+            }
+          },
+          "required" => ["aspect_ratio"]
+        }, {
+          "enum" => {
+            "aspect_ratio" => ["16:9", "9:16", "1:1"],
+            "enable_sound" => [false]
+          },
+          "when" => {
+            "model" => "kling-v3-omni-reference",
+            "source_task_id" => {
+              "present" => true
+            },
+            "reference_image_urls" => {
+              "present" => true
+            }
+          },
+          "required" => ["aspect_ratio"]
+        }]
+      },
       "extend-video" => {
         "models" => ["kling-v2.5-turbo-image-to-video-pro", "kling-v2.5-turbo-text-to-video-pro"],
         "fields_by_model" => {
@@ -346,7 +576,7 @@ module RunApi
         }]
       },
       "text-to-video" => {
-        "models" => ["kling-3.0", "kling-o1", "kling-v2.1-master-text-to-video", "kling-v2.5-turbo-text-to-video-pro", "kling-v2.6", "kling-v3-omni", "kling-v3-turbo-text-to-video"],
+        "models" => ["kling-3.0", "kling-o1", "kling-v2.1-master-text-to-video", "kling-v2.5-turbo-text-to-video-pro", "kling-v2.6", "kling-v3-omni", "kling-v3-omni-reference", "kling-v3-turbo-text-to-video"],
         "fields_by_model" => {
           "kling-3.0" => {
             "aspect_ratio" => {
@@ -457,6 +687,33 @@ module RunApi
               "length" => true
             }
           },
+          "kling-v3-omni-reference" => {
+            "aspect_ratio" => {
+              "enum" => ["16:9", "9:16", "1:1"],
+              "required" => true
+            },
+            "duration_seconds" => {
+              "enum" => [3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15],
+              "type" => "integer"
+            },
+            "model" => {
+              "required" => true
+            },
+            "output_resolution" => {
+              "enum" => ["720p", "1080p", "4k"]
+            },
+            "prompt" => {
+              "required" => true,
+              "min" => 1,
+              "max" => 2500,
+              "length" => true
+            },
+            "reference_image_urls" => {
+              "required" => true,
+              "min_items" => 1,
+              "max_items" => 7
+            }
+          },
           "kling-v3-turbo-text-to-video" => {
             "aspect_ratio" => {
               "enum" => ["16:9", "9:16", "1:1"]

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module RunApi
+  module Kling
+    module Resources
+      # Edit a source video with a selected Kling V3 Omni model.
+      class EditVideo
+        include RunApi::Core::ResourceHelpers
+
+        ENDPOINT = "/api/v1/kling/edit_video"
+        RESPONSE_CLASS = Types::TextToVideoResponse
+        COMPLETED_RESPONSE_CLASS = Types::CompletedTextToVideoResponse
+
+        def initialize(http)
+          @http = http
+        end
+
+        def run(options: nil, **params)
+          task = create(options: options, **params)
+          poll_until_complete { get(task.id, options: options) }
+        end
+
+        def create(options: nil, **params)
+          params = compact_params(params)
+          validate_contract!(CONTRACT["edit-video"], params)
+          request(:post, ENDPOINT, body: params, options: options)
+        end
+
+        def get(id, options: nil)
+          request(:get, "#{ENDPOINT}/#{id}", options: options)
+        end
+      end
+    end
+  end
+end

data/lib/runapi/kling.rb

@@ -9,6 +9,7 @@ require_relative "kling/resources/ai_avatar"
 require_relative "kling/resources/image_to_video"
 require_relative "kling/resources/motion_control"
 require_relative "kling/resources/extend_video"
+require_relative "kling/resources/edit_video"
 require_relative "kling/client"
 
 module RunApi

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: runapi-kling
 version: !ruby/object:Gem::Version
-  version: 0.2.13
+  version: 0.3.0
 platform: ruby
 authors:
 - RunAPI
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.4.0
 description: The Kling Ruby SDK is the language-specific package for Kling 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
@@ -41,6 +41,7 @@ files:
 - lib/runapi/kling/client.rb
 - lib/runapi/kling/contract_gen.rb
 - lib/runapi/kling/resources/ai_avatar.rb
+- lib/runapi/kling/resources/edit_video.rb
 - lib/runapi/kling/resources/extend_video.rb
 - lib/runapi/kling/resources/image_to_video.rb
 - lib/runapi/kling/resources/motion_control.rb