runapi-kling 0.2.2__tar.gz → 0.3.0__tar.gz

{runapi_kling-0.2.2 → runapi_kling-0.3.0}/PKG-INFO

@@ -1,18 +1,18 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: runapi-kling
-Version: 0.2.2
-Summary: RunAPI Kling SDK for text-to-video, image-to-video, avatar, and motion-control workflows in JavaScript, Python, Ruby, Go, Java, and PHP
+Version: 0.3.0
+Summary: RunAPI Kling SDK for text-to-video, image-to-video, source-video editing, avatar, and motion-control workflows in JavaScript, Python, Ruby, Go, Java, and PHP
 Project-URL: Homepage, https://runapi.ai/models/kling
 Project-URL: Documentation, https://runapi.ai/docs/resources/sdks
 Project-URL: Source, https://github.com/runapi-ai/kling-sdk
 Project-URL: Issues, https://github.com/runapi-ai/kling-sdk/issues
 Project-URL: Changelog, https://github.com/runapi-ai/kling-sdk/blob/main/CHANGELOG.md
-Project-URL: Release Notes, https://github.com/runapi-ai/kling-sdk/releases/tag/python%2Fv0.2.2
+Project-URL: Release Notes, https://github.com/runapi-ai/kling-sdk/releases/tag/python%2Fv0.3.0
 Author-email: RunAPI <contact@runapi.ai>
 License-Expression: Apache-2.0
 Keywords: api,golang,gradle,java,kling,kling-ai-api,maven,python,ruby,runapi,runapi-ai,sdk,text-to-video,typescript,video-api,video-generation
 Requires-Python: >=3.9
-Requires-Dist: runapi-core>=0.3.3
+Requires-Dist: runapi-core>=0.7.0
 Description-Content-Type: text/markdown
 
 # Kling API Python SDK for RunAPI
@@ -65,6 +65,10 @@ 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:
 
 ```python
@@ -81,7 +85,7 @@ RunAPI-generated file URLs are temporary. Download and store generated images, v
 
 ## Language notes
 
-Pass parameters as keyword arguments and catch the `runapi.kling` error classes when building video jobs, 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.
+Pass parameters as keyword arguments and catch the `runapi.kling` error classes when building video jobs, 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
 

{runapi_kling-0.2.2 → runapi_kling-0.3.0}/README.md

@@ -48,6 +48,10 @@ 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:
 
 ```python
@@ -64,7 +68,7 @@ RunAPI-generated file URLs are temporary. Download and store generated images, v
 
 ## Language notes
 
-Pass parameters as keyword arguments and catch the `runapi.kling` error classes when building video jobs, 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.
+Pass parameters as keyword arguments and catch the `runapi.kling` error classes when building video jobs, 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
 

{runapi_kling-0.2.2 → runapi_kling-0.3.0}/pyproject.toml

@@ -4,14 +4,14 @@ build-backend = "hatchling.build"
 
 [project]
 name = "runapi-kling"
-version = "0.2.2"
-description = "RunAPI Kling SDK for text-to-video, image-to-video, avatar, and motion-control workflows in JavaScript, Python, Ruby, Go, Java, and PHP"
+version = "0.3.0"
+description = "RunAPI Kling SDK for text-to-video, image-to-video, source-video editing, avatar, and motion-control workflows in JavaScript, Python, Ruby, Go, Java, and PHP"
 readme = "README.md"
 requires-python = ">=3.9"
 license = "Apache-2.0"
 authors = [{ name = "RunAPI", email = "contact@runapi.ai" }]
 keywords = ["runapi", "runapi-ai", "kling", "api", "sdk", "typescript", "python", "ruby", "golang", "java", "maven", "gradle", "video-generation", "text-to-video", "video-api", "kling-ai-api"]
-dependencies = ["runapi-core>=0.3.3"]
+dependencies = ["runapi-core>=0.7.0"]
 
 [project.urls]
 Homepage = "https://runapi.ai/models/kling"
@@ -19,7 +19,7 @@ Documentation = "https://runapi.ai/docs/resources/sdks"
 Source = "https://github.com/runapi-ai/kling-sdk"
 Issues = "https://github.com/runapi-ai/kling-sdk/issues"
 Changelog = "https://github.com/runapi-ai/kling-sdk/blob/main/CHANGELOG.md"
-"Release Notes" = "https://github.com/runapi-ai/kling-sdk/releases/tag/python%2Fv0.2.2"
+"Release Notes" = "https://github.com/runapi-ai/kling-sdk/releases/tag/python%2Fv0.3.0"
 
 [tool.hatch.build.targets.wheel]
 packages = ["src/runapi"]

{runapi_kling-0.2.2 → runapi_kling-0.3.0}/src/runapi/kling/client.py

@@ -7,6 +7,7 @@ from typing import Any, Optional
 from runapi.core import ProviderClient
 
 from .resources.ai_avatar import AiAvatar
+from .resources.edit_video import EditVideo
 from .resources.image_to_video import ImageToVideo
 from .resources.motion_control import MotionControl
 from .resources.text_to_video import TextToVideo
@@ -32,3 +33,4 @@ class KlingClient(ProviderClient):
         self.image_to_video = ImageToVideo(http)
         self.motion_control = MotionControl(http)
         self.extend_video = ExtendVideo(http)
+        self.edit_video = EditVideo(http)

{runapi_kling-0.2.2 → runapi_kling-0.3.0}/src/runapi/kling/contract_gen.py

@@ -60,6 +60,236 @@ CONTRACT = {
             }
         }
     },
+    "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": {
@@ -342,7 +572,7 @@ CONTRACT = {
         }]
     },
     "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": {
@@ -453,6 +683,33 @@ CONTRACT = {
                     "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"]

{runapi_kling-0.2.2 → runapi_kling-0.3.0}/src/runapi/kling/resources/__init__.py

@@ -1,7 +1,8 @@
 from .ai_avatar import AiAvatar
+from .edit_video import EditVideo
 from .extend_video import ExtendVideo
 from .image_to_video import ImageToVideo
 from .motion_control import MotionControl
 from .text_to_video import TextToVideo
 
-__all__ = ["TextToVideo", "AiAvatar", "ImageToVideo", "MotionControl", "ExtendVideo"]
+__all__ = ["TextToVideo", "AiAvatar", "EditVideo", "ImageToVideo", "MotionControl", "ExtendVideo"]

runapi_kling-0.3.0/src/runapi/kling/resources/edit_video.py

@@ -0,0 +1,33 @@
+"""Kling source-video editing resource."""
+
+from __future__ import annotations
+
+from typing import Any, Optional
+
+from runapi.core import RequestOptions, Resource
+
+from ..contract_gen import CONTRACT
+from ..types import CompletedTextToVideoResponse, TextToVideoResponse
+
+
+class EditVideo(Resource):
+    """Edit a source video with a selected Kling V3 Omni model."""
+
+    ENDPOINT = "/api/v1/kling/edit_video"
+    RESPONSE_CLASS = TextToVideoResponse
+    COMPLETED_RESPONSE_CLASS = CompletedTextToVideoResponse
+
+    def run(self, options: Optional[RequestOptions] = None, **params: Any) -> Any:
+        """Create an edit-video task and poll until it completes."""
+        task = self.create(options=options, **params)
+        return self._poll_until_complete(lambda: self.get(task.id, options=options))
+
+    def create(self, options: Optional[RequestOptions] = None, **params: Any) -> Any:
+        """Create an edit-video task with a caller-supplied model."""
+        compacted = self._compact_params(params)
+        self._validate_contract(CONTRACT["edit-video"], compacted)
+        return self._request("post", self.ENDPOINT, body=compacted, options=options)
+
+    def get(self, id: str, options: Optional[RequestOptions] = None) -> Any:
+        """Fetch the current status of an edit-video task."""
+        return self._request("get", f"{self.ENDPOINT}/{id}", options=options)

{runapi_kling-0.2.2 → runapi_kling-0.3.0}/tests/test_client.py

@@ -4,6 +4,7 @@ from runapi.core import config
 from runapi.core.errors import AuthenticationError, ValidationError
 from runapi.kling import KlingClient
 from runapi.kling.resources.ai_avatar import AiAvatar
+from runapi.kling.resources.edit_video import EditVideo
 from runapi.kling.resources.image_to_video import ImageToVideo
 from runapi.kling.resources.motion_control import MotionControl
 from runapi.kling.resources.text_to_video import TextToVideo
@@ -70,6 +71,7 @@ def test_uses_injected_http_client():
     assert client.ai_avatar._http is fake
     assert client.image_to_video._http is fake
     assert client.motion_control._http is fake
+    assert client.edit_video._http is fake
 
 
 def test_exposes_resource_accessors():
@@ -78,6 +80,7 @@ def test_exposes_resource_accessors():
     assert isinstance(client.ai_avatar, AiAvatar)
     assert isinstance(client.image_to_video, ImageToVideo)
     assert isinstance(client.motion_control, MotionControl)
+    assert isinstance(client.edit_video, EditVideo)
 
 
 # --- text_to_video --------------------------------------------------------
@@ -1046,3 +1049,68 @@ def test_multi_prompt_non_numeric_duration_raises_validation_error():
             enable_sound=True,
             multi_prompt=[{"prompt": "shot one", "duration_seconds": "abc"}],
         )
+
+
+def test_text_to_video_accepts_reference_image_model():
+    fake = FakeHttp({"id": "reference-image", "status": "processing"})
+    client = KlingClient(api_key="k", http_client=fake)
+    params = {
+        "model": "kling-v3-omni-reference",
+        "prompt": "Keep the subject from the reference image",
+        "reference_image_urls": ["https://cdn.runapi.ai/public/samples/image.jpg"],
+        "aspect_ratio": "16:9",
+    }
+
+    client.text_to_video.create(**params)
+    assert fake.calls == [("post", "/api/v1/kling/text_to_video", params)]
+
+
+def test_edit_video_create_get_and_run_for_edit_model():
+    fake = FakeHttp(
+        {"id": "edit-create", "status": "processing"},
+        {"id": "edit-get", "status": "processing"},
+        {"id": "edit-run", "status": "processing"},
+        {"id": "edit-run", "status": "completed", "videos": [{"url": "https://file.runapi.ai/edit.mp4"}]},
+    )
+    client = KlingClient(api_key="k", http_client=fake)
+    params = {
+        "model": "kling-v3-omni-edit",
+        "prompt": "Turn the source video into a watercolor scene",
+        "source_video_url": "https://cdn.runapi.ai/public/samples/video.mp4",
+        "aspect_ratio": "auto",
+    }
+
+    client.edit_video.create(**params)
+    client.edit_video.get("edit-get")
+    result = client.edit_video.run(**params)
+
+    assert fake.calls == [
+        ("post", "/api/v1/kling/edit_video", params),
+        ("get", "/api/v1/kling/edit_video/edit-get", None),
+        ("post", "/api/v1/kling/edit_video", params),
+        ("get", "/api/v1/kling/edit_video/edit-run", None),
+    ]
+    assert result.status == "completed"
+
+
+def test_edit_video_accepts_reference_model_and_requires_model():
+    fake = FakeHttp({"id": "reference-create", "status": "processing"})
+    client = KlingClient(api_key="k", http_client=fake)
+    params = {
+        "model": "kling-v3-omni-reference",
+        "prompt": "Keep the subject from the reference image",
+        "source_video_url": "https://cdn.runapi.ai/public/samples/video.mp4",
+        "reference_image_urls": ["https://cdn.runapi.ai/public/samples/image.jpg"],
+        "aspect_ratio": "16:9",
+        "enable_sound": False,
+    }
+
+    client.edit_video.create(**params)
+    assert fake.calls == [("post", "/api/v1/kling/edit_video", params)]
+
+    with pytest.raises(ValidationError, match="model must be one of"):
+        client.edit_video.create(
+            prompt="Turn the source video into a watercolor scene",
+            source_video_url="https://cdn.runapi.ai/public/samples/video.mp4",
+            aspect_ratio="auto",
+        )