magic_hour 0.30.1__tar.gz → 0.31.0__tar.gz

{magic_hour-0.30.1 → magic_hour-0.31.0}/PKG-INFO

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

{magic_hour-0.30.1 → magic_hour-0.31.0}/magic_hour/environment.py

@@ -6,7 +6,7 @@ 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.30.1"
+    MOCK_SERVER = "https://api.sideko.dev/v1/mock/magichour/magic-hour/0.31.0"
 
 
 def _get_base_url(

{magic_hour-0.30.1 → magic_hour-0.31.0}/magic_hour/resources/v1/face_swap/README.md

@@ -3,7 +3,7 @@
 
 Create a Face Swap video. The estimated frame cost is calculated using 30 FPS. This amount is deducted from your account balance when a video is queued. Once the video is complete, the cost will be updated based on the actual number of frames rendered.
   
-Get more information about this mode at our [product page](/products/face-swap).
+Get more information about this mode at our [product page](https://magichour.ai/products/face-swap).
   
 
 **API Endpoint**: `POST /v1/face-swap`
@@ -12,7 +12,7 @@ Get more information about this mode at our [product page](/products/face-swap).
 
 | Parameter | Required | Description | Example |
 |-----------|:--------:|-------------|--------|
-| `assets` | ✓ | Provide the assets for face swap. For video, The `video_source` field determines whether `video_file_path` or `youtube_url` field is used | `{"image_file_path": "image/id/1234.png", "video_file_path": "api-assets/id/1234.mp4", "video_source": "file"}` |
+| `assets` | ✓ | Provide the assets for face swap. For video, The `video_source` field determines whether `video_file_path` or `youtube_url` field is used | `{"face_mappings": [{"new_face": "api-assets/id/1234.png", "original_face": "api-assets/id/0-0.png"}], "face_swap_mode": "all-faces", "image_file_path": "image/id/1234.png", "video_file_path": "api-assets/id/1234.mp4", "video_source": "file"}` |
 | `end_seconds` | ✓ | The end time of the input video in seconds | `15.0` |
 | `start_seconds` | ✓ | The start time of the input video in seconds | `0.0` |
 | `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. | `960` |
@@ -28,6 +28,13 @@ from os import getenv
 client = Client(token=getenv("API_TOKEN"))
 res = client.v1.face_swap.create(
     assets={
+        "face_mappings": [
+            {
+                "new_face": "api-assets/id/1234.png",
+                "original_face": "api-assets/id/0-0.png",
+            }
+        ],
+        "face_swap_mode": "all-faces",
         "image_file_path": "image/id/1234.png",
         "video_file_path": "api-assets/id/1234.mp4",
         "video_source": "file",
@@ -50,6 +57,13 @@ from os import getenv
 client = AsyncClient(token=getenv("API_TOKEN"))
 res = await client.v1.face_swap.create(
     assets={
+        "face_mappings": [
+            {
+                "new_face": "api-assets/id/1234.png",
+                "original_face": "api-assets/id/0-0.png",
+            }
+        ],
+        "face_swap_mode": "all-faces",
         "image_file_path": "image/id/1234.png",
         "video_file_path": "api-assets/id/1234.mp4",
         "video_source": "file",

{magic_hour-0.30.1 → magic_hour-0.31.0}/magic_hour/resources/v1/face_swap/client.py

@@ -37,7 +37,7 @@ class FaceSwapClient:
 
         Create a Face Swap video. The estimated frame cost is calculated using 30 FPS. This amount is deducted from your account balance when a video is queued. Once the video is complete, the cost will be updated based on the actual number of frames rendered.
 
-        Get more information about this mode at our [product page](/products/face-swap).
+        Get more information about this mode at our [product page](https://magichour.ai/products/face-swap).
 
 
         POST /v1/face-swap
@@ -76,6 +76,13 @@ class FaceSwapClient:
         ```py
         client.v1.face_swap.create(
             assets={
+                "face_mappings": [
+                    {
+                        "new_face": "api-assets/id/1234.png",
+                        "original_face": "api-assets/id/0-0.png",
+                    }
+                ],
+                "face_swap_mode": "all-faces",
                 "image_file_path": "image/id/1234.png",
                 "video_file_path": "api-assets/id/1234.mp4",
                 "video_source": "file",
@@ -135,7 +142,7 @@ class AsyncFaceSwapClient:
 
         Create a Face Swap video. The estimated frame cost is calculated using 30 FPS. This amount is deducted from your account balance when a video is queued. Once the video is complete, the cost will be updated based on the actual number of frames rendered.
 
-        Get more information about this mode at our [product page](/products/face-swap).
+        Get more information about this mode at our [product page](https://magichour.ai/products/face-swap).
 
 
         POST /v1/face-swap
@@ -174,6 +181,13 @@ class AsyncFaceSwapClient:
         ```py
         await client.v1.face_swap.create(
             assets={
+                "face_mappings": [
+                    {
+                        "new_face": "api-assets/id/1234.png",
+                        "original_face": "api-assets/id/0-0.png",
+                    }
+                ],
+                "face_swap_mode": "all-faces",
                 "image_file_path": "image/id/1234.png",
                 "video_file_path": "api-assets/id/1234.mp4",
                 "video_source": "file",

{magic_hour-0.30.1 → magic_hour-0.31.0}/magic_hour/resources/v1/face_swap_photo/README.md

@@ -1,7 +1,7 @@
 
 ### Face Swap Photo <a name="create"></a>
 
-Create a face swap photo. Each photo costs 5 credits. The height/width of the output image depends on your subscription. Please refer to our [pricing](/pricing) page for more details
+Create a face swap photo. Each photo costs 5 credits. The height/width of the output image depends on your subscription. Please refer to our [pricing](https://magichour.ai/pricing) page for more details
 
 **API Endpoint**: `POST /v1/face-swap-photo`
 

{magic_hour-0.30.1 → magic_hour-0.31.0}/magic_hour/resources/v1/face_swap_photo/client.py

@@ -27,7 +27,7 @@ class FaceSwapPhotoClient:
         """
         Face Swap Photo
 
-        Create a face swap photo. Each photo costs 5 credits. The height/width of the output image depends on your subscription. Please refer to our [pricing](/pricing) page for more details
+        Create a face swap photo. Each photo costs 5 credits. The height/width of the output image depends on your subscription. Please refer to our [pricing](https://magichour.ai/pricing) page for more details
 
         POST /v1/face-swap-photo
 
@@ -91,7 +91,7 @@ class AsyncFaceSwapPhotoClient:
         """
         Face Swap Photo
 
-        Create a face swap photo. Each photo costs 5 credits. The height/width of the output image depends on your subscription. Please refer to our [pricing](/pricing) page for more details
+        Create a face swap photo. Each photo costs 5 credits. The height/width of the output image depends on your subscription. Please refer to our [pricing](https://magichour.ai/pricing) page for more details
 
         POST /v1/face-swap-photo
 

{magic_hour-0.30.1 → magic_hour-0.31.0}/magic_hour/resources/v1/image_to_video/README.md

@@ -3,7 +3,7 @@
 
 Create a Image To Video video. The estimated frame cost is calculated using 30 FPS. This amount is deducted from your account balance when a video is queued. Once the video is complete, the cost will be updated based on the actual number of frames rendered.
   
-Get more information about this mode at our [product page](/products/image-to-video).
+Get more information about this mode at our [product page](https://magichour.ai/products/image-to-video).
   
 
 **API Endpoint**: `POST /v1/image-to-video`

{magic_hour-0.30.1 → magic_hour-0.31.0}/magic_hour/resources/v1/image_to_video/client.py

@@ -44,7 +44,7 @@ class ImageToVideoClient:
 
         Create a Image To Video video. The estimated frame cost is calculated using 30 FPS. This amount is deducted from your account balance when a video is queued. Once the video is complete, the cost will be updated based on the actual number of frames rendered.
 
-        Get more information about this mode at our [product page](/products/image-to-video).
+        Get more information about this mode at our [product page](https://magichour.ai/products/image-to-video).
 
 
         POST /v1/image-to-video
@@ -140,7 +140,7 @@ class AsyncImageToVideoClient:
 
         Create a Image To Video video. The estimated frame cost is calculated using 30 FPS. This amount is deducted from your account balance when a video is queued. Once the video is complete, the cost will be updated based on the actual number of frames rendered.
 
-        Get more information about this mode at our [product page](/products/image-to-video).
+        Get more information about this mode at our [product page](https://magichour.ai/products/image-to-video).
 
 
         POST /v1/image-to-video

{magic_hour-0.30.1 → magic_hour-0.31.0}/magic_hour/resources/v1/lip_sync/README.md

@@ -3,7 +3,7 @@
 
 Create a Lip Sync video. The estimated frame cost is calculated using 30 FPS. This amount is deducted from your account balance when a video is queued. Once the video is complete, the cost will be updated based on the actual number of frames rendered.
   
-Get more information about this mode at our [product page](/products/lip-sync).
+Get more information about this mode at our [product page](https://magichour.ai/products/lip-sync).
   
 
 **API Endpoint**: `POST /v1/lip-sync`

{magic_hour-0.30.1 → magic_hour-0.31.0}/magic_hour/resources/v1/lip_sync/client.py

@@ -40,7 +40,7 @@ class LipSyncClient:
 
         Create a Lip Sync video. The estimated frame cost is calculated using 30 FPS. This amount is deducted from your account balance when a video is queued. Once the video is complete, the cost will be updated based on the actual number of frames rendered.
 
-        Get more information about this mode at our [product page](/products/lip-sync).
+        Get more information about this mode at our [product page](https://magichour.ai/products/lip-sync).
 
 
         POST /v1/lip-sync
@@ -144,7 +144,7 @@ class AsyncLipSyncClient:
 
         Create a Lip Sync video. The estimated frame cost is calculated using 30 FPS. This amount is deducted from your account balance when a video is queued. Once the video is complete, the cost will be updated based on the actual number of frames rendered.
 
-        Get more information about this mode at our [product page](/products/lip-sync).
+        Get more information about this mode at our [product page](https://magichour.ai/products/lip-sync).
 
 
         POST /v1/lip-sync

{magic_hour-0.30.1 → magic_hour-0.31.0}/magic_hour/resources/v1/text_to_video/README.md

@@ -3,7 +3,7 @@
 
 Create a Text To Video video. The estimated frame cost is calculated using 30 FPS. This amount is deducted from your account balance when a video is queued. Once the video is complete, the cost will be updated based on the actual number of frames rendered.
   
-Get more information about this mode at our [product page](/products/text-to-video).
+Get more information about this mode at our [product page](https://magichour.ai/products/text-to-video).
   
 
 **API Endpoint**: `POST /v1/text-to-video`

{magic_hour-0.30.1 → magic_hour-0.31.0}/magic_hour/resources/v1/text_to_video/client.py

@@ -36,7 +36,7 @@ class TextToVideoClient:
 
         Create a Text To Video video. The estimated frame cost is calculated using 30 FPS. This amount is deducted from your account balance when a video is queued. Once the video is complete, the cost will be updated based on the actual number of frames rendered.
 
-        Get more information about this mode at our [product page](/products/text-to-video).
+        Get more information about this mode at our [product page](https://magichour.ai/products/text-to-video).
 
 
         POST /v1/text-to-video
@@ -115,7 +115,7 @@ class AsyncTextToVideoClient:
 
         Create a Text To Video video. The estimated frame cost is calculated using 30 FPS. This amount is deducted from your account balance when a video is queued. Once the video is complete, the cost will be updated based on the actual number of frames rendered.
 
-        Get more information about this mode at our [product page](/products/text-to-video).
+        Get more information about this mode at our [product page](https://magichour.ai/products/text-to-video).
 
 
         POST /v1/text-to-video

{magic_hour-0.30.1 → magic_hour-0.31.0}/magic_hour/resources/v1/video_to_video/README.md

@@ -3,7 +3,7 @@
 
 Create a Video To Video video. The estimated frame cost is calculated using 30 FPS. This amount is deducted from your account balance when a video is queued. Once the video is complete, the cost will be updated based on the actual number of frames rendered.
   
-Get more information about this mode at our [product page](/products/video-to-video).
+Get more information about this mode at our [product page](https://magichour.ai/products/video-to-video).
   
 
 **API Endpoint**: `POST /v1/video-to-video`

{magic_hour-0.30.1 → magic_hour-0.31.0}/magic_hour/resources/v1/video_to_video/client.py

@@ -43,7 +43,7 @@ class VideoToVideoClient:
 
         Create a Video To Video video. The estimated frame cost is calculated using 30 FPS. This amount is deducted from your account balance when a video is queued. Once the video is complete, the cost will be updated based on the actual number of frames rendered.
 
-        Get more information about this mode at our [product page](/products/video-to-video).
+        Get more information about this mode at our [product page](https://magichour.ai/products/video-to-video).
 
 
         POST /v1/video-to-video
@@ -159,7 +159,7 @@ class AsyncVideoToVideoClient:
 
         Create a Video To Video video. The estimated frame cost is calculated using 30 FPS. This amount is deducted from your account balance when a video is queued. Once the video is complete, the cost will be updated based on the actual number of frames rendered.
 
-        Get more information about this mode at our [product page](/products/video-to-video).
+        Get more information about this mode at our [product page](https://magichour.ai/products/video-to-video).
 
 
         POST /v1/video-to-video

{magic_hour-0.30.1 → magic_hour-0.31.0}/magic_hour/types/params/__init__.py

@@ -154,6 +154,10 @@ from .v1_face_swap_create_body_assets import (
     V1FaceSwapCreateBodyAssets,
     _SerializerV1FaceSwapCreateBodyAssets,
 )
+from .v1_face_swap_create_body_assets_face_mappings_item import (
+    V1FaceSwapCreateBodyAssetsFaceMappingsItem,
+    _SerializerV1FaceSwapCreateBodyAssetsFaceMappingsItem,
+)
 from .v1_face_swap_photo_create_body import (
     V1FaceSwapPhotoCreateBody,
     _SerializerV1FaceSwapPhotoCreateBody,
@@ -269,6 +273,7 @@ __all__ = [
     "V1FaceDetectionCreateBodyAssets",
     "V1FaceSwapCreateBody",
     "V1FaceSwapCreateBodyAssets",
+    "V1FaceSwapCreateBodyAssetsFaceMappingsItem",
     "V1FaceSwapPhotoCreateBody",
     "V1FaceSwapPhotoCreateBodyAssets",
     "V1FaceSwapPhotoCreateBodyAssetsFaceMappingsItem",
@@ -327,6 +332,7 @@ __all__ = [
     "_SerializerV1FaceDetectionCreateBodyAssets",
     "_SerializerV1FaceSwapCreateBody",
     "_SerializerV1FaceSwapCreateBodyAssets",
+    "_SerializerV1FaceSwapCreateBodyAssetsFaceMappingsItem",
     "_SerializerV1FaceSwapPhotoCreateBody",
     "_SerializerV1FaceSwapPhotoCreateBodyAssets",
     "_SerializerV1FaceSwapPhotoCreateBodyAssetsFaceMappingsItem",

{magic_hour-0.30.1 → magic_hour-0.31.0}/magic_hour/types/params/v1_face_swap_create_body_assets.py

@@ -2,15 +2,38 @@ import pydantic
 import typing
 import typing_extensions
 
+from .v1_face_swap_create_body_assets_face_mappings_item import (
+    V1FaceSwapCreateBodyAssetsFaceMappingsItem,
+    _SerializerV1FaceSwapCreateBodyAssetsFaceMappingsItem,
+)
+
 
 class V1FaceSwapCreateBodyAssets(typing_extensions.TypedDict):
     """
     Provide the assets for face swap. For video, The `video_source` field determines whether `video_file_path` or `youtube_url` field is used
     """
 
+    face_mappings: typing_extensions.NotRequired[
+        typing.List[V1FaceSwapCreateBodyAssetsFaceMappingsItem]
+    ]
+    """
+    This is the array of face mappings used for multiple face swap. The value is required if `face_swap_mode` is `individual-faces`.
+    """
+
+    face_swap_mode: typing_extensions.NotRequired[
+        typing_extensions.Literal["all-faces", "individual-faces"]
+    ]
+    """
+    The mode of face swap.
+    * `all-faces` - Swap all faces in the target image or video. `source_file_path` is required.
+    * `individual-faces` - Swap individual faces in the target image or video. `source_faces` is required.
+    """
+
     image_file_path: typing_extensions.Required[str]
     """
-    The path of the input image. 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.
+    The path of the input image with the face to be swapped.  The value is required if `face_swap_mode` is `all-faces`.
+    
+    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.
     """
 
     video_file_path: typing_extensions.NotRequired[str]
@@ -38,6 +61,12 @@ class _SerializerV1FaceSwapCreateBodyAssets(pydantic.BaseModel):
         populate_by_name=True,
     )
 
+    face_mappings: typing.Optional[
+        typing.List[_SerializerV1FaceSwapCreateBodyAssetsFaceMappingsItem]
+    ] = pydantic.Field(alias="face_mappings", default=None)
+    face_swap_mode: typing.Optional[
+        typing_extensions.Literal["all-faces", "individual-faces"]
+    ] = pydantic.Field(alias="face_swap_mode", default=None)
     image_file_path: str = pydantic.Field(
         alias="image_file_path",
     )

magic_hour-0.31.0/magic_hour/types/params/v1_face_swap_create_body_assets_face_mappings_item.py

@@ -0,0 +1,39 @@
+import pydantic
+import typing_extensions
+
+
+class V1FaceSwapCreateBodyAssetsFaceMappingsItem(typing_extensions.TypedDict):
+    """
+    V1FaceSwapCreateBodyAssetsFaceMappingsItem
+    """
+
+    new_face: typing_extensions.Required[str]
+    """
+    The face image that will be used to replace the face in the `original_face`. 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.
+    """
+
+    original_face: typing_extensions.Required[str]
+    """
+    The face detected from the image in `target_file_path`. The file name is in the format of `<face_frame>-<face_index>.png`. This value is corresponds to the response in the [face detection API](https://docs.magichour.ai/api-reference/files/get-face-detection-details).
+    
+    * The face_frame is the frame number of the face in the target image. For images, the frame number is always 0.
+    * The face_index is the index of the face in the target image, starting from 0 going left to right.
+    """
+
+
+class _SerializerV1FaceSwapCreateBodyAssetsFaceMappingsItem(pydantic.BaseModel):
+    """
+    Serializer for V1FaceSwapCreateBodyAssetsFaceMappingsItem handling case conversions
+    and file omissions as dictated by the API
+    """
+
+    model_config = pydantic.ConfigDict(
+        populate_by_name=True,
+    )
+
+    new_face: str = pydantic.Field(
+        alias="new_face",
+    )
+    original_face: str = pydantic.Field(
+        alias="original_face",
+    )

{magic_hour-0.30.1 → magic_hour-0.31.0}/magic_hour/types/params/v1_face_swap_photo_create_body_assets.py

@@ -25,8 +25,8 @@ class V1FaceSwapPhotoCreateBodyAssets(typing_extensions.TypedDict):
     ]
     """
     The mode of face swap.
-    * `all-faces` - Swap all faces in the target image. `source_file_path` is required.
-    * `individual-faces` - Swap individual faces in the target image. `source_faces` is required.
+    * `all-faces` - Swap all faces in the target image or video. `source_file_path` is required.
+    * `individual-faces` - Swap individual faces in the target image or video. `source_faces` is required.
     """
 
     source_file_path: typing_extensions.NotRequired[str]

{magic_hour-0.30.1 → magic_hour-0.31.0}/magic_hour/types/params/v1_face_swap_photo_create_body_assets_face_mappings_item.py

@@ -14,7 +14,7 @@ class V1FaceSwapPhotoCreateBodyAssetsFaceMappingsItem(typing_extensions.TypedDic
 
     original_face: typing_extensions.Required[str]
     """
-    The face detected from the image in `target_file_path`. The file name is in the format of `<face_frame>-<face_index>.png`. This value is corresponds to the response in the face detection API [COMING SOON].
+    The face detected from the image in `target_file_path`. The file name is in the format of `<face_frame>-<face_index>.png`. This value is corresponds to the response in the [face detection API](https://docs.magichour.ai/api-reference/files/get-face-detection-details).
     
     * The face_frame is the frame number of the face in the target image. For images, the frame number is always 0.
     * The face_index is the index of the face in the target image, starting from 0 going left to right.

{magic_hour-0.30.1 → magic_hour-0.31.0}/pyproject.toml

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