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

magic_hour/types/params/v1_ai_clothes_changer_create_body_assets.py

@@ -0,0 +1,58 @@
+import pydantic
+import typing_extensions
+
+
+class V1AiClothesChangerCreateBodyAssets(typing_extensions.TypedDict):
+    """
+    Provide the assets for clothes changer
+    """
+
+    garment_file_path: typing_extensions.Required[str]
+    """
+    The image of the outfit. 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.
+    
+    """
+
+    garment_type: typing_extensions.Required[
+        typing_extensions.Literal["dresses", "lower_body", "upper_body"]
+    ]
+    """
+    The type of the outfit.
+    """
+
+    person_file_path: typing_extensions.Required[str]
+    """
+    The image with the person. 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 _SerializerV1AiClothesChangerCreateBodyAssets(pydantic.BaseModel):
+    """
+    Serializer for V1AiClothesChangerCreateBodyAssets handling case conversions
+    and file omissions as dictated by the API
+    """
+
+    model_config = pydantic.ConfigDict(
+        populate_by_name=True,
+    )
+
+    garment_file_path: str = pydantic.Field(
+        alias="garment_file_path",
+    )
+    garment_type: typing_extensions.Literal["dresses", "lower_body", "upper_body"] = (
+        pydantic.Field(
+            alias="garment_type",
+        )
+    )
+    person_file_path: str = pydantic.Field(
+        alias="person_file_path",
+    )

magic_hour/types/params/v1_ai_clothes_changer_generate_body_assets.py

@@ -0,0 +1,33 @@
+import pydantic
+import typing_extensions
+
+
+class V1AiClothesChangerGenerateBodyAssets(typing_extensions.TypedDict):
+    """
+    Provide the assets for clothes changer
+    """
+
+    garment_file_path: typing_extensions.Required[str]
+    """
+    The image of the outfit. 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.
+    """
+
+    garment_type: typing_extensions.Required[
+        typing_extensions.Literal["dresses", "lower_body", "upper_body"]
+    ]
+    """
+    The type of the outfit.
+    """
+
+    person_file_path: typing_extensions.Required[str]
+    """
+    The image with the person. 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_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. This value is mainly used for your own identification of the 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/types/params/v1_ai_face_editor_create_body_assets.py

@@ -0,0 +1,33 @@
+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 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 _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",
+    )

magic_hour/types/params/v1_ai_face_editor_create_body_style.py

@@ -0,0 +1,137 @@
+import pydantic
+import typing
+import typing_extensions
+
+
+class V1AiFaceEditorCreateBodyStyle(typing_extensions.TypedDict):
+    """
+    Face editing parameters
+    """
+
+    enhance_face: typing_extensions.NotRequired[bool]
+    """
+    Enhance face features
+    """
+
+    eye_gaze_horizontal: typing_extensions.NotRequired[float]
+    """
+    Horizontal eye gaze (-100 to 100), in increments of 5
+    """
+
+    eye_gaze_vertical: typing_extensions.NotRequired[float]
+    """
+    Vertical eye gaze (-100 to 100), in increments of 5
+    """
+
+    eye_open_ratio: typing_extensions.NotRequired[float]
+    """
+    Eye open ratio (-100 to 100), in increments of 5
+    """
+
+    eyebrow_direction: typing_extensions.NotRequired[float]
+    """
+    Eyebrow direction (-100 to 100), in increments of 5
+    """
+
+    head_pitch: typing_extensions.NotRequired[float]
+    """
+    Head pitch (-100 to 100), in increments of 5
+    """
+
+    head_roll: typing_extensions.NotRequired[float]
+    """
+    Head roll (-100 to 100), in increments of 5
+    """
+
+    head_yaw: typing_extensions.NotRequired[float]
+    """
+    Head yaw (-100 to 100), in increments of 5
+    """
+
+    lip_open_ratio: typing_extensions.NotRequired[float]
+    """
+    Lip open ratio (-100 to 100), in increments of 5
+    """
+
+    mouth_grim: typing_extensions.NotRequired[float]
+    """
+    Mouth grim (-100 to 100), in increments of 5
+    """
+
+    mouth_position_horizontal: typing_extensions.NotRequired[float]
+    """
+    Horizontal mouth position (-100 to 100), in increments of 5
+    """
+
+    mouth_position_vertical: typing_extensions.NotRequired[float]
+    """
+    Vertical mouth position (-100 to 100), in increments of 5
+    """
+
+    mouth_pout: typing_extensions.NotRequired[float]
+    """
+    Mouth pout (-100 to 100), in increments of 5
+    """
+
+    mouth_purse: typing_extensions.NotRequired[float]
+    """
+    Mouth purse (-100 to 100), in increments of 5
+    """
+
+    mouth_smile: typing_extensions.NotRequired[float]
+    """
+    Mouth smile (-100 to 100), in increments of 5
+    """
+
+
+class _SerializerV1AiFaceEditorCreateBodyStyle(pydantic.BaseModel):
+    """
+    Serializer for V1AiFaceEditorCreateBodyStyle handling case conversions
+    and file omissions as dictated by the API
+    """
+
+    model_config = pydantic.ConfigDict(
+        populate_by_name=True,
+    )
+
+    enhance_face: typing.Optional[bool] = pydantic.Field(
+        alias="enhance_face", default=None
+    )
+    eye_gaze_horizontal: typing.Optional[float] = pydantic.Field(
+        alias="eye_gaze_horizontal", default=None
+    )
+    eye_gaze_vertical: typing.Optional[float] = pydantic.Field(
+        alias="eye_gaze_vertical", default=None
+    )
+    eye_open_ratio: typing.Optional[float] = pydantic.Field(
+        alias="eye_open_ratio", default=None
+    )
+    eyebrow_direction: typing.Optional[float] = pydantic.Field(
+        alias="eyebrow_direction", default=None
+    )
+    head_pitch: typing.Optional[float] = pydantic.Field(
+        alias="head_pitch", default=None
+    )
+    head_roll: typing.Optional[float] = pydantic.Field(alias="head_roll", default=None)
+    head_yaw: typing.Optional[float] = pydantic.Field(alias="head_yaw", default=None)
+    lip_open_ratio: typing.Optional[float] = pydantic.Field(
+        alias="lip_open_ratio", default=None
+    )
+    mouth_grim: typing.Optional[float] = pydantic.Field(
+        alias="mouth_grim", default=None
+    )
+    mouth_position_horizontal: typing.Optional[float] = pydantic.Field(
+        alias="mouth_position_horizontal", default=None
+    )
+    mouth_position_vertical: typing.Optional[float] = pydantic.Field(
+        alias="mouth_position_vertical", default=None
+    )
+    mouth_pout: typing.Optional[float] = pydantic.Field(
+        alias="mouth_pout", default=None
+    )
+    mouth_purse: typing.Optional[float] = pydantic.Field(
+        alias="mouth_purse", default=None
+    )
+    mouth_smile: typing.Optional[float] = pydantic.Field(
+        alias="mouth_smile", default=None
+    )

magic_hour/types/params/v1_ai_face_editor_generate_body_assets.py

@@ -0,0 +1,17 @@
+import pydantic
+import typing_extensions
+
+
+class V1AiFaceEditorGenerateBodyAssets(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 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_ai_gif_generator_create_body.py

@@ -0,0 +1,47 @@
+import pydantic
+import typing
+import typing_extensions
+
+from .v1_ai_gif_generator_create_body_style import (
+    V1AiGifGeneratorCreateBodyStyle,
+    _SerializerV1AiGifGeneratorCreateBodyStyle,
+)
+
+
+class V1AiGifGeneratorCreateBody(typing_extensions.TypedDict):
+    """
+    V1AiGifGeneratorCreateBody
+    """
+
+    name: typing_extensions.NotRequired[str]
+    """
+    The name of gif. This value is mainly used for your own identification of the gif.
+    """
+
+    output_format: typing_extensions.NotRequired[
+        typing_extensions.Literal["gif", "mp4", "webm"]
+    ]
+    """
+    The output file format for the generated animation.
+    """
+
+    style: typing_extensions.Required[V1AiGifGeneratorCreateBodyStyle]
+
+
+class _SerializerV1AiGifGeneratorCreateBody(pydantic.BaseModel):
+    """
+    Serializer for V1AiGifGeneratorCreateBody handling case conversions
+    and file omissions as dictated by the API
+    """
+
+    model_config = pydantic.ConfigDict(
+        populate_by_name=True,
+    )
+
+    name: typing.Optional[str] = pydantic.Field(alias="name", default=None)
+    output_format: typing.Optional[typing_extensions.Literal["gif", "mp4", "webm"]] = (
+        pydantic.Field(alias="output_format", default=None)
+    )
+    style: _SerializerV1AiGifGeneratorCreateBodyStyle = pydantic.Field(
+        alias="style",
+    )

magic_hour/types/params/{post_v1_ai_image_generator_body_style.py → v1_ai_gif_generator_create_body_style.py}

@@ -2,20 +2,20 @@ import pydantic
 import typing_extensions
 
 
-class PostV1AiImageGeneratorBodyStyle(typing_extensions.TypedDict):
+class V1AiGifGeneratorCreateBodyStyle(typing_extensions.TypedDict):
     """
-    PostV1AiImageGeneratorBodyStyle
+    V1AiGifGeneratorCreateBodyStyle
     """
 
     prompt: typing_extensions.Required[str]
     """
-    The prompt used for the image.
+    The prompt used for the GIF.
     """
 
 
-class _SerializerPostV1AiImageGeneratorBodyStyle(pydantic.BaseModel):
+class _SerializerV1AiGifGeneratorCreateBodyStyle(pydantic.BaseModel):
     """
-    Serializer for PostV1AiImageGeneratorBodyStyle handling case conversions
+    Serializer for V1AiGifGeneratorCreateBodyStyle handling case conversions
     and file omissions as dictated by the API
     """
 

magic_hour/types/params/v1_ai_headshot_generator_create_body.py

@@ -0,0 +1,49 @@
+import pydantic
+import typing
+import typing_extensions
+
+from .v1_ai_headshot_generator_create_body_assets import (
+    V1AiHeadshotGeneratorCreateBodyAssets,
+    _SerializerV1AiHeadshotGeneratorCreateBodyAssets,
+)
+from .v1_ai_headshot_generator_create_body_style import (
+    V1AiHeadshotGeneratorCreateBodyStyle,
+    _SerializerV1AiHeadshotGeneratorCreateBodyStyle,
+)
+
+
+class V1AiHeadshotGeneratorCreateBody(typing_extensions.TypedDict):
+    """
+    V1AiHeadshotGeneratorCreateBody
+    """
+
+    assets: typing_extensions.Required[V1AiHeadshotGeneratorCreateBodyAssets]
+    """
+    Provide the assets for headshot photo
+    """
+
+    name: typing_extensions.NotRequired[str]
+    """
+    The name of image. This value is mainly used for your own identification of the image.
+    """
+
+    style: typing_extensions.NotRequired[V1AiHeadshotGeneratorCreateBodyStyle]
+
+
+class _SerializerV1AiHeadshotGeneratorCreateBody(pydantic.BaseModel):
+    """
+    Serializer for V1AiHeadshotGeneratorCreateBody handling case conversions
+    and file omissions as dictated by the API
+    """
+
+    model_config = pydantic.ConfigDict(
+        populate_by_name=True,
+    )
+
+    assets: _SerializerV1AiHeadshotGeneratorCreateBodyAssets = pydantic.Field(
+        alias="assets",
+    )
+    name: typing.Optional[str] = pydantic.Field(alias="name", default=None)
+    style: typing.Optional[_SerializerV1AiHeadshotGeneratorCreateBodyStyle] = (
+        pydantic.Field(alias="style", default=None)
+    )

magic_hour/types/params/v1_ai_headshot_generator_create_body_assets.py

@@ -0,0 +1,33 @@
+import pydantic
+import typing_extensions
+
+
+class V1AiHeadshotGeneratorCreateBodyAssets(typing_extensions.TypedDict):
+    """
+    Provide the assets for headshot photo
+    """
+
+    image_file_path: typing_extensions.Required[str]
+    """
+    The image used to generate the headshot. This image must contain one detectable 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.
+    
+    """
+
+
+class _SerializerV1AiHeadshotGeneratorCreateBodyAssets(pydantic.BaseModel):
+    """
+    Serializer for V1AiHeadshotGeneratorCreateBodyAssets 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",
+    )

magic_hour/types/params/v1_ai_headshot_generator_create_body_style.py

@@ -0,0 +1,27 @@
+import pydantic
+import typing
+import typing_extensions
+
+
+class V1AiHeadshotGeneratorCreateBodyStyle(typing_extensions.TypedDict):
+    """
+    V1AiHeadshotGeneratorCreateBodyStyle
+    """
+
+    prompt: typing_extensions.NotRequired[str]
+    """
+    Prompt used to guide the style of your headshot. We recommend omitting the prompt unless you want to customize your headshot. You can visit [AI headshot generator](https://magichour.ai/create/ai-headshot-generator) to view an example of a good prompt used for our 'Professional' style.
+    """
+
+
+class _SerializerV1AiHeadshotGeneratorCreateBodyStyle(pydantic.BaseModel):
+    """
+    Serializer for V1AiHeadshotGeneratorCreateBodyStyle handling case conversions
+    and file omissions as dictated by the API
+    """
+
+    model_config = pydantic.ConfigDict(
+        populate_by_name=True,
+    )
+
+    prompt: typing.Optional[str] = pydantic.Field(alias="prompt", default=None)

magic_hour/types/params/v1_ai_headshot_generator_generate_body_assets.py

@@ -0,0 +1,17 @@
+import pydantic
+import typing_extensions
+
+
+class V1AiHeadshotGeneratorGenerateBodyAssets(typing_extensions.TypedDict):
+    """
+    Provide the assets for headshot photo
+    """
+
+    image_file_path: typing_extensions.Required[str]
+    """
+    The image used to generate the headshot. This image must contain one detectable 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.
+    """

magic_hour/types/params/v1_ai_image_editor_create_body.py

@@ -0,0 +1,49 @@
+import pydantic
+import typing
+import typing_extensions
+
+from .v1_ai_image_editor_create_body_assets import (
+    V1AiImageEditorCreateBodyAssets,
+    _SerializerV1AiImageEditorCreateBodyAssets,
+)
+from .v1_ai_image_editor_create_body_style import (
+    V1AiImageEditorCreateBodyStyle,
+    _SerializerV1AiImageEditorCreateBodyStyle,
+)
+
+
+class V1AiImageEditorCreateBody(typing_extensions.TypedDict):
+    """
+    V1AiImageEditorCreateBody
+    """
+
+    assets: typing_extensions.Required[V1AiImageEditorCreateBodyAssets]
+    """
+    Provide the assets for image edit
+    """
+
+    name: typing_extensions.NotRequired[str]
+    """
+    The name of image. This value is mainly used for your own identification of the image.
+    """
+
+    style: typing_extensions.Required[V1AiImageEditorCreateBodyStyle]
+
+
+class _SerializerV1AiImageEditorCreateBody(pydantic.BaseModel):
+    """
+    Serializer for V1AiImageEditorCreateBody handling case conversions
+    and file omissions as dictated by the API
+    """
+
+    model_config = pydantic.ConfigDict(
+        populate_by_name=True,
+    )
+
+    assets: _SerializerV1AiImageEditorCreateBodyAssets = pydantic.Field(
+        alias="assets",
+    )
+    name: typing.Optional[str] = pydantic.Field(alias="name", default=None)
+    style: _SerializerV1AiImageEditorCreateBodyStyle = pydantic.Field(
+        alias="style",
+    )

magic_hour/types/params/v1_ai_image_editor_create_body_assets.py

@@ -0,0 +1,47 @@
+import pydantic
+import typing
+import typing_extensions
+
+
+class V1AiImageEditorCreateBodyAssets(typing_extensions.TypedDict):
+    """
+    Provide the assets for image edit
+    """
+
+    image_file_path: typing_extensions.NotRequired[str]
+    """
+    Deprecated: Please use `image_file_paths` instead as edits with multiple images are now supported. The image used in the edit. 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_paths: typing_extensions.NotRequired[typing.List[str]]
+    """
+    The image(s) used in the edit, maximum of 10 images. 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 _SerializerV1AiImageEditorCreateBodyAssets(pydantic.BaseModel):
+    """
+    Serializer for V1AiImageEditorCreateBodyAssets handling case conversions
+    and file omissions as dictated by the API
+    """
+
+    model_config = pydantic.ConfigDict(
+        populate_by_name=True,
+    )
+
+    image_file_path: typing.Optional[str] = pydantic.Field(
+        alias="image_file_path", default=None
+    )
+    image_file_paths: typing.Optional[typing.List[str]] = pydantic.Field(
+        alias="image_file_paths", default=None
+    )

magic_hour/types/params/v1_ai_image_editor_create_body_style.py

@@ -0,0 +1,41 @@
+import pydantic
+import typing
+import typing_extensions
+
+
+class V1AiImageEditorCreateBodyStyle(typing_extensions.TypedDict):
+    """
+    V1AiImageEditorCreateBodyStyle
+    """
+
+    model: typing_extensions.NotRequired[
+        typing_extensions.Literal["Nano Banana", "Seedream", "default"]
+    ]
+    """
+    The AI model to use for image editing. * `Nano Banana` - Precise, realistic edits with consistent results
+    * `Seedream` - Creative, imaginative images with artistic freedom
+    * `default` - Use the model we recommend, which will change over time. This is recommended unless you need a specific model. This is the default behavior.
+    """
+
+    prompt: typing_extensions.Required[str]
+    """
+    The prompt used to edit the image.
+    """
+
+
+class _SerializerV1AiImageEditorCreateBodyStyle(pydantic.BaseModel):
+    """
+    Serializer for V1AiImageEditorCreateBodyStyle handling case conversions
+    and file omissions as dictated by the API
+    """
+
+    model_config = pydantic.ConfigDict(
+        populate_by_name=True,
+    )
+
+    model: typing.Optional[
+        typing_extensions.Literal["Nano Banana", "Seedream", "default"]
+    ] = pydantic.Field(alias="model", default=None)
+    prompt: str = pydantic.Field(
+        alias="prompt",
+    )