magic_hour 0.13.0__tar.gz → 0.15.0__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: magic_hour
-Version: 0.13.0
+Version: 0.15.0
 Summary: Python SDK for Magic Hour API
 Requires-Python: >=3.8,<4.0
 Classifier: Programming Language :: Python :: 3

{magic_hour-0.13.0 → magic_hour-0.15.0}/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.13.0"
+    MOCK_SERVER = "https://api.sideko.dev/v1/mock/magichour/magic-hour/0.15.0"

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

@@ -20,12 +20,16 @@ class FaceSwapClient:
         *,
         assets: params.V1FaceSwapCreateBodyAssets,
         end_seconds: float,
-        height: int,
         start_seconds: float,
-        width: int,
+        height: typing.Union[
+            typing.Optional[int], 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.V1FaceSwapCreateResponse:
         """
@@ -39,12 +43,26 @@ class FaceSwapClient:
         POST /v1/face-swap
 
         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.
             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 face swap. 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:
@@ -63,21 +81,21 @@ class FaceSwapClient:
                 "video_source": "file",
             },
             end_seconds=15.0,
-            height=960,
             start_seconds=0.0,
-            width=512,
+            height=960,
             name="Face Swap video",
+            width=512,
         )
         ```
         """
         _json = to_encodable(
             item={
+                "height": height,
                 "name": name,
+                "width": width,
                 "assets": assets,
                 "end_seconds": end_seconds,
-                "height": height,
                 "start_seconds": start_seconds,
-                "width": width,
             },
             dump_with=params._SerializerV1FaceSwapCreateBody,
         )
@@ -100,12 +118,16 @@ class AsyncFaceSwapClient:
         *,
         assets: params.V1FaceSwapCreateBodyAssets,
         end_seconds: float,
-        height: int,
         start_seconds: float,
-        width: int,
+        height: typing.Union[
+            typing.Optional[int], 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.V1FaceSwapCreateResponse:
         """
@@ -119,12 +141,26 @@ class AsyncFaceSwapClient:
         POST /v1/face-swap
 
         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.
             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 face swap. 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:
@@ -143,21 +179,21 @@ class AsyncFaceSwapClient:
                 "video_source": "file",
             },
             end_seconds=15.0,
-            height=960,
             start_seconds=0.0,
-            width=512,
+            height=960,
             name="Face Swap video",
+            width=512,
         )
         ```
         """
         _json = to_encodable(
             item={
+                "height": height,
                 "name": name,
+                "width": width,
                 "assets": assets,
                 "end_seconds": end_seconds,
-                "height": height,
                 "start_seconds": start_seconds,
-                "width": width,
             },
             dump_with=params._SerializerV1FaceSwapCreateBody,
         )

{magic_hour-0.13.0 → magic_hour-0.15.0}/magic_hour/resources/v1/image_to_video/README.md

@@ -20,7 +20,7 @@ res = client.v1.image_to_video.create(
     assets={"image_file_path": "api-assets/id/1234.png"},
     end_seconds=5.0,
     height=960,
-    style={"prompt": "string"},
+    style={"prompt": "a dog running"},
     width=512,
     name="Image To Video video",
 )
@@ -37,7 +37,7 @@ res = await client.v1.image_to_video.create(
     assets={"image_file_path": "api-assets/id/1234.png"},
     end_seconds=5.0,
     height=960,
-    style={"prompt": "string"},
+    style={"prompt": "a dog running"},
     width=512,
     name="Image To Video video",
 )

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

@@ -43,7 +43,7 @@ class ImageToVideoClient:
             assets: Provide the assets for image-to-video.
             end_seconds: The total duration of the output video in seconds.
             height: The height of the input video. This value will help determine the final orientation of the output video. The output video resolution may not match the input.
-            style: V1ImageToVideoCreateBodyStyle
+            style: Attributed used to dictate the style of the output
             width: The width of the input video. This value will help determine the final orientation of the output video. The output video resolution may not match the input.
             request_options: Additional options to customize the HTTP request
 
@@ -60,7 +60,7 @@ class ImageToVideoClient:
             assets={"image_file_path": "api-assets/id/1234.png"},
             end_seconds=5.0,
             height=960,
-            style={"prompt": "string"},
+            style={"prompt": "a dog running"},
             width=512,
             name="Image To Video video",
         )
@@ -119,7 +119,7 @@ class AsyncImageToVideoClient:
             assets: Provide the assets for image-to-video.
             end_seconds: The total duration of the output video in seconds.
             height: The height of the input video. This value will help determine the final orientation of the output video. The output video resolution may not match the input.
-            style: V1ImageToVideoCreateBodyStyle
+            style: Attributed used to dictate the style of the output
             width: The width of the input video. This value will help determine the final orientation of the output video. The output video resolution may not match the input.
             request_options: Additional options to customize the HTTP request
 
@@ -136,7 +136,7 @@ class AsyncImageToVideoClient:
             assets={"image_file_path": "api-assets/id/1234.png"},
             end_seconds=5.0,
             height=960,
-            style={"prompt": "string"},
+            style={"prompt": "a dog running"},
             width=512,
             name="Image To Video video",
         )

{magic_hour-0.13.0 → magic_hour-0.15.0}/magic_hour/resources/v1/text_to_video/README.md

@@ -19,7 +19,7 @@ client = Client(token=getenv("API_TOKEN"))
 res = client.v1.text_to_video.create(
     end_seconds=5.0,
     orientation="landscape",
-    style={"prompt": "string"},
+    style={"prompt": "a dog running"},
     name="Text To Video video",
 )
 ```
@@ -34,7 +34,7 @@ client = AsyncClient(token=getenv("API_TOKEN"))
 res = await client.v1.text_to_video.create(
     end_seconds=5.0,
     orientation="landscape",
-    style={"prompt": "string"},
+    style={"prompt": "a dog running"},
     name="Text To Video video",
 )
 ```

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

@@ -56,7 +56,7 @@ class TextToVideoClient:
         client.v1.text_to_video.create(
             end_seconds=5.0,
             orientation="landscape",
-            style={"prompt": "string"},
+            style={"prompt": "a dog running"},
             name="Text To Video video",
         )
         ```
@@ -124,7 +124,7 @@ class AsyncTextToVideoClient:
         await client.v1.text_to_video.create(
             end_seconds=5.0,
             orientation="landscape",
-            style={"prompt": "string"},
+            style={"prompt": "a dog running"},
             name="Text To Video video",
         )
         ```

{magic_hour-0.13.0 → magic_hour-0.15.0}/magic_hour/types/models/v1_image_projects_get_response.py

@@ -72,5 +72,5 @@ class V1ImageProjectsGetResponse(pydantic.BaseModel):
         alias="type",
     )
     """
-    The type of the image project. Possible values are AI_HEADSHOT, AI_IMAGE, IMAGE_UPSCALER, FACE_SWAP, PHOTO_EDITOR, QR_CODE, BACKGROUND_REMOVER, CLOTHES_CHANGER, AI_MEME, FACE_EDITOR
+    The type of the image project. Possible values are AI_HEADSHOT, AI_IMAGE, IMAGE_UPSCALER, FACE_SWAP, PHOTO_EDITOR, QR_CODE, BACKGROUND_REMOVER, CLOTHES_CHANGER, AI_MEME, FACE_EDITOR, PHOTO_COLORIZER
     """

magic_hour-0.15.0/magic_hour/types/params/v1_face_swap_create_body.py

@@ -0,0 +1,82 @@
+import pydantic
+import typing
+import typing_extensions
+
+from .v1_face_swap_create_body_assets import (
+    V1FaceSwapCreateBodyAssets,
+    _SerializerV1FaceSwapCreateBodyAssets,
+)
+
+
+class V1FaceSwapCreateBody(typing_extensions.TypedDict):
+    """
+    V1FaceSwapCreateBody
+    """
+
+    assets: typing_extensions.Required[V1FaceSwapCreateBodyAssets]
+    """
+    Provide the assets for face swap. For video, The `video_source` field determines whether `video_file_path` or `youtube_url` field is used
+    """
+
+    end_seconds: typing_extensions.Required[float]
+    """
+    The end time of the input video in seconds
+    """
+
+    height: typing_extensions.NotRequired[int]
+    """
+    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.
+    """
+
+    name: typing_extensions.NotRequired[str]
+    """
+    The name of video
+    """
+
+    start_seconds: typing_extensions.Required[float]
+    """
+    The start time of the input video in seconds
+    """
+
+    width: typing_extensions.NotRequired[int]
+    """
+    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.
+    """
+
+
+class _SerializerV1FaceSwapCreateBody(pydantic.BaseModel):
+    """
+    Serializer for V1FaceSwapCreateBody handling case conversions
+    and file omissions as dictated by the API
+    """
+
+    model_config = pydantic.ConfigDict(
+        populate_by_name=True,
+    )
+
+    assets: _SerializerV1FaceSwapCreateBodyAssets = pydantic.Field(
+        alias="assets",
+    )
+    end_seconds: float = pydantic.Field(
+        alias="end_seconds",
+    )
+    height: typing.Optional[int] = pydantic.Field(alias="height", default=None)
+    name: typing.Optional[str] = pydantic.Field(alias="name", default=None)
+    start_seconds: float = pydantic.Field(
+        alias="start_seconds",
+    )
+    width: typing.Optional[int] = pydantic.Field(alias="width", default=None)

{magic_hour-0.13.0 → magic_hour-0.15.0}/magic_hour/types/params/v1_image_to_video_create_body.py

@@ -38,6 +38,9 @@ class V1ImageToVideoCreateBody(typing_extensions.TypedDict):
     """
 
     style: typing_extensions.Required[V1ImageToVideoCreateBodyStyle]
+    """
+    Attributed used to dictate the style of the output
+    """
 
     width: typing_extensions.Required[int]
     """

magic_hour-0.15.0/magic_hour/types/params/v1_image_to_video_create_body_style.py

@@ -0,0 +1,46 @@
+import pydantic
+import typing
+import typing_extensions
+
+
+class V1ImageToVideoCreateBodyStyle(typing_extensions.TypedDict):
+    """
+    Attributed used to dictate the style of the output
+    """
+
+    high_quality: typing_extensions.NotRequired[bool]
+    """
+    Deprecated: Please use `quality_mode` instead. For backward compatibility, setting `high_quality: true` and `quality_mode: quick` will map to `quality_mode: studio`. Note: `quality_mode: studio` offers the same quality as `high_quality: true`.
+    """
+
+    prompt: typing_extensions.NotRequired[str]
+    """
+    The prompt used for the video.
+    """
+
+    quality_mode: typing_extensions.NotRequired[
+        typing_extensions.Literal["quick", "studio"]
+    ]
+    """
+    * `quick` - Fastest option for rapid results. Takes ~3 minutes per 5s of video.
+    *  `studio` - Polished visuals with longer runtime. Takes ~8.5 minutes per 5s of video.
+    """
+
+
+class _SerializerV1ImageToVideoCreateBodyStyle(pydantic.BaseModel):
+    """
+    Serializer for V1ImageToVideoCreateBodyStyle handling case conversions
+    and file omissions as dictated by the API
+    """
+
+    model_config = pydantic.ConfigDict(
+        populate_by_name=True,
+    )
+
+    high_quality: typing.Optional[bool] = pydantic.Field(
+        alias="high_quality", default=None
+    )
+    prompt: typing.Optional[str] = pydantic.Field(alias="prompt", default=None)
+    quality_mode: typing.Optional[typing_extensions.Literal["quick", "studio"]] = (
+        pydantic.Field(alias="quality_mode", default=None)
+    )

{magic_hour-0.13.0 → magic_hour-0.15.0}/magic_hour/types/params/v1_text_to_video_create_body_style.py

@@ -1,4 +1,5 @@
 import pydantic
+import typing
 import typing_extensions
 
 
@@ -12,6 +13,14 @@ class V1TextToVideoCreateBodyStyle(typing_extensions.TypedDict):
     The prompt used for the video.
     """
 
+    quality_mode: typing_extensions.NotRequired[
+        typing_extensions.Literal["quick", "studio"]
+    ]
+    """
+    * `quick` - Fastest option for rapid results. Takes ~3 minutes per 5s of video.
+    *  `studio` - Polished visuals with longer runtime. Takes ~8.5 minutes per 5s of video.
+    """
+
 
 class _SerializerV1TextToVideoCreateBodyStyle(pydantic.BaseModel):
     """
@@ -26,3 +35,6 @@ class _SerializerV1TextToVideoCreateBodyStyle(pydantic.BaseModel):
     prompt: str = pydantic.Field(
         alias="prompt",
     )
+    quality_mode: typing.Optional[typing_extensions.Literal["quick", "studio"]] = (
+        pydantic.Field(alias="quality_mode", default=None)
+    )

{magic_hour-0.13.0 → magic_hour-0.15.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "magic_hour"
-version = "0.13.0"
+version = "0.15.0"
 description = "Python SDK for Magic Hour API"
 readme = "README.md"
 authors = []

magic_hour-0.13.0/magic_hour/types/params/v1_face_swap_create_body.py

@@ -1,72 +0,0 @@
-import pydantic
-import typing
-import typing_extensions
-
-from .v1_face_swap_create_body_assets import (
-    V1FaceSwapCreateBodyAssets,
-    _SerializerV1FaceSwapCreateBodyAssets,
-)
-
-
-class V1FaceSwapCreateBody(typing_extensions.TypedDict):
-    """
-    V1FaceSwapCreateBody
-    """
-
-    assets: typing_extensions.Required[V1FaceSwapCreateBodyAssets]
-    """
-    Provide the assets for face swap. For video, The `video_source` field determines whether `video_file_path` or `youtube_url` field is used
-    """
-
-    end_seconds: typing_extensions.Required[float]
-    """
-    The end time of the input video in seconds
-    """
-
-    height: typing_extensions.Required[int]
-    """
-    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
-    """
-
-    name: typing_extensions.NotRequired[str]
-    """
-    The name of video
-    """
-
-    start_seconds: typing_extensions.Required[float]
-    """
-    The start time of the input video in seconds
-    """
-
-    width: typing_extensions.Required[int]
-    """
-    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
-    """
-
-
-class _SerializerV1FaceSwapCreateBody(pydantic.BaseModel):
-    """
-    Serializer for V1FaceSwapCreateBody handling case conversions
-    and file omissions as dictated by the API
-    """
-
-    model_config = pydantic.ConfigDict(
-        populate_by_name=True,
-    )
-
-    assets: _SerializerV1FaceSwapCreateBodyAssets = pydantic.Field(
-        alias="assets",
-    )
-    end_seconds: float = pydantic.Field(
-        alias="end_seconds",
-    )
-    height: int = pydantic.Field(
-        alias="height",
-    )
-    name: typing.Optional[str] = pydantic.Field(alias="name", default=None)
-    start_seconds: float = pydantic.Field(
-        alias="start_seconds",
-    )
-    width: int = pydantic.Field(
-        alias="width",
-    )

magic_hour-0.13.0/magic_hour/types/params/v1_image_to_video_create_body_style.py

@@ -1,37 +0,0 @@
-import pydantic
-import typing
-import typing_extensions
-
-
-class V1ImageToVideoCreateBodyStyle(typing_extensions.TypedDict):
-    """
-    V1ImageToVideoCreateBodyStyle
-    """
-
-    high_quality: typing_extensions.NotRequired[bool]
-    """
-    High Quality mode enhances detail, sharpness, and realism, making it ideal for portraits, animals, and intricate landscapes.
-    """
-
-    prompt: typing_extensions.Required[typing.Optional[str]]
-    """
-    The prompt used for the video.
-    """
-
-
-class _SerializerV1ImageToVideoCreateBodyStyle(pydantic.BaseModel):
-    """
-    Serializer for V1ImageToVideoCreateBodyStyle handling case conversions
-    and file omissions as dictated by the API
-    """
-
-    model_config = pydantic.ConfigDict(
-        populate_by_name=True,
-    )
-
-    high_quality: typing.Optional[bool] = pydantic.Field(
-        alias="high_quality", default=None
-    )
-    prompt: typing.Optional[str] = pydantic.Field(
-        alias="prompt",
-    )

{magic_hour-0.13.0 → magic_hour-0.15.0}/magic_hour/resources/v1/face_swap/README.md

@@ -23,10 +23,10 @@ res = client.v1.face_swap.create(
         "video_source": "file",
     },
     end_seconds=15.0,
-    height=960,
     start_seconds=0.0,
-    width=512,
+    height=960,
     name="Face Swap video",
+    width=512,
 )
 ```
 
@@ -44,9 +44,9 @@ res = await client.v1.face_swap.create(
         "video_source": "file",
     },
     end_seconds=15.0,
-    height=960,
     start_seconds=0.0,
-    width=512,
+    height=960,
     name="Face Swap video",
+    width=512,
 )
 ```