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

magic_hour/types/params/v1_image_to_video_create_body_style.py

@@ -0,0 +1,53 @@
+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 `resolution` instead. For backward compatibility, 
+    * `false` maps to 720p resolution
+    * `true` maps to 1080p resolution
+    
+    This field will be removed in a future version. Use the `resolution` field to directly specify the resolution.
+    """
+
+    prompt: typing_extensions.NotRequired[str]
+    """
+    The prompt used for the video.
+    """
+
+    quality_mode: typing_extensions.NotRequired[
+        typing_extensions.Literal["quick", "studio"]
+    ]
+    """
+    DEPRECATED: Please use `resolution` field instead. For backward compatibility:
+    * `quick` maps to 720p resolution
+    * `studio` maps to 1080p resolution
+    
+    This field will be removed in a future version. Use the `resolution` field to directly to specify the resolution.
+    """
+
+
+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/types/params/v1_image_to_video_generate_body_assets.py

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

@@ -0,0 +1,100 @@
+import pydantic
+import typing
+import typing_extensions
+
+from .v1_lip_sync_create_body_assets import (
+    V1LipSyncCreateBodyAssets,
+    _SerializerV1LipSyncCreateBodyAssets,
+)
+from .v1_lip_sync_create_body_style import (
+    V1LipSyncCreateBodyStyle,
+    _SerializerV1LipSyncCreateBodyStyle,
+)
+
+
+class V1LipSyncCreateBody(typing_extensions.TypedDict):
+    """
+    V1LipSyncCreateBody
+    """
+
+    assets: typing_extensions.Required[V1LipSyncCreateBodyAssets]
+    """
+    Provide the assets for lip-sync. For video, The `video_source` field determines whether `video_file_path` or `youtube_url` field is used
+    """
+
+    end_seconds: typing_extensions.Required[float]
+    """
+    The end time of the input video in seconds. This value is used to trim the input video. The value must be greater than 0.1, and more than the start_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.
+    """
+
+    max_fps_limit: typing_extensions.NotRequired[float]
+    """
+    Defines the maximum FPS (frames per second) for the output video. If the input video's FPS is lower than this limit, the output video will retain the input FPS. This is useful for reducing unnecessary frame usage in scenarios where high FPS is not required.
+    """
+
+    name: typing_extensions.NotRequired[str]
+    """
+    The name of video. This value is mainly used for your own identification of the video.
+    """
+
+    start_seconds: typing_extensions.Required[float]
+    """
+    The start time of the input video in seconds. This value is used to trim the input video. The value must be greater than 0.
+    """
+
+    style: typing_extensions.NotRequired[V1LipSyncCreateBodyStyle]
+    """
+    Attributes 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 _SerializerV1LipSyncCreateBody(pydantic.BaseModel):
+    """
+    Serializer for V1LipSyncCreateBody handling case conversions
+    and file omissions as dictated by the API
+    """
+
+    model_config = pydantic.ConfigDict(
+        populate_by_name=True,
+    )
+
+    assets: _SerializerV1LipSyncCreateBodyAssets = pydantic.Field(
+        alias="assets",
+    )
+    end_seconds: float = pydantic.Field(
+        alias="end_seconds",
+    )
+    height: typing.Optional[int] = pydantic.Field(alias="height", default=None)
+    max_fps_limit: typing.Optional[float] = pydantic.Field(
+        alias="max_fps_limit", default=None
+    )
+    name: typing.Optional[str] = pydantic.Field(alias="name", default=None)
+    start_seconds: float = pydantic.Field(
+        alias="start_seconds",
+    )
+    style: typing.Optional[_SerializerV1LipSyncCreateBodyStyle] = pydantic.Field(
+        alias="style", default=None
+    )
+    width: typing.Optional[int] = pydantic.Field(alias="width", default=None)

magic_hour/types/params/{post_v1_lip_sync_body_assets.py → v1_lip_sync_create_body_assets.py}

@@ -3,19 +3,29 @@ import typing
 import typing_extensions
 
 
-class PostV1LipSyncBodyAssets(typing_extensions.TypedDict):
+class V1LipSyncCreateBodyAssets(typing_extensions.TypedDict):
     """
     Provide the assets for lip-sync. For video, The `video_source` field determines whether `video_file_path` or `youtube_url` field is used
     """
 
     audio_file_path: typing_extensions.Required[str]
     """
-    The path of the audio file. 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 audio 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.
+    
     """
 
     video_file_path: typing_extensions.NotRequired[str]
     """
-    The path of the input video. This field is required if `video_source` is `file`. 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.
+    Required if `video_source` is `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.
+    
     """
 
     video_source: typing_extensions.Required[
@@ -28,9 +38,9 @@ class PostV1LipSyncBodyAssets(typing_extensions.TypedDict):
     """
 
 
-class _SerializerPostV1LipSyncBodyAssets(pydantic.BaseModel):
+class _SerializerV1LipSyncCreateBodyAssets(pydantic.BaseModel):
     """
-    Serializer for PostV1LipSyncBodyAssets handling case conversions
+    Serializer for V1LipSyncCreateBodyAssets handling case conversions
     and file omissions as dictated by the API
     """
 

magic_hour/types/params/v1_lip_sync_create_body_style.py

@@ -0,0 +1,37 @@
+import pydantic
+import typing
+import typing_extensions
+
+
+class V1LipSyncCreateBodyStyle(typing_extensions.TypedDict):
+    """
+    Attributes used to dictate the style of the output
+    """
+
+    generation_mode: typing_extensions.NotRequired[
+        typing_extensions.Literal["lite", "pro", "standard"]
+    ]
+    """
+    A specific version of our lip sync system, optimized for different needs.
+    * `lite` -  Fast and affordable lip sync - best for simple videos. Costs 1 credit per frame of video.
+    * `standard` -  Natural, accurate lip sync - best for most creators. Costs 1 credit per frame of video.
+    * `pro` -  Premium fidelity with enhanced detail - best for professionals. Costs 2 credits per frame of video.
+    
+    Note: `standard` and `pro` are only available for users on Creator, Pro, and Business tiers.
+                  
+    """
+
+
+class _SerializerV1LipSyncCreateBodyStyle(pydantic.BaseModel):
+    """
+    Serializer for V1LipSyncCreateBodyStyle handling case conversions
+    and file omissions as dictated by the API
+    """
+
+    model_config = pydantic.ConfigDict(
+        populate_by_name=True,
+    )
+
+    generation_mode: typing.Optional[
+        typing_extensions.Literal["lite", "pro", "standard"]
+    ] = pydantic.Field(alias="generation_mode", default=None)

magic_hour/types/params/v1_lip_sync_generate_body_assets.py

@@ -0,0 +1,36 @@
+import pydantic
+import typing
+import typing_extensions
+
+
+class V1LipSyncGenerateBodyAssets(typing_extensions.TypedDict):
+    """
+    Provide the assets for lip-sync. For video, The `video_source` field determines whether `video_file_path` or `youtube_url` field is used
+    """
+
+    audio_file_path: typing_extensions.Required[str]
+    """
+    The path of the audio file. This value is either
+    - a direct URL to the video 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 video 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_photo_colorizer_create_body.py

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

magic_hour/types/params/v1_photo_colorizer_create_body_assets.py

@@ -0,0 +1,33 @@
+import pydantic
+import typing_extensions
+
+
+class V1PhotoColorizerCreateBodyAssets(typing_extensions.TypedDict):
+    """
+    Provide the assets for photo colorization
+    """
+
+    image_file_path: typing_extensions.Required[str]
+    """
+    The image used to generate the colorized image. 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 _SerializerV1PhotoColorizerCreateBodyAssets(pydantic.BaseModel):
+    """
+    Serializer for V1PhotoColorizerCreateBodyAssets 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_photo_colorizer_generate_body_assets.py

@@ -0,0 +1,17 @@
+import pydantic
+import typing_extensions
+
+
+class V1PhotoColorizerGenerateBodyAssets(typing_extensions.TypedDict):
+    """
+    Provide the assets for photo colorization
+    """
+
+    image_file_path: typing_extensions.Required[str]
+    """
+    The image used to generate the colorized image. 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_text_to_video_create_body.py

@@ -0,0 +1,78 @@
+import pydantic
+import typing
+import typing_extensions
+
+from .v1_text_to_video_create_body_style import (
+    V1TextToVideoCreateBodyStyle,
+    _SerializerV1TextToVideoCreateBodyStyle,
+)
+
+
+class V1TextToVideoCreateBody(typing_extensions.TypedDict):
+    """
+    V1TextToVideoCreateBody
+    """
+
+    end_seconds: typing_extensions.Required[float]
+    """
+    The total duration of the output video in seconds.
+    
+    The value must be greater than or equal to 5 seconds and less than or equal to 60 seconds.
+    
+    Note: For 480p resolution, the value must be either 5 or 10.
+    """
+
+    name: typing_extensions.NotRequired[str]
+    """
+    The name of video. This value is mainly used for your own identification of the video.
+    """
+
+    orientation: typing_extensions.Required[
+        typing_extensions.Literal["landscape", "portrait", "square"]
+    ]
+    """
+    Determines the orientation of the output 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.Required[V1TextToVideoCreateBodyStyle]
+
+
+class _SerializerV1TextToVideoCreateBody(pydantic.BaseModel):
+    """
+    Serializer for V1TextToVideoCreateBody handling case conversions
+    and file omissions as dictated by the API
+    """
+
+    model_config = pydantic.ConfigDict(
+        populate_by_name=True,
+    )
+
+    end_seconds: float = pydantic.Field(
+        alias="end_seconds",
+    )
+    name: typing.Optional[str] = pydantic.Field(alias="name", default=None)
+    orientation: typing_extensions.Literal["landscape", "portrait", "square"] = (
+        pydantic.Field(
+            alias="orientation",
+        )
+    )
+    resolution: typing.Optional[typing_extensions.Literal["1080p", "480p", "720p"]] = (
+        pydantic.Field(alias="resolution", default=None)
+    )
+    style: _SerializerV1TextToVideoCreateBodyStyle = pydantic.Field(
+        alias="style",
+    )

magic_hour/types/params/v1_text_to_video_create_body_style.py

@@ -0,0 +1,43 @@
+import pydantic
+import typing
+import typing_extensions
+
+
+class V1TextToVideoCreateBodyStyle(typing_extensions.TypedDict):
+    """
+    V1TextToVideoCreateBodyStyle
+    """
+
+    prompt: typing_extensions.Required[str]
+    """
+    The prompt used for the video.
+    """
+
+    quality_mode: typing_extensions.NotRequired[
+        typing_extensions.Literal["quick", "studio"]
+    ]
+    """
+    DEPRECATED: Please use `resolution` field instead. For backward compatibility:
+    * `quick` maps to 720p resolution
+    * `studio` maps to 1080p resolution
+    
+    This field will be removed in a future version. Use the `resolution` field to directly to specify the resolution.
+    """
+
+
+class _SerializerV1TextToVideoCreateBodyStyle(pydantic.BaseModel):
+    """
+    Serializer for V1TextToVideoCreateBodyStyle handling case conversions
+    and file omissions as dictated by the API
+    """
+
+    model_config = pydantic.ConfigDict(
+        populate_by_name=True,
+    )
+
+    prompt: str = pydantic.Field(
+        alias="prompt",
+    )
+    quality_mode: typing.Optional[typing_extensions.Literal["quick", "studio"]] = (
+        pydantic.Field(alias="quality_mode", default=None)
+    )

magic_hour/types/params/v1_video_to_video_create_body.py

@@ -0,0 +1,101 @@
+import pydantic
+import typing
+import typing_extensions
+
+from .v1_video_to_video_create_body_assets import (
+    V1VideoToVideoCreateBodyAssets,
+    _SerializerV1VideoToVideoCreateBodyAssets,
+)
+from .v1_video_to_video_create_body_style import (
+    V1VideoToVideoCreateBodyStyle,
+    _SerializerV1VideoToVideoCreateBodyStyle,
+)
+
+
+class V1VideoToVideoCreateBody(typing_extensions.TypedDict):
+    """
+    V1VideoToVideoCreateBody
+    """
+
+    assets: typing_extensions.Required[V1VideoToVideoCreateBodyAssets]
+    """
+    Provide the assets for video-to-video. 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. This value is used to trim the input video. The value must be greater than 0.1, and more than the start_seconds.
+    """
+
+    fps_resolution: typing_extensions.NotRequired[
+        typing_extensions.Literal["FULL", "HALF"]
+    ]
+    """
+    Determines whether the resulting video will have the same frame per second as the original video, or half.
+    * `FULL` - the result video will have the same FPS as the input video
+    * `HALF` - the result video will have half the FPS as the input video
+    """
+
+    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.
+    """
+
+    start_seconds: typing_extensions.Required[float]
+    """
+    The start time of the input video in seconds. This value is used to trim the input video. The value must be greater than 0.
+    """
+
+    style: typing_extensions.Required[V1VideoToVideoCreateBodyStyle]
+
+    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 _SerializerV1VideoToVideoCreateBody(pydantic.BaseModel):
+    """
+    Serializer for V1VideoToVideoCreateBody handling case conversions
+    and file omissions as dictated by the API
+    """
+
+    model_config = pydantic.ConfigDict(
+        populate_by_name=True,
+    )
+
+    assets: _SerializerV1VideoToVideoCreateBodyAssets = pydantic.Field(
+        alias="assets",
+    )
+    end_seconds: float = pydantic.Field(
+        alias="end_seconds",
+    )
+    fps_resolution: typing.Optional[typing_extensions.Literal["FULL", "HALF"]] = (
+        pydantic.Field(alias="fps_resolution", default=None)
+    )
+    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",
+    )
+    style: _SerializerV1VideoToVideoCreateBodyStyle = pydantic.Field(
+        alias="style",
+    )
+    width: typing.Optional[int] = pydantic.Field(alias="width", default=None)

magic_hour/types/params/{post_v1_video_to_video_body_assets.py → v1_video_to_video_create_body_assets.py}

@@ -3,14 +3,19 @@ import typing
 import typing_extensions
 
 
-class PostV1VideoToVideoBodyAssets(typing_extensions.TypedDict):
+class V1VideoToVideoCreateBodyAssets(typing_extensions.TypedDict):
     """
     Provide the assets for video-to-video. For video, The `video_source` field determines whether `video_file_path` or `youtube_url` field is used
     """
 
     video_file_path: typing_extensions.NotRequired[str]
     """
-    The path of the input video. This field is required if `video_source` is `file`. 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.
+    Required if `video_source` is `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.
+    
     """
 
     video_source: typing_extensions.Required[
@@ -23,9 +28,9 @@ class PostV1VideoToVideoBodyAssets(typing_extensions.TypedDict):
     """
 
 
-class _SerializerPostV1VideoToVideoBodyAssets(pydantic.BaseModel):
+class _SerializerV1VideoToVideoCreateBodyAssets(pydantic.BaseModel):
     """
-    Serializer for PostV1VideoToVideoBodyAssets handling case conversions
+    Serializer for V1VideoToVideoCreateBodyAssets handling case conversions
     and file omissions as dictated by the API
     """