magic_hour 0.15.0__tar.gz → 0.16.1__tar.gz

{magic_hour-0.15.0 → magic_hour-0.16.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: magic_hour
-Version: 0.15.0
+Version: 0.16.1
 Summary: Python SDK for Magic Hour API
 Requires-Python: >=3.8,<4.0
 Classifier: Programming Language :: Python :: 3
@@ -63,6 +63,10 @@ client = AsyncClient(token="my api key")
 
 * [create](magic_hour/resources/v1/ai_clothes_changer/README.md#create) - AI Clothes Changer
 
+### [v1.ai_face_editor](magic_hour/resources/v1/ai_face_editor/README.md)
+
+* [create](magic_hour/resources/v1/ai_face_editor/README.md#create) - AI Face Editor
+
 ### [v1.ai_headshot_generator](magic_hour/resources/v1/ai_headshot_generator/README.md)
 
 * [create](magic_hour/resources/v1/ai_headshot_generator/README.md#create) - AI Headshots

{magic_hour-0.15.0 → magic_hour-0.16.1}/README.md

@@ -45,6 +45,10 @@ client = AsyncClient(token="my api key")
 
 * [create](magic_hour/resources/v1/ai_clothes_changer/README.md#create) - AI Clothes Changer
 
+### [v1.ai_face_editor](magic_hour/resources/v1/ai_face_editor/README.md)
+
+* [create](magic_hour/resources/v1/ai_face_editor/README.md#create) - AI Face Editor
+
 ### [v1.ai_headshot_generator](magic_hour/resources/v1/ai_headshot_generator/README.md)
 
 * [create](magic_hour/resources/v1/ai_headshot_generator/README.md#create) - AI Headshots

{magic_hour-0.15.0 → magic_hour-0.16.1}/magic_hour/environment.py

@@ -5,4 +5,4 @@ class Environment(enum.Enum):
     """Pre-defined base URLs for the API"""
 
     ENVIRONMENT = "https://api.magichour.ai"
-    MOCK_SERVER = "https://api.sideko.dev/v1/mock/magichour/magic-hour/0.15.0"
+    MOCK_SERVER = "https://api.sideko.dev/v1/mock/magichour/magic-hour/0.16.1"

magic_hour-0.16.1/magic_hour/resources/v1/ai_face_editor/README.md

@@ -0,0 +1,67 @@
+
+### create <a name="create"></a>
+AI Face Editor
+
+Edit facial features of an image using AI. Each edit costs 1 frame. The height/width of the output image depends on your subscription. Please refer to our [pricing](/pricing) page for more details
+
+**API Endpoint**: `POST /v1/ai-face-editor`
+
+#### Synchronous Client
+
+```python
+from magic_hour import Client
+from os import getenv
+
+client = Client(token=getenv("API_TOKEN"))
+res = client.v1.ai_face_editor.create(
+    assets={"image_file_path": "api-assets/id/1234.png"},
+    style={
+        "enhance_face": False,
+        "eye_gaze_horizontal": 0.0,
+        "eye_gaze_vertical": 0.0,
+        "eye_open_ratio": 0.0,
+        "eyebrow_direction": 0.0,
+        "head_pitch": 0.0,
+        "head_roll": 0.0,
+        "head_yaw": 0.0,
+        "lip_open_ratio": 0.0,
+        "mouth_grim": 0.0,
+        "mouth_position_horizontal": 0.0,
+        "mouth_position_vertical": 0.0,
+        "mouth_pout": 0.0,
+        "mouth_purse": 0.0,
+        "mouth_smile": 0.0,
+    },
+    name="Face Editor image",
+)
+```
+
+#### Asynchronous Client
+
+```python
+from magic_hour import AsyncClient
+from os import getenv
+
+client = AsyncClient(token=getenv("API_TOKEN"))
+res = await client.v1.ai_face_editor.create(
+    assets={"image_file_path": "api-assets/id/1234.png"},
+    style={
+        "enhance_face": False,
+        "eye_gaze_horizontal": 0.0,
+        "eye_gaze_vertical": 0.0,
+        "eye_open_ratio": 0.0,
+        "eyebrow_direction": 0.0,
+        "head_pitch": 0.0,
+        "head_roll": 0.0,
+        "head_yaw": 0.0,
+        "lip_open_ratio": 0.0,
+        "mouth_grim": 0.0,
+        "mouth_position_horizontal": 0.0,
+        "mouth_position_vertical": 0.0,
+        "mouth_pout": 0.0,
+        "mouth_purse": 0.0,
+        "mouth_smile": 0.0,
+    },
+    name="Face Editor image",
+)
+```

magic_hour-0.16.1/magic_hour/resources/v1/ai_face_editor/__init__.py

@@ -0,0 +1,4 @@
+from .client import AiFaceEditorClient, AsyncAiFaceEditorClient
+
+
+__all__ = ["AiFaceEditorClient", "AsyncAiFaceEditorClient"]

magic_hour-0.16.1/magic_hour/resources/v1/ai_face_editor/client.py

@@ -0,0 +1,157 @@
+import typing
+
+from magic_hour.core import (
+    AsyncBaseClient,
+    RequestOptions,
+    SyncBaseClient,
+    default_request_options,
+    to_encodable,
+    type_utils,
+)
+from magic_hour.types import models, params
+
+
+class AiFaceEditorClient:
+    def __init__(self, *, base_client: SyncBaseClient):
+        self._base_client = base_client
+
+    def create(
+        self,
+        *,
+        assets: params.V1AiFaceEditorCreateBodyAssets,
+        style: params.V1AiFaceEditorCreateBodyStyle,
+        name: typing.Union[
+            typing.Optional[str], type_utils.NotGiven
+        ] = type_utils.NOT_GIVEN,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> models.V1AiFaceEditorCreateResponse:
+        """
+        AI Face Editor
+
+        Edit facial features of an image using AI. Each edit costs 1 frame. The height/width of the output image depends on your subscription. Please refer to our [pricing](/pricing) page for more details
+
+        POST /v1/ai-face-editor
+
+        Args:
+            name: The name of image
+            assets: Provide the assets for face editor
+            style: Face editing parameters
+            request_options: Additional options to customize the HTTP request
+
+        Returns:
+            Success
+
+        Raises:
+            ApiError: A custom exception class that provides additional context
+                for API errors, including the HTTP status code and response body.
+
+        Examples:
+        ```py
+        client.v1.ai_face_editor.create(
+            assets={"image_file_path": "api-assets/id/1234.png"},
+            style={
+                "enhance_face": False,
+                "eye_gaze_horizontal": 0.0,
+                "eye_gaze_vertical": 0.0,
+                "eye_open_ratio": 0.0,
+                "eyebrow_direction": 0.0,
+                "head_pitch": 0.0,
+                "head_roll": 0.0,
+                "head_yaw": 0.0,
+                "lip_open_ratio": 0.0,
+                "mouth_grim": 0.0,
+                "mouth_position_horizontal": 0.0,
+                "mouth_position_vertical": 0.0,
+                "mouth_pout": 0.0,
+                "mouth_purse": 0.0,
+                "mouth_smile": 0.0,
+            },
+            name="Face Editor image",
+        )
+        ```
+        """
+        _json = to_encodable(
+            item={"name": name, "assets": assets, "style": style},
+            dump_with=params._SerializerV1AiFaceEditorCreateBody,
+        )
+        return self._base_client.request(
+            method="POST",
+            path="/v1/ai-face-editor",
+            auth_names=["bearerAuth"],
+            json=_json,
+            cast_to=models.V1AiFaceEditorCreateResponse,
+            request_options=request_options or default_request_options(),
+        )
+
+
+class AsyncAiFaceEditorClient:
+    def __init__(self, *, base_client: AsyncBaseClient):
+        self._base_client = base_client
+
+    async def create(
+        self,
+        *,
+        assets: params.V1AiFaceEditorCreateBodyAssets,
+        style: params.V1AiFaceEditorCreateBodyStyle,
+        name: typing.Union[
+            typing.Optional[str], type_utils.NotGiven
+        ] = type_utils.NOT_GIVEN,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> models.V1AiFaceEditorCreateResponse:
+        """
+        AI Face Editor
+
+        Edit facial features of an image using AI. Each edit costs 1 frame. The height/width of the output image depends on your subscription. Please refer to our [pricing](/pricing) page for more details
+
+        POST /v1/ai-face-editor
+
+        Args:
+            name: The name of image
+            assets: Provide the assets for face editor
+            style: Face editing parameters
+            request_options: Additional options to customize the HTTP request
+
+        Returns:
+            Success
+
+        Raises:
+            ApiError: A custom exception class that provides additional context
+                for API errors, including the HTTP status code and response body.
+
+        Examples:
+        ```py
+        await client.v1.ai_face_editor.create(
+            assets={"image_file_path": "api-assets/id/1234.png"},
+            style={
+                "enhance_face": False,
+                "eye_gaze_horizontal": 0.0,
+                "eye_gaze_vertical": 0.0,
+                "eye_open_ratio": 0.0,
+                "eyebrow_direction": 0.0,
+                "head_pitch": 0.0,
+                "head_roll": 0.0,
+                "head_yaw": 0.0,
+                "lip_open_ratio": 0.0,
+                "mouth_grim": 0.0,
+                "mouth_position_horizontal": 0.0,
+                "mouth_position_vertical": 0.0,
+                "mouth_pout": 0.0,
+                "mouth_purse": 0.0,
+                "mouth_smile": 0.0,
+            },
+            name="Face Editor image",
+        )
+        ```
+        """
+        _json = to_encodable(
+            item={"name": name, "assets": assets, "style": style},
+            dump_with=params._SerializerV1AiFaceEditorCreateBody,
+        )
+        return await self._base_client.request(
+            method="POST",
+            path="/v1/ai-face-editor",
+            auth_names=["bearerAuth"],
+            json=_json,
+            cast_to=models.V1AiFaceEditorCreateResponse,
+            request_options=request_options or default_request_options(),
+        )

{magic_hour-0.15.0 → magic_hour-0.16.1}/magic_hour/resources/v1/client.py

@@ -3,6 +3,10 @@ from magic_hour.resources.v1.ai_clothes_changer import (
     AiClothesChangerClient,
     AsyncAiClothesChangerClient,
 )
+from magic_hour.resources.v1.ai_face_editor import (
+    AiFaceEditorClient,
+    AsyncAiFaceEditorClient,
+)
 from magic_hour.resources.v1.ai_headshot_generator import (
     AiHeadshotGeneratorClient,
     AsyncAiHeadshotGeneratorClient,
@@ -71,6 +75,7 @@ class V1Client:
         self.image_projects = ImageProjectsClient(base_client=self._base_client)
         self.video_projects = VideoProjectsClient(base_client=self._base_client)
         self.ai_clothes_changer = AiClothesChangerClient(base_client=self._base_client)
+        self.ai_face_editor = AiFaceEditorClient(base_client=self._base_client)
         self.ai_headshot_generator = AiHeadshotGeneratorClient(
             base_client=self._base_client
         )
@@ -103,6 +108,7 @@ class AsyncV1Client:
         self.ai_clothes_changer = AsyncAiClothesChangerClient(
             base_client=self._base_client
         )
+        self.ai_face_editor = AsyncAiFaceEditorClient(base_client=self._base_client)
         self.ai_headshot_generator = AsyncAiHeadshotGeneratorClient(
             base_client=self._base_client
         )

{magic_hour-0.15.0 → magic_hour-0.16.1}/magic_hour/resources/v1/lip_sync/client.py

@@ -20,15 +20,19 @@ class LipSyncClient:
         *,
         assets: params.V1LipSyncCreateBodyAssets,
         end_seconds: float,
-        height: int,
         start_seconds: float,
-        width: int,
+        height: typing.Union[
+            typing.Optional[int], type_utils.NotGiven
+        ] = type_utils.NOT_GIVEN,
         max_fps_limit: typing.Union[
             typing.Optional[float], type_utils.NotGiven
         ] = type_utils.NOT_GIVEN,
         name: typing.Union[
             typing.Optional[str], type_utils.NotGiven
         ] = type_utils.NOT_GIVEN,
+        width: typing.Union[
+            typing.Optional[int], type_utils.NotGiven
+        ] = type_utils.NOT_GIVEN,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> models.V1LipSyncCreateResponse:
         """
@@ -42,13 +46,27 @@ class LipSyncClient:
         POST /v1/lip-sync
 
         Args:
+            height: Used to determine the dimensions of the output video.
+
+        * If height is provided, width will also be required. The larger value between width and height will be used to determine the maximum output resolution while maintaining the original aspect ratio.
+        * If both height and width are omitted, the video will be resized according to your subscription's maximum resolution, while preserving aspect ratio.
+
+        Note: if the video's original resolution is less than the maximum, the video will not be resized.
+
+        See our [pricing page](https://magichour.ai/pricing) for more details.
             max_fps_limit: Defines the maximum FPS (frames per second) for the output video. If the input video's FPS is lower than this limit, the output video will retain the input FPS. This is useful for reducing unnecessary frame usage in scenarios where high FPS is not required.
             name: The name of video
+            width: Used to determine the dimensions of the output video.
+
+        * If width is provided, height will also be required. The larger value between width and height will be used to determine the maximum output resolution while maintaining the original aspect ratio.
+        * If both height and width are omitted, the video will be resized according to your subscription's maximum resolution, while preserving aspect ratio.
+
+        Note: if the video's original resolution is less than the maximum, the video will not be resized.
+
+        See our [pricing page](https://magichour.ai/pricing) for more details.
             assets: Provide the assets for lip-sync. For video, The `video_source` field determines whether `video_file_path` or `youtube_url` field is used
             end_seconds: The end time of the input video in seconds
-            height: The height of the final output video. The maximum height depends on your subscription. Please refer to our [pricing page](https://magichour.ai/pricing) for more details
             start_seconds: The start time of the input video in seconds
-            width: The width of the final output video. The maximum width depends on your subscription. Please refer to our [pricing page](https://magichour.ai/pricing) for more details
             request_options: Additional options to customize the HTTP request
 
         Returns:
@@ -67,23 +85,23 @@ class LipSyncClient:
                 "video_source": "file",
             },
             end_seconds=15.0,
-            height=960,
             start_seconds=0.0,
-            width=512,
+            height=960,
             max_fps_limit=12.0,
             name="Lip Sync video",
+            width=512,
         )
         ```
         """
         _json = to_encodable(
             item={
+                "height": height,
                 "max_fps_limit": max_fps_limit,
                 "name": name,
+                "width": width,
                 "assets": assets,
                 "end_seconds": end_seconds,
-                "height": height,
                 "start_seconds": start_seconds,
-                "width": width,
             },
             dump_with=params._SerializerV1LipSyncCreateBody,
         )
@@ -106,15 +124,19 @@ class AsyncLipSyncClient:
         *,
         assets: params.V1LipSyncCreateBodyAssets,
         end_seconds: float,
-        height: int,
         start_seconds: float,
-        width: int,
+        height: typing.Union[
+            typing.Optional[int], type_utils.NotGiven
+        ] = type_utils.NOT_GIVEN,
         max_fps_limit: typing.Union[
             typing.Optional[float], type_utils.NotGiven
         ] = type_utils.NOT_GIVEN,
         name: typing.Union[
             typing.Optional[str], type_utils.NotGiven
         ] = type_utils.NOT_GIVEN,
+        width: typing.Union[
+            typing.Optional[int], type_utils.NotGiven
+        ] = type_utils.NOT_GIVEN,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> models.V1LipSyncCreateResponse:
         """
@@ -128,13 +150,27 @@ class AsyncLipSyncClient:
         POST /v1/lip-sync
 
         Args:
+            height: Used to determine the dimensions of the output video.
+
+        * If height is provided, width will also be required. The larger value between width and height will be used to determine the maximum output resolution while maintaining the original aspect ratio.
+        * If both height and width are omitted, the video will be resized according to your subscription's maximum resolution, while preserving aspect ratio.
+
+        Note: if the video's original resolution is less than the maximum, the video will not be resized.
+
+        See our [pricing page](https://magichour.ai/pricing) for more details.
             max_fps_limit: Defines the maximum FPS (frames per second) for the output video. If the input video's FPS is lower than this limit, the output video will retain the input FPS. This is useful for reducing unnecessary frame usage in scenarios where high FPS is not required.
             name: The name of video
+            width: Used to determine the dimensions of the output video.
+
+        * If width is provided, height will also be required. The larger value between width and height will be used to determine the maximum output resolution while maintaining the original aspect ratio.
+        * If both height and width are omitted, the video will be resized according to your subscription's maximum resolution, while preserving aspect ratio.
+
+        Note: if the video's original resolution is less than the maximum, the video will not be resized.
+
+        See our [pricing page](https://magichour.ai/pricing) for more details.
             assets: Provide the assets for lip-sync. For video, The `video_source` field determines whether `video_file_path` or `youtube_url` field is used
             end_seconds: The end time of the input video in seconds
-            height: The height of the final output video. The maximum height depends on your subscription. Please refer to our [pricing page](https://magichour.ai/pricing) for more details
             start_seconds: The start time of the input video in seconds
-            width: The width of the final output video. The maximum width depends on your subscription. Please refer to our [pricing page](https://magichour.ai/pricing) for more details
             request_options: Additional options to customize the HTTP request
 
         Returns:
@@ -153,23 +189,23 @@ class AsyncLipSyncClient:
                 "video_source": "file",
             },
             end_seconds=15.0,
-            height=960,
             start_seconds=0.0,
-            width=512,
+            height=960,
             max_fps_limit=12.0,
             name="Lip Sync video",
+            width=512,
         )
         ```
         """
         _json = to_encodable(
             item={
+                "height": height,
                 "max_fps_limit": max_fps_limit,
                 "name": name,
+                "width": width,
                 "assets": assets,
                 "end_seconds": end_seconds,
-                "height": height,
                 "start_seconds": start_seconds,
-                "width": width,
             },
             dump_with=params._SerializerV1LipSyncCreateBody,
         )

{magic_hour-0.15.0 → magic_hour-0.16.1}/magic_hour/types/models/__init__.py

@@ -1,4 +1,5 @@
 from .v1_ai_clothes_changer_create_response import V1AiClothesChangerCreateResponse
+from .v1_ai_face_editor_create_response import V1AiFaceEditorCreateResponse
 from .v1_ai_headshot_generator_create_response import (
     V1AiHeadshotGeneratorCreateResponse,
 )
@@ -37,6 +38,7 @@ from .v1_video_to_video_create_response import V1VideoToVideoCreateResponse
 
 __all__ = [
     "V1AiClothesChangerCreateResponse",
+    "V1AiFaceEditorCreateResponse",
     "V1AiHeadshotGeneratorCreateResponse",
     "V1AiImageGeneratorCreateResponse",
     "V1AiImageUpscalerCreateResponse",

magic_hour-0.16.1/magic_hour/types/models/v1_ai_face_editor_create_response.py

@@ -0,0 +1,25 @@
+import pydantic
+
+
+class V1AiFaceEditorCreateResponse(pydantic.BaseModel):
+    """
+    Success
+    """
+
+    model_config = pydantic.ConfigDict(
+        arbitrary_types_allowed=True,
+        populate_by_name=True,
+    )
+
+    frame_cost: int = pydantic.Field(
+        alias="frame_cost",
+    )
+    """
+    The frame cost of the image generation
+    """
+    id: str = pydantic.Field(
+        alias="id",
+    )
+    """
+    Unique ID of the image. This value can be used in the [get image project API](https://docs.magichour.ai/api-reference/image-projects/get-image-details) to fetch additional details such as status
+    """

{magic_hour-0.15.0 → magic_hour-0.16.1}/magic_hour/types/params/__init__.py

@@ -6,6 +6,18 @@ from .v1_ai_clothes_changer_create_body_assets import (
     V1AiClothesChangerCreateBodyAssets,
     _SerializerV1AiClothesChangerCreateBodyAssets,
 )
+from .v1_ai_face_editor_create_body import (
+    V1AiFaceEditorCreateBody,
+    _SerializerV1AiFaceEditorCreateBody,
+)
+from .v1_ai_face_editor_create_body_assets import (
+    V1AiFaceEditorCreateBodyAssets,
+    _SerializerV1AiFaceEditorCreateBodyAssets,
+)
+from .v1_ai_face_editor_create_body_style import (
+    V1AiFaceEditorCreateBodyStyle,
+    _SerializerV1AiFaceEditorCreateBodyStyle,
+)
 from .v1_ai_headshot_generator_create_body import (
     V1AiHeadshotGeneratorCreateBody,
     _SerializerV1AiHeadshotGeneratorCreateBody,
@@ -160,6 +172,9 @@ from .v1_video_to_video_create_body_style import (
 __all__ = [
     "V1AiClothesChangerCreateBody",
     "V1AiClothesChangerCreateBodyAssets",
+    "V1AiFaceEditorCreateBody",
+    "V1AiFaceEditorCreateBodyAssets",
+    "V1AiFaceEditorCreateBodyStyle",
     "V1AiHeadshotGeneratorCreateBody",
     "V1AiHeadshotGeneratorCreateBodyAssets",
     "V1AiHeadshotGeneratorCreateBodyStyle",
@@ -200,6 +215,9 @@ __all__ = [
     "V1VideoToVideoCreateBodyStyle",
     "_SerializerV1AiClothesChangerCreateBody",
     "_SerializerV1AiClothesChangerCreateBodyAssets",
+    "_SerializerV1AiFaceEditorCreateBody",
+    "_SerializerV1AiFaceEditorCreateBodyAssets",
+    "_SerializerV1AiFaceEditorCreateBodyStyle",
     "_SerializerV1AiHeadshotGeneratorCreateBody",
     "_SerializerV1AiHeadshotGeneratorCreateBodyAssets",
     "_SerializerV1AiHeadshotGeneratorCreateBodyStyle",

magic_hour-0.16.1/magic_hour/types/params/v1_ai_face_editor_create_body.py

@@ -0,0 +1,52 @@
+import pydantic
+import typing
+import typing_extensions
+
+from .v1_ai_face_editor_create_body_assets import (
+    V1AiFaceEditorCreateBodyAssets,
+    _SerializerV1AiFaceEditorCreateBodyAssets,
+)
+from .v1_ai_face_editor_create_body_style import (
+    V1AiFaceEditorCreateBodyStyle,
+    _SerializerV1AiFaceEditorCreateBodyStyle,
+)
+
+
+class V1AiFaceEditorCreateBody(typing_extensions.TypedDict):
+    """
+    V1AiFaceEditorCreateBody
+    """
+
+    assets: typing_extensions.Required[V1AiFaceEditorCreateBodyAssets]
+    """
+    Provide the assets for face editor
+    """
+
+    name: typing_extensions.NotRequired[str]
+    """
+    The name of image
+    """
+
+    style: typing_extensions.Required[V1AiFaceEditorCreateBodyStyle]
+    """
+    Face editing parameters
+    """
+
+
+class _SerializerV1AiFaceEditorCreateBody(pydantic.BaseModel):
+    """
+    Serializer for V1AiFaceEditorCreateBody handling case conversions
+    and file omissions as dictated by the API
+    """
+
+    model_config = pydantic.ConfigDict(
+        populate_by_name=True,
+    )
+
+    assets: _SerializerV1AiFaceEditorCreateBodyAssets = pydantic.Field(
+        alias="assets",
+    )
+    name: typing.Optional[str] = pydantic.Field(alias="name", default=None)
+    style: _SerializerV1AiFaceEditorCreateBodyStyle = pydantic.Field(
+        alias="style",
+    )

magic_hour-0.16.1/magic_hour/types/params/v1_ai_face_editor_create_body_assets.py

@@ -0,0 +1,28 @@
+import pydantic
+import typing_extensions
+
+
+class V1AiFaceEditorCreateBodyAssets(typing_extensions.TypedDict):
+    """
+    Provide the assets for face editor
+    """
+
+    image_file_path: typing_extensions.Required[str]
+    """
+    This is the image whose face will be edited. This value can be either the `file_path` field from the response of the [upload urls API](https://docs.magichour.ai/api-reference/files/generate-asset-upload-urls), or the url of the file.
+    """
+
+
+class _SerializerV1AiFaceEditorCreateBodyAssets(pydantic.BaseModel):
+    """
+    Serializer for V1AiFaceEditorCreateBodyAssets handling case conversions
+    and file omissions as dictated by the API
+    """
+
+    model_config = pydantic.ConfigDict(
+        populate_by_name=True,
+    )
+
+    image_file_path: str = pydantic.Field(
+        alias="image_file_path",
+    )