runapi-omnihuman 0.1.1__py3-none-any.whl

runapi/omnihuman/__init__.py

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

runapi/omnihuman/client.py

@@ -0,0 +1,33 @@
+"""OmniHuman client."""
+
+from __future__ import annotations
+
+from typing import Any, Optional
+
+from runapi.core import ClientOptions, HttpClient, resolve_api_key
+
+from .resources.audio_to_video import AudioToVideo
+from .resources.human_identification import HumanIdentification
+from .resources.subject_detection import SubjectDetection
+
+
+class OmnihumanClient:
+    """OmniHuman audio-to-video and helper endpoint client.
+
+    Example::
+
+        client = OmnihumanClient(api_key="sk-...")
+        result = client.audio_to_video.run(
+            model="omnihuman-1.5",
+            source_image_url="https://cdn.runapi.ai/public/samples/portrait.jpg",
+            source_audio_url="https://cdn.runapi.ai/public/samples/voice.mp3",
+        )
+    """
+
+    def __init__(self, api_key: Optional[str] = None, **options: Any) -> None:
+        resolved_api_key = resolve_api_key(api_key)
+        client_options = ClientOptions(api_key=resolved_api_key, **options)
+        http = client_options.http_client or HttpClient(client_options)
+        self.audio_to_video = AudioToVideo(http)
+        self.human_identification = HumanIdentification(http)
+        self.subject_detection = SubjectDetection(http)

runapi/omnihuman/contract_gen.py

@@ -0,0 +1,45 @@
+CONTRACT = {
+    "audio-to-video": {
+        "models": ["omnihuman-1.5"],
+        "fields_by_model": {
+            "omnihuman-1.5": {
+                "output_resolution": {
+                    "enum": ["720p", "1080p"]
+                },
+                "prompt": {
+                    "max": 1000,
+                    "length": True
+                },
+                "seed": {
+                    "type": "integer"
+                },
+                "source_audio_url": {
+                    "required": True
+                },
+                "source_image_url": {
+                    "required": True
+                }
+            }
+        }
+    },
+    "human-identification": {
+        "models": ["omnihuman-1.5-human-identification"],
+        "fields_by_model": {
+            "omnihuman-1.5-human-identification": {
+                "source_image_url": {
+                    "required": True
+                }
+            }
+        }
+    },
+    "subject-detection": {
+        "models": ["omnihuman-1.5-subject-detection"],
+        "fields_by_model": {
+            "omnihuman-1.5-subject-detection": {
+                "source_image_url": {
+                    "required": True
+                }
+            }
+        }
+    }
+}

runapi/omnihuman/resources/__init__.py

@@ -0,0 +1,8 @@
+from .audio_to_video import AudioToVideo
+
+__all__ = ["AudioToVideo"]
+from .audio_to_video import AudioToVideo
+from .human_identification import HumanIdentification
+from .subject_detection import SubjectDetection
+
+__all__ = ["AudioToVideo", "HumanIdentification", "SubjectDetection"]

runapi/omnihuman/resources/audio_to_video.py

@@ -0,0 +1,39 @@
+"""OmniHuman audio-to-video resource."""
+
+from __future__ import annotations
+
+from typing import Any, Dict, Optional
+
+from runapi.core import Resource, RequestOptions
+
+from ..contract_gen import CONTRACT
+from ..types import (
+    AudioToVideoResponse,
+    CompletedAudioToVideoResponse,
+)
+
+class AudioToVideo(Resource):
+    """Generate a talking-head video from a source image and audio track."""
+
+    ENDPOINT = "/api/v1/omnihuman/audio_to_video"
+
+    RESPONSE_CLASS = AudioToVideoResponse
+    COMPLETED_RESPONSE_CLASS = CompletedAudioToVideoResponse
+
+    def run(self, options: Optional[RequestOptions] = None, **params: Any) -> Any:
+        """Create a 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 audio-to-video task and return immediately with an ``id``."""
+        compacted = self._compact_params(params)
+        self._validate_params(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 audio-to-video task."""
+        return self._request("get", f"{self.ENDPOINT}/{id}", options=options)
+
+    def _validate_params(self, params: Dict[str, Any]) -> None:
+        self._validate_contract(CONTRACT["audio-to-video"], params)

runapi/omnihuman/resources/human_identification.py

@@ -0,0 +1,40 @@
+"""OmniHuman human-identification resource."""
+
+from __future__ import annotations
+
+from typing import Any, Dict, Optional
+
+from runapi.core import Resource, RequestOptions
+
+from ..contract_gen import CONTRACT
+from ..types import (
+    CompletedHumanIdentificationResponse,
+    HumanIdentificationResponse,
+)
+
+
+class HumanIdentification(Resource):
+    """Identify human regions in a source image."""
+
+    ENDPOINT = "/api/v1/omnihuman/human_identification"
+
+    RESPONSE_CLASS = HumanIdentificationResponse
+    COMPLETED_RESPONSE_CLASS = CompletedHumanIdentificationResponse
+
+    def run(self, options: Optional[RequestOptions] = None, **params: Any) -> Any:
+        """Create a 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 a human-identification task and return immediately with an ``id``."""
+        compacted = self._compact_params(params)
+        self._validate_params(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 a human-identification task."""
+        return self._request("get", f"{self.ENDPOINT}/{id}", options=options)
+
+    def _validate_params(self, params: Dict[str, Any]) -> None:
+        self._validate_contract(CONTRACT["human-identification"], params)

runapi/omnihuman/resources/subject_detection.py

@@ -0,0 +1,40 @@
+"""OmniHuman subject-detection resource."""
+
+from __future__ import annotations
+
+from typing import Any, Dict, Optional
+
+from runapi.core import Resource, RequestOptions
+
+from ..contract_gen import CONTRACT
+from ..types import (
+    CompletedSubjectDetectionResponse,
+    SubjectDetectionResponse,
+)
+
+
+class SubjectDetection(Resource):
+    """Detect subject masks in a source image."""
+
+    ENDPOINT = "/api/v1/omnihuman/subject_detection"
+
+    RESPONSE_CLASS = SubjectDetectionResponse
+    COMPLETED_RESPONSE_CLASS = CompletedSubjectDetectionResponse
+
+    def run(self, options: Optional[RequestOptions] = None, **params: Any) -> Any:
+        """Create a 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 a subject-detection task and return immediately with an ``id``."""
+        compacted = self._compact_params(params)
+        self._validate_params(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 a subject-detection task."""
+        return self._request("get", f"{self.ENDPOINT}/{id}", options=options)
+
+    def _validate_params(self, params: Dict[str, Any]) -> None:
+        self._validate_contract(CONTRACT["subject-detection"], params)

runapi/omnihuman/types.py

@@ -0,0 +1,61 @@
+"""OmniHuman response models."""
+
+from __future__ import annotations
+
+from runapi.core import BaseModel, TaskResponse, optional, required
+
+
+class Video(BaseModel):
+    url = optional(str)
+
+
+class Mask(BaseModel):
+    url = optional(str)
+
+
+class AudioToVideoResponse(TaskResponse):
+    """Response for an audio-to-video task."""
+
+    id = required(str)
+    status = optional(str, enum=lambda: TaskResponse.Status.ALL)
+    videos = optional([lambda: Video])
+    error = optional(str)
+
+
+class CompletedAudioToVideoResponse(AudioToVideoResponse):
+    """Returned by ``audio_to_video.run()`` once polling observes completion.
+
+    ``videos`` is required so callers never have to null-check it on success.
+    """
+
+    videos = required([lambda: Video])
+
+
+class HumanIdentificationResponse(TaskResponse):
+    """Response for a human-identification helper task."""
+
+    id = required(str)
+    status = optional(str, enum=lambda: TaskResponse.Status.ALL)
+    subject_status = optional(int)
+    error = optional(str)
+
+
+class CompletedHumanIdentificationResponse(HumanIdentificationResponse):
+    """Returned by ``human_identification.run()`` once polling observes completion."""
+
+    subject_status = required(int)
+
+
+class SubjectDetectionResponse(TaskResponse):
+    """Response for a subject-detection helper task."""
+
+    id = required(str)
+    status = optional(str, enum=lambda: TaskResponse.Status.ALL)
+    masks = optional([lambda: Mask])
+    error = optional(str)
+
+
+class CompletedSubjectDetectionResponse(SubjectDetectionResponse):
+    """Returned by ``subject_detection.run()`` once polling observes completion."""
+
+    masks = required([lambda: Mask])

runapi_omnihuman-0.1.1.dist-info/METADATA

@@ -0,0 +1,66 @@
+Metadata-Version: 2.4
+Name: runapi-omnihuman
+Version: 0.1.1
+Summary: RunAPI OmniHuman SDK for audio-to-video and image helper workflows in JavaScript, Python, Ruby, Go, Java, and PHP
+Project-URL: Homepage, https://runapi.ai/models/omnihuman
+Project-URL: Documentation, https://runapi.ai/docs#sdk-omnihuman
+Project-URL: Source, https://github.com/runapi-ai/omnihuman-sdk
+Project-URL: Issues, https://github.com/runapi-ai/omnihuman-sdk/issues
+Author-email: RunAPI <contact@runapi.ai>
+License-Expression: Apache-2.0
+Keywords: api,audio-to-video,golang,gradle,java,maven,omnihuman,omnihuman-api,python,ruby,runapi,runapi-ai,sdk,typescript,video-api,video-generation
+Requires-Python: >=3.9
+Requires-Dist: runapi-core>=0.1.4
+Description-Content-Type: text/markdown
+
+# OmniHuman Python SDK for RunAPI
+
+The OmniHuman Python SDK is the language-specific package for OmniHuman on RunAPI. Use this package for audio-driven talking-head video generation, human identification, and subject-mask detection when your application needs request bodies, task status lookup, and consistent RunAPI errors in Python.
+
+This README is the Python package guide inside the public `omnihuman-sdk` repository. For the repository overview, start at `../README.md`; for model details, use https://runapi.ai/models/omnihuman; for API reference, use https://runapi.ai/docs#omnihuman; for SDK docs, use https://runapi.ai/docs#sdk-omnihuman.
+
+## Install
+
+```bash
+pip install runapi-omnihuman
+```
+
+## Quick start
+
+```python
+from runapi.omnihuman import OmnihumanClient
+
+client = OmnihumanClient()  # reads RUNAPI_API_KEY, or pass api_key="sk-..."
+
+task = client.audio_to_video.create(
+    model="omnihuman-1.5",
+    source_image_url="https://cdn.runapi.ai/public/samples/portrait.jpg",
+    source_audio_url="https://cdn.runapi.ai/public/samples/voice.mp3",
+    output_resolution="720p",
+)
+status = client.audio_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 videos, masks, or other files in your own durable storage within 7 days; do not treat returned URLs as long-term assets.
+
+## Language notes
+
+Pass parameters as keyword arguments and catch the `runapi.omnihuman` error classes when building video jobs or scripts. The available resources are `audio_to_video`, `human_identification`, and `subject_detection`. 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/omnihuman
+- SDK docs: https://runapi.ai/docs#sdk-omnihuman
+- Product docs: https://runapi.ai/docs#omnihuman
+- Pricing and rate limits: https://runapi.ai/models/omnihuman/1.5
+- Human identification: https://runapi.ai/models/omnihuman/1.5-human-identification
+- Subject detection: https://runapi.ai/models/omnihuman/1.5-subject-detection
+- Provider comparison: https://runapi.ai/providers/bytedance
+- Full catalog: https://runapi.ai/models
+- Repository: https://github.com/runapi-ai/omnihuman-sdk
+
+## License
+
+Licensed under the Apache License, Version 2.0.

runapi_omnihuman-0.1.1.dist-info/RECORD

@@ -0,0 +1,12 @@
+runapi/omnihuman/__init__.py,sha256=NGa5t_9KSQT89Bi8hKX482Ojq5wyjfQmOPVuDLshQKg,469
+runapi/omnihuman/client.py,sha256=ZYcG43knz61uXfzBYRO4NGVwOdhsM52RBL22VIBqMgg,1193
+runapi/omnihuman/contract_gen.py,sha256=PVa5LfWEgnMAv-dlyBwBM0a-O87lhLx8uP0WwCgQQWI,1232
+runapi/omnihuman/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+runapi/omnihuman/types.py,sha256=5eEZvis0WRfEvojBi8fg7LxDg_sgbQiteXYw_dGqfdQ,1653
+runapi/omnihuman/resources/__init__.py,sha256=nPt_lgsDsYZoZvY0x3MdmfmD2D9Ktxdy45kn3vOcbvc,283
+runapi/omnihuman/resources/audio_to_video.py,sha256=oCBE7mgnh2WhVyrRJkSx1y-YerPOyIQ5fWj53l2o_HI,1532
+runapi/omnihuman/resources/human_identification.py,sha256=5Fc3937ySny63JcGIRNzhy8YA_hgjcAPl1qbPFehogk,1571
+runapi/omnihuman/resources/subject_detection.py,sha256=tn13oG8hd42LUzZR8ArCf7WObDWnIPgwNUQAp1LoIgI,1539
+runapi_omnihuman-0.1.1.dist-info/METADATA,sha256=GHp3wfflDRdC6w7ebwybCwduhNCq5wglUJgWFpHgnQE,3326
+runapi_omnihuman-0.1.1.dist-info/WHEEL,sha256=lCkmxWfQsSc9CfIClYeavTdQeEX2toPqufh9gI35EQA,87
+runapi_omnihuman-0.1.1.dist-info/RECORD,,

runapi_omnihuman-0.1.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.31.0
+Root-Is-Purelib: true
+Tag: py3-none-any