runapi-vidu 0.1.0__tar.gz

runapi_vidu-0.1.0/PKG-INFO

@@ -0,0 +1,47 @@
+Metadata-Version: 2.5
+Name: runapi-vidu
+Version: 0.1.0
+Summary: RunAPI Vidu SDK for image-to-video and reference-to-video workflows in JavaScript, Python, Ruby, Go, Java, and PHP
+Project-URL: Homepage, https://runapi.ai/models/vidu
+Project-URL: Documentation, https://runapi.ai/docs/resources/sdks
+Project-URL: Source, https://github.com/runapi-ai/vidu-sdk
+Project-URL: Issues, https://github.com/runapi-ai/vidu-sdk/issues
+Project-URL: Changelog, https://github.com/runapi-ai/vidu-sdk/blob/main/CHANGELOG.md
+Project-URL: Release Notes, https://github.com/runapi-ai/vidu-sdk/releases/tag/python%2Fv0.1.0
+Author-email: RunAPI <contact@runapi.ai>
+License-Expression: Apache-2.0
+Keywords: api,golang,gradle,java,maven,python,reference-to-video,ruby,runapi,runapi-ai,sdk,typescript,video-api,video-generation,vidu,vidu-ai-api
+Requires-Python: >=3.9
+Requires-Dist: runapi-core~=0.10.1
+Description-Content-Type: text/markdown
+
+# Vidu Python SDK for RunAPI
+
+Create image-to-video or reference-to-video tasks, retrieve their status, or use `run` to poll until completion. Validation runs on the RunAPI server.
+
+## Install
+
+```sh
+pip install runapi-vidu
+```
+
+## Quick start
+
+Set `RUNAPI_API_KEY` in your environment. Replace the example image URL with a publicly accessible reference image.
+
+```python
+from runapi.vidu import ViduClient
+
+client = ViduClient()  # reads RUNAPI_API_KEY
+result = client.reference_to_video.run(
+    model="vidu-q4-reference-to-video",
+    prompt="Animate the referenced scene with a slow camera pan",
+    reference_image_urls=["https://cdn.runapi.ai/public/samples/image.jpg"],
+    audio=False,
+)
+print(result.videos[0].url)
+```
+
+Use `create` to submit without waiting and `get` to retrieve the task by ID. Reference generation requires a prompt and 1–15 image URLs; it also accepts up to 3 MP3 reference audio URLs. Images must be JPG/JPEG/PNG/WEBP, at most 50 MB each; MP3 references must be 3–12 seconds and at most 50 MB each. Remote file properties are checked during provider processing, so a task can fail asynchronously.
+
+See the [API reference](https://runapi.ai/docs/api/vidu/reference-to-video) and [SDK guide](https://runapi.ai/docs/resources/sdks). For current pricing, use the canonical model pages: [image-to-video](https://runapi.ai/models/vidu/q4-image-to-video) and [reference-to-video](https://runapi.ai/models/vidu/q4-reference-to-video).

runapi_vidu-0.1.0/README.md

@@ -0,0 +1,30 @@
+# Vidu Python SDK for RunAPI
+
+Create image-to-video or reference-to-video tasks, retrieve their status, or use `run` to poll until completion. Validation runs on the RunAPI server.
+
+## Install
+
+```sh
+pip install runapi-vidu
+```
+
+## Quick start
+
+Set `RUNAPI_API_KEY` in your environment. Replace the example image URL with a publicly accessible reference image.
+
+```python
+from runapi.vidu import ViduClient
+
+client = ViduClient()  # reads RUNAPI_API_KEY
+result = client.reference_to_video.run(
+    model="vidu-q4-reference-to-video",
+    prompt="Animate the referenced scene with a slow camera pan",
+    reference_image_urls=["https://cdn.runapi.ai/public/samples/image.jpg"],
+    audio=False,
+)
+print(result.videos[0].url)
+```
+
+Use `create` to submit without waiting and `get` to retrieve the task by ID. Reference generation requires a prompt and 1–15 image URLs; it also accepts up to 3 MP3 reference audio URLs. Images must be JPG/JPEG/PNG/WEBP, at most 50 MB each; MP3 references must be 3–12 seconds and at most 50 MB each. Remote file properties are checked during provider processing, so a task can fail asynchronously.
+
+See the [API reference](https://runapi.ai/docs/api/vidu/reference-to-video) and [SDK guide](https://runapi.ai/docs/resources/sdks). For current pricing, use the canonical model pages: [image-to-video](https://runapi.ai/models/vidu/q4-image-to-video) and [reference-to-video](https://runapi.ai/models/vidu/q4-reference-to-video).

runapi_vidu-0.1.0/pyproject.toml

@@ -0,0 +1,34 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "runapi-vidu"
+version = "0.1.0"
+description = "RunAPI Vidu SDK for image-to-video and reference-to-video 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", "vidu", "api", "sdk", "typescript", "python", "ruby", "golang", "java", "maven", "gradle", "video-generation", "reference-to-video", "video-api", "vidu-ai-api"]
+dependencies = ["runapi-core~=0.10.1"]
+
+[project.urls]
+Homepage = "https://runapi.ai/models/vidu"
+Documentation = "https://runapi.ai/docs/resources/sdks"
+Source = "https://github.com/runapi-ai/vidu-sdk"
+Issues = "https://github.com/runapi-ai/vidu-sdk/issues"
+Changelog = "https://github.com/runapi-ai/vidu-sdk/blob/main/CHANGELOG.md"
+"Release Notes" = "https://github.com/runapi-ai/vidu-sdk/releases/tag/python%2Fv0.1.0"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/runapi"]
+
+[tool.uv]
+package = true
+
+[dependency-groups]
+dev = ["pytest>=8"]
+
+[tool.runapi]
+slug = "vidu"

runapi_vidu-0.1.0/src/runapi/vidu/__init__.py

@@ -0,0 +1,24 @@
+"""Vidu client for RunAPI."""
+
+from runapi.core import (
+    AuthenticationError,
+    InsufficientCreditsError,
+    NotFoundError,
+    RateLimitError,
+    TaskFailedError,
+    TaskTimeoutError,
+    ValidationError,
+)
+
+from .client import ViduClient
+
+__all__ = [
+    "ViduClient",
+    "AuthenticationError",
+    "RateLimitError",
+    "InsufficientCreditsError",
+    "NotFoundError",
+    "ValidationError",
+    "TaskFailedError",
+    "TaskTimeoutError",
+]

runapi_vidu-0.1.0/src/runapi/vidu/client.py

@@ -0,0 +1,20 @@
+"""Vidu client."""
+
+from __future__ import annotations
+
+from typing import Any, Optional
+
+from runapi.core import ProviderClient
+
+from .resources.image_to_video import ImageToVideo
+from .resources.reference_to_video import ReferenceToVideo
+
+
+class ViduClient(ProviderClient):
+    """Vidu image-to-video and reference-to-video client."""
+
+    def __init__(self, api_key: Optional[str] = None, **options: Any) -> None:
+        super().__init__(api_key, **options)
+        http = self._http
+        self.image_to_video = ImageToVideo(http)
+        self.reference_to_video = ReferenceToVideo(http)

runapi_vidu-0.1.0/src/runapi/vidu/resources/__init__.py

@@ -0,0 +1,4 @@
+from .image_to_video import ImageToVideo
+from .reference_to_video import ReferenceToVideo
+
+__all__ = ["ImageToVideo", "ReferenceToVideo"]

runapi_vidu-0.1.0/src/runapi/vidu/resources/image_to_video.py

@@ -0,0 +1,56 @@
+"""Vidu image-to-video resource."""
+
+from __future__ import annotations
+
+from typing import Any, Optional
+
+from runapi.core import Resource, RequestOptions
+
+from ..types import (
+    CompletedImageToVideoResponse,
+    ImageToVideoResponse,
+)
+
+
+class ImageToVideo(Resource):
+    """Generate videos from a first-frame image with Vidu models."""
+
+    ENDPOINT = "/api/v1/vidu/image_to_video"
+
+    RESPONSE_CLASS = ImageToVideoResponse
+    COMPLETED_RESPONSE_CLASS = CompletedImageToVideoResponse
+
+    def run(self, options: Optional[RequestOptions] = None, **params: Any) -> Any:
+        """Create an image-to-video task and poll until it completes.
+
+        Args:
+            **params: Image-to-video parameters (model, first_frame_image_url, ...).
+
+        Returns:
+            The completed task with videos.
+        """
+        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 image-to-video task and return immediately with an ``id``.
+
+        Args:
+            **params: Image-to-video parameters (model, first_frame_image_url, ...).
+
+        Returns:
+            The task creation result with an id.
+        """
+        compacted = self._compact_params(params)
+        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 image-to-video task.
+
+        Args:
+            id: The task id.
+
+        Returns:
+            The current task status.
+        """
+        return self._request("get", f"{self.ENDPOINT}/{id}", options=options)

runapi_vidu-0.1.0/src/runapi/vidu/resources/reference_to_video.py

@@ -0,0 +1,56 @@
+"""Vidu reference-to-video resource."""
+
+from __future__ import annotations
+
+from typing import Any, Optional
+
+from runapi.core import Resource, RequestOptions
+
+from ..types import (
+    CompletedReferenceToVideoResponse,
+    ReferenceToVideoResponse,
+)
+
+
+class ReferenceToVideo(Resource):
+    """Generate videos from a first-frame image with Vidu models."""
+
+    ENDPOINT = "/api/v1/vidu/reference_to_video"
+
+    RESPONSE_CLASS = ReferenceToVideoResponse
+    COMPLETED_RESPONSE_CLASS = CompletedReferenceToVideoResponse
+
+    def run(self, options: Optional[RequestOptions] = None, **params: Any) -> Any:
+        """Create an reference-to-video task and poll until it completes.
+
+        Args:
+            **params: Image-to-video parameters (model, reference_image_urls, ...).
+
+        Returns:
+            The completed task with videos.
+        """
+        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 reference-to-video task and return immediately with an ``id``.
+
+        Args:
+            **params: Image-to-video parameters (model, reference_image_urls, ...).
+
+        Returns:
+            The task creation result with an id.
+        """
+        compacted = self._compact_params(params)
+        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 reference-to-video task.
+
+        Args:
+            id: The task id.
+
+        Returns:
+            The current task status.
+        """
+        return self._request("get", f"{self.ENDPOINT}/{id}", options=options)

runapi_vidu-0.1.0/src/runapi/vidu/types.py

@@ -0,0 +1,32 @@
+"""Vidu model lists, enums, and response models."""
+
+from __future__ import annotations
+
+from runapi.core import BaseModel, TaskResponse, optional, required
+
+
+
+class MediaUrl(BaseModel):
+    url = optional(str)
+
+
+class VideoResponse(TaskResponse):
+    """Response for a video generation task."""
+
+    id = required(str)
+    status = optional(str, enum=lambda: TaskResponse.Status.ALL)
+    videos = optional([lambda: MediaUrl])
+    error = optional(str)
+
+
+class CompletedVideoResponse(VideoResponse):
+    """Narrowed response from ``run()`` once polling observes completion."""
+
+    videos = required([lambda: MediaUrl])
+
+
+ImageToVideoResponse = VideoResponse
+CompletedImageToVideoResponse = CompletedVideoResponse
+
+ReferenceToVideoResponse = VideoResponse
+CompletedReferenceToVideoResponse = CompletedVideoResponse

runapi_vidu-0.1.0/tests/test_client.py

@@ -0,0 +1,26 @@
+import pytest
+from runapi.vidu import ViduClient
+
+class FakeHttp:
+    def __init__(self, *responses):
+        self.responses = list(responses)
+        self.calls = []
+    def request(self, method, path, body=None, options=None):
+        self.calls.append((method, path, body))
+        return self.responses.pop(0)
+
+@pytest.mark.parametrize("resource,fields", [
+    ("image_to_video", {"first_frame_image_url": "https://x/image.jpg"}),
+    ("reference_to_video", {"reference_image_urls": ["https://x/1.jpg", "https://x/2.jpg"], "reference_audio_urls": ["https://x/a.mp3"], "aspect_ratio": "16:9"}),
+])
+def test_create_get_and_run(resource, fields):
+    completed = {"id": "t1", "status": "completed", "videos": [{"url": "https://x/v.mp4"}]}
+    fake = FakeHttp({"id": "t1", "status": "pending"}, completed, {"id": "t1", "status": "pending"}, completed)
+    client = ViduClient(api_key="test", http_client=fake)
+    api = getattr(client, resource)
+    params = dict(model="vidu-q4-" + resource.replace("_", "-"), prompt="animate", duration_seconds=5, output_resolution="720p", audio=False, callback_url="https://x/callback", **fields)
+    assert api.create(**params).id == "t1"
+    assert fake.calls[0] == ("post", "/api/v1/vidu/" + resource, params)
+    assert api.get("t1").videos[0].url == "https://x/v.mp4"
+    assert fake.calls[1] == ("get", "/api/v1/vidu/" + resource + "/t1", None)
+    assert api.run(**params).videos[0].url == "https://x/v.mp4"