magic_hour 0.9.5__py3-none-any.whl → 0.44.0__py3-none-any.whl

magic_hour/types/params/v1_face_swap_generate_body_assets.py

@@ -0,0 +1,56 @@
+import pydantic
+import typing
+import typing_extensions
+
+from .v1_face_swap_generate_body_assets_face_mappings_item import (
+    V1FaceSwapGenerateBodyAssetsFaceMappingsItem,
+)
+
+
+class V1FaceSwapGenerateBodyAssets(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[V1FaceSwapGenerateBodyAssetsFaceMappingsItem]
+    ]
+    """
+    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.NotRequired[str]
+    """
+    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 is either
+    - a direct URL to the image file
+    - a path to a local file
+
+    Note: if the path begins with `api-assets`, it will be assumed to already be uploaded to Magic Hour's storage, and will not be uploaded again.
+    """
+
+    video_file_path: typing_extensions.NotRequired[str]
+    """
+    Required if `video_source` is `file`. This value is either
+    - a direct URL to the image file
+    - a path to a local file
+
+    Note: if the path begins with `api-assets`, it will be assumed to already be uploaded to Magic Hour's storage, and will not be uploaded again.
+    """
+
+    video_source: typing_extensions.Required[
+        typing_extensions.Literal["file", "youtube"]
+    ]
+
+    youtube_url: typing_extensions.NotRequired[str]
+    """
+    Using a youtube video as the input source. This field is required if `video_source` is `youtube`
+    """

magic_hour/types/params/v1_face_swap_generate_body_assets_face_mappings_item.py

@@ -0,0 +1,25 @@
+import pydantic
+import typing_extensions
+
+
+class V1FaceSwapGenerateBodyAssetsFaceMappingsItem(typing_extensions.TypedDict):
+    """
+    V1FaceSwapGenerateBodyAssetsFaceMappingsItem
+    """
+
+    new_face: typing_extensions.Required[str]
+    """
+    The face image that will be used to replace the face in the `original_face`. This value is either
+    - a direct URL to the image file
+    - a path to a local file
+
+    Note: if the path begins with `api-assets`, it will be assumed to already be uploaded to Magic Hour's storage, and will not be uploaded again.
+    """
+
+    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.
+    """

magic_hour/types/params/v1_face_swap_photo_create_body.py

@@ -0,0 +1,40 @@
+import pydantic
+import typing
+import typing_extensions
+
+from .v1_face_swap_photo_create_body_assets import (
+    V1FaceSwapPhotoCreateBodyAssets,
+    _SerializerV1FaceSwapPhotoCreateBodyAssets,
+)
+
+
+class V1FaceSwapPhotoCreateBody(typing_extensions.TypedDict):
+    """
+    V1FaceSwapPhotoCreateBody
+    """
+
+    assets: typing_extensions.Required[V1FaceSwapPhotoCreateBodyAssets]
+    """
+    Provide the assets for face swap photo
+    """
+
+    name: typing_extensions.NotRequired[str]
+    """
+    The name of image. This value is mainly used for your own identification of the image.
+    """
+
+
+class _SerializerV1FaceSwapPhotoCreateBody(pydantic.BaseModel):
+    """
+    Serializer for V1FaceSwapPhotoCreateBody handling case conversions
+    and file omissions as dictated by the API
+    """
+
+    model_config = pydantic.ConfigDict(
+        populate_by_name=True,
+    )
+
+    assets: _SerializerV1FaceSwapPhotoCreateBodyAssets = pydantic.Field(
+        alias="assets",
+    )
+    name: typing.Optional[str] = pydantic.Field(alias="name", default=None)

magic_hour/types/params/v1_face_swap_photo_create_body_assets.py

@@ -0,0 +1,76 @@
+import pydantic
+import typing
+import typing_extensions
+
+from .v1_face_swap_photo_create_body_assets_face_mappings_item import (
+    V1FaceSwapPhotoCreateBodyAssetsFaceMappingsItem,
+    _SerializerV1FaceSwapPhotoCreateBodyAssetsFaceMappingsItem,
+)
+
+
+class V1FaceSwapPhotoCreateBodyAssets(typing_extensions.TypedDict):
+    """
+    Provide the assets for face swap photo
+    """
+
+    face_mappings: typing_extensions.NotRequired[
+        typing.List[V1FaceSwapPhotoCreateBodyAssetsFaceMappingsItem]
+    ]
+    """
+    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.
+    """
+
+    source_file_path: typing_extensions.NotRequired[str]
+    """
+    This is the image from which the face is extracted. The value is required if `face_swap_mode` is `all-faces`.
+    
+    This value is either
+    - a direct URL to the video file
+    - `file_path` field from the response of the [upload urls API](https://docs.magichour.ai/api-reference/files/generate-asset-upload-urls).
+    
+    Please refer to the [Input File documentation](https://docs.magichour.ai/api-reference/files/generate-asset-upload-urls#input-file) to learn more.
+    
+    """
+
+    target_file_path: typing_extensions.Required[str]
+    """
+    This is the image where the face from the source image will be placed. This value is either
+    - a direct URL to the video file
+    - `file_path` field from the response of the [upload urls API](https://docs.magichour.ai/api-reference/files/generate-asset-upload-urls).
+    
+    Please refer to the [Input File documentation](https://docs.magichour.ai/api-reference/files/generate-asset-upload-urls#input-file) to learn more.
+    
+    """
+
+
+class _SerializerV1FaceSwapPhotoCreateBodyAssets(pydantic.BaseModel):
+    """
+    Serializer for V1FaceSwapPhotoCreateBodyAssets handling case conversions
+    and file omissions as dictated by the API
+    """
+
+    model_config = pydantic.ConfigDict(
+        populate_by_name=True,
+    )
+
+    face_mappings: typing.Optional[
+        typing.List[_SerializerV1FaceSwapPhotoCreateBodyAssetsFaceMappingsItem]
+    ] = 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)
+    source_file_path: typing.Optional[str] = pydantic.Field(
+        alias="source_file_path", default=None
+    )
+    target_file_path: str = pydantic.Field(
+        alias="target_file_path",
+    )

magic_hour/types/params/v1_face_swap_photo_create_body_assets_face_mappings_item.py

@@ -0,0 +1,44 @@
+import pydantic
+import typing_extensions
+
+
+class V1FaceSwapPhotoCreateBodyAssetsFaceMappingsItem(typing_extensions.TypedDict):
+    """
+    V1FaceSwapPhotoCreateBodyAssetsFaceMappingsItem
+    """
+
+    new_face: typing_extensions.Required[str]
+    """
+    The face image that will be used to replace the face in the `original_face`. This value is either
+    - a direct URL to the video file
+    - `file_path` field from the response of the [upload urls API](https://docs.magichour.ai/api-reference/files/generate-asset-upload-urls).
+    
+    Please refer to the [Input File documentation](https://docs.magichour.ai/api-reference/files/generate-asset-upload-urls#input-file) to learn more.
+    
+    """
+
+    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 _SerializerV1FaceSwapPhotoCreateBodyAssetsFaceMappingsItem(pydantic.BaseModel):
+    """
+    Serializer for V1FaceSwapPhotoCreateBodyAssetsFaceMappingsItem 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/types/params/v1_face_swap_photo_generate_body_assets.py

@@ -0,0 +1,47 @@
+import pydantic
+import typing
+import typing_extensions
+
+from .v1_face_swap_photo_generate_body_assets_face_mappings_item import (
+    V1FaceSwapPhotoGenerateBodyAssetsFaceMappingsItem,
+)
+
+
+class V1FaceSwapPhotoGenerateBodyAssets(typing_extensions.TypedDict):
+    """
+    Provide the assets for face swap photo
+    """
+
+    face_mappings: typing_extensions.NotRequired[
+        typing.List[V1FaceSwapPhotoGenerateBodyAssetsFaceMappingsItem]
+    ]
+    """
+    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.
+    """
+
+    source_file_path: typing_extensions.NotRequired[str]
+    """
+    This is the image from which the face is extracted. The value is required if `face_swap_mode` is `all-faces`. This value is either
+    - a direct URL to the image file
+    - a path to a local file
+
+    Note: if the path begins with `api-assets`, it will be assumed to already be uploaded to Magic Hour's storage, and will not be uploaded again.
+    """
+
+    target_file_path: typing_extensions.Required[str]
+    """
+    This is the image where the face from the source image will be placed. This value is either
+    - a direct URL to the image file
+    - a path to a local file
+
+    Note: if the path begins with `api-assets`, it will be assumed to already be uploaded to Magic Hour's storage, and will not be uploaded again.
+    """

magic_hour/types/params/v1_face_swap_photo_generate_body_assets_face_mappings_item.py

@@ -0,0 +1,25 @@
+import pydantic
+import typing_extensions
+
+
+class V1FaceSwapPhotoGenerateBodyAssetsFaceMappingsItem(typing_extensions.TypedDict):
+    """
+    V1FaceSwapPhotoGenerateBodyAssetsFaceMappingsItem
+    """
+
+    new_face: typing_extensions.Required[str]
+    """
+    The face image that will be used to replace the face in the `original_face`. This value is either
+    - a direct URL to the image file
+    - a path to a local file
+
+    Note: if the path begins with `api-assets`, it will be assumed to already be uploaded to Magic Hour's storage, and will not be uploaded again.
+    """
+
+    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.
+    """

magic_hour/types/params/v1_files_upload_urls_create_body.py

@@ -0,0 +1,36 @@
+import pydantic
+import typing
+import typing_extensions
+
+from .v1_files_upload_urls_create_body_items_item import (
+    V1FilesUploadUrlsCreateBodyItemsItem,
+    _SerializerV1FilesUploadUrlsCreateBodyItemsItem,
+)
+
+
+class V1FilesUploadUrlsCreateBody(typing_extensions.TypedDict):
+    """
+    V1FilesUploadUrlsCreateBody
+    """
+
+    items: typing_extensions.Required[typing.List[V1FilesUploadUrlsCreateBodyItemsItem]]
+    """
+    The list of assets to upload. The response array will match the order of items in the request body.
+    """
+
+
+class _SerializerV1FilesUploadUrlsCreateBody(pydantic.BaseModel):
+    """
+    Serializer for V1FilesUploadUrlsCreateBody handling case conversions
+    and file omissions as dictated by the API
+    """
+
+    model_config = pydantic.ConfigDict(
+        populate_by_name=True,
+    )
+
+    items: typing.List[_SerializerV1FilesUploadUrlsCreateBodyItemsItem] = (
+        pydantic.Field(
+            alias="items",
+        )
+    )

magic_hour/types/params/v1_files_upload_urls_create_body_items_item.py

@@ -0,0 +1,38 @@
+import pydantic
+import typing_extensions
+
+
+class V1FilesUploadUrlsCreateBodyItemsItem(typing_extensions.TypedDict):
+    """
+    V1FilesUploadUrlsCreateBodyItemsItem
+    """
+
+    extension: typing_extensions.Required[str]
+    """
+    The extension of the file to upload. Do not include the dot (.) before the extension. Possible extensions are mp4,m4v,mov,webm,mp3,wav,aac,flac,webm,png,jpg,jpeg,heic,webp,avif,jp2,tiff,bmp,gif,webp,webm
+    """
+
+    type_: typing_extensions.Required[
+        typing_extensions.Literal["audio", "image", "video"]
+    ]
+    """
+    The type of asset to upload. Possible types are video, audio, image
+    """
+
+
+class _SerializerV1FilesUploadUrlsCreateBodyItemsItem(pydantic.BaseModel):
+    """
+    Serializer for V1FilesUploadUrlsCreateBodyItemsItem handling case conversions
+    and file omissions as dictated by the API
+    """
+
+    model_config = pydantic.ConfigDict(
+        populate_by_name=True,
+    )
+
+    extension: str = pydantic.Field(
+        alias="extension",
+    )
+    type_: typing_extensions.Literal["audio", "image", "video"] = pydantic.Field(
+        alias="type",
+    )

magic_hour/types/params/v1_image_background_remover_create_body.py

@@ -0,0 +1,40 @@
+import pydantic
+import typing
+import typing_extensions
+
+from .v1_image_background_remover_create_body_assets import (
+    V1ImageBackgroundRemoverCreateBodyAssets,
+    _SerializerV1ImageBackgroundRemoverCreateBodyAssets,
+)
+
+
+class V1ImageBackgroundRemoverCreateBody(typing_extensions.TypedDict):
+    """
+    V1ImageBackgroundRemoverCreateBody
+    """
+
+    assets: typing_extensions.Required[V1ImageBackgroundRemoverCreateBodyAssets]
+    """
+    Provide the assets for background removal
+    """
+
+    name: typing_extensions.NotRequired[str]
+    """
+    The name of image. This value is mainly used for your own identification of the image.
+    """
+
+
+class _SerializerV1ImageBackgroundRemoverCreateBody(pydantic.BaseModel):
+    """
+    Serializer for V1ImageBackgroundRemoverCreateBody handling case conversions
+    and file omissions as dictated by the API
+    """
+
+    model_config = pydantic.ConfigDict(
+        populate_by_name=True,
+    )
+
+    assets: _SerializerV1ImageBackgroundRemoverCreateBodyAssets = pydantic.Field(
+        alias="assets",
+    )
+    name: typing.Optional[str] = pydantic.Field(alias="name", default=None)

magic_hour/types/params/v1_image_background_remover_create_body_assets.py

@@ -0,0 +1,49 @@
+import pydantic
+import typing
+import typing_extensions
+
+
+class V1ImageBackgroundRemoverCreateBodyAssets(typing_extensions.TypedDict):
+    """
+    Provide the assets for background removal
+    """
+
+    background_image_file_path: typing_extensions.NotRequired[str]
+    """
+    The image used as the new background for the image_file_path. This image will be resized to match the image in image_file_path. Please make sure the resolution between the images are similar.
+    
+    This value is either
+    - a direct URL to the video file
+    - `file_path` field from the response of the [upload urls API](https://docs.magichour.ai/api-reference/files/generate-asset-upload-urls).
+    
+    Please refer to the [Input File documentation](https://docs.magichour.ai/api-reference/files/generate-asset-upload-urls#input-file) to learn more.
+    
+    """
+
+    image_file_path: typing_extensions.Required[str]
+    """
+    The image to remove the background. This value is either
+    - a direct URL to the video file
+    - `file_path` field from the response of the [upload urls API](https://docs.magichour.ai/api-reference/files/generate-asset-upload-urls).
+    
+    Please refer to the [Input File documentation](https://docs.magichour.ai/api-reference/files/generate-asset-upload-urls#input-file) to learn more.
+    
+    """
+
+
+class _SerializerV1ImageBackgroundRemoverCreateBodyAssets(pydantic.BaseModel):
+    """
+    Serializer for V1ImageBackgroundRemoverCreateBodyAssets handling case conversions
+    and file omissions as dictated by the API
+    """
+
+    model_config = pydantic.ConfigDict(
+        populate_by_name=True,
+    )
+
+    background_image_file_path: typing.Optional[str] = pydantic.Field(
+        alias="background_image_file_path", default=None
+    )
+    image_file_path: str = pydantic.Field(
+        alias="image_file_path",
+    )

magic_hour/types/params/v1_image_background_remover_generate_body_assets.py

@@ -0,0 +1,27 @@
+import pydantic
+import typing
+import typing_extensions
+
+
+class V1ImageBackgroundRemoverGenerateBodyAssets(typing_extensions.TypedDict):
+    """
+    Provide the assets for background removal
+    """
+
+    background_image_file_path: typing_extensions.NotRequired[str]
+    """
+    The image used as the new background for the image_file_path. This image will be resized to match the image in image_file_path. Please make sure the resolution between the images are similar. This value is either
+    - a direct URL to the image file
+    - a path to a local file
+
+    Note: if the path begins with `api-assets`, it will be assumed to already be uploaded to Magic Hour's storage, and will not be uploaded again.
+    """
+
+    image_file_path: typing_extensions.Required[str]
+    """
+    The image to remove the background. This value is either
+    - a direct URL to the image file
+    - a path to a local file
+
+    Note: if the path begins with `api-assets`, it will be assumed to already be uploaded to Magic Hour's storage, and will not be uploaded again.
+    """

magic_hour/types/params/v1_image_to_video_create_body.py

@@ -0,0 +1,101 @@
+import pydantic
+import typing
+import typing_extensions
+
+from .v1_image_to_video_create_body_assets import (
+    V1ImageToVideoCreateBodyAssets,
+    _SerializerV1ImageToVideoCreateBodyAssets,
+)
+from .v1_image_to_video_create_body_style import (
+    V1ImageToVideoCreateBodyStyle,
+    _SerializerV1ImageToVideoCreateBodyStyle,
+)
+
+
+class V1ImageToVideoCreateBody(typing_extensions.TypedDict):
+    """
+    V1ImageToVideoCreateBody
+    """
+
+    assets: typing_extensions.Required[V1ImageToVideoCreateBodyAssets]
+    """
+    Provide the assets for image-to-video.
+    """
+
+    end_seconds: typing_extensions.Required[float]
+    """
+    The total duration of the output video in seconds.
+    """
+
+    height: typing_extensions.NotRequired[typing.Optional[int]]
+    """
+    `height` is deprecated and no longer influences the output video's resolution.
+    
+    Output resolution is determined by the **minimum** of:
+    - The resolution of the input video
+    - The maximum resolution allowed by your subscription tier. See our [pricing page](https://magichour.ai/pricing) for more details.
+    
+    This field is retained only for backward compatibility and will be removed in a future release.
+    """
+
+    name: typing_extensions.NotRequired[str]
+    """
+    The name of video. This value is mainly used for your own identification of the video.
+    """
+
+    resolution: typing_extensions.NotRequired[
+        typing_extensions.Literal["1080p", "480p", "720p"]
+    ]
+    """
+    Controls the output video resolution. Defaults to `720p` if not specified.
+    
+    480p and 720p are available on Creator, Pro, or Business tiers. However, 1080p require Pro or Business tier.
+    
+    **Options:**
+    - `480p` - Supports only 5 or 10 second videos. Output: 24fps. Cost: 120 credits per 5 seconds.
+    - `720p` - Supports videos between 5-60 seconds. Output: 30fps. Cost: 300 credits per 5 seconds.
+    - `1080p` - Supports videos between 5-60 seconds. Output: 30fps. Cost: 600 credits per 5 seconds.
+    """
+
+    style: typing_extensions.NotRequired[V1ImageToVideoCreateBodyStyle]
+    """
+    Attributed used to dictate the style of the output
+    """
+
+    width: typing_extensions.NotRequired[typing.Optional[int]]
+    """
+    `width` is deprecated and no longer influences the output video's resolution.
+    
+    Output resolution is determined by the **minimum** of:
+    - The resolution of the input video
+    - The maximum resolution allowed by your subscription tier. See our [pricing page](https://magichour.ai/pricing) for more details.
+    
+    This field is retained only for backward compatibility and will be removed in a future release.
+    """
+
+
+class _SerializerV1ImageToVideoCreateBody(pydantic.BaseModel):
+    """
+    Serializer for V1ImageToVideoCreateBody handling case conversions
+    and file omissions as dictated by the API
+    """
+
+    model_config = pydantic.ConfigDict(
+        populate_by_name=True,
+    )
+
+    assets: _SerializerV1ImageToVideoCreateBodyAssets = 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)
+    resolution: typing.Optional[typing_extensions.Literal["1080p", "480p", "720p"]] = (
+        pydantic.Field(alias="resolution", default=None)
+    )
+    style: typing.Optional[_SerializerV1ImageToVideoCreateBodyStyle] = pydantic.Field(
+        alias="style", default=None
+    )
+    width: typing.Optional[int] = pydantic.Field(alias="width", default=None)

magic_hour/types/params/v1_image_to_video_create_body_assets.py

@@ -0,0 +1,33 @@
+import pydantic
+import typing_extensions
+
+
+class V1ImageToVideoCreateBodyAssets(typing_extensions.TypedDict):
+    """
+    Provide the assets for image-to-video.
+    """
+
+    image_file_path: typing_extensions.Required[str]
+    """
+    The path of the image file. This value is either
+    - a direct URL to the video file
+    - `file_path` field from the response of the [upload urls API](https://docs.magichour.ai/api-reference/files/generate-asset-upload-urls).
+    
+    Please refer to the [Input File documentation](https://docs.magichour.ai/api-reference/files/generate-asset-upload-urls#input-file) to learn more.
+    
+    """
+
+
+class _SerializerV1ImageToVideoCreateBodyAssets(pydantic.BaseModel):
+    """
+    Serializer for V1ImageToVideoCreateBodyAssets 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",
+    )