magic_hour 0.33.1__py3-none-any.whl → 0.35.0__py3-none-any.whl

magic_hour/resources/v1/video_to_video/client.py

@@ -52,26 +52,24 @@ class VideoToVideoClient:
             fps_resolution: 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: Used to determine the dimensions of the output video.
+            height: `height` is deprecated and no longer influences the output video's resolution.
 
-        * 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.
+        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.
 
-        Note: if the video's original resolution is less than the maximum, the video will not be resized.
+        This field is retained only for backward compatibility and will be removed in a future release.
+            name: The name of video. This value is mainly used for your own identification of the video.
+            width: `width` is deprecated and no longer influences the output video's resolution.
 
-        See our [pricing page](https://magichour.ai/pricing) for more details.
-            name: The name of video
-            width: Used to determine the dimensions of the output video.
+        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.
 
-        * If width is provided, height will also be required. The larger value between width and height will be used to determine the maximum output resolution while maintaining the original aspect ratio.
-        * If both height and width are omitted, the video will be resized according to your subscription's maximum resolution, while preserving aspect ratio.
-
-        Note: if the video's original resolution is less than the maximum, the video will not be resized.
-
-        See our [pricing page](https://magichour.ai/pricing) for more details.
+        This field is retained only for backward compatibility and will be removed in a future release.
             assets: 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: The end time of the input video in seconds
-            start_seconds: The start time of the input video in seconds
+            end_seconds: 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.
+            start_seconds: 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: V1VideoToVideoCreateBodyStyle
             request_options: Additional options to customize the HTTP request
 
@@ -93,15 +91,13 @@ class VideoToVideoClient:
             start_seconds=0.0,
             style={
                 "art_style": "3D Render",
-                "model": "Absolute Reality",
+                "model": "default",
                 "prompt": "string",
-                "prompt_type": "append_default",
+                "prompt_type": "default",
                 "version": "default",
             },
             fps_resolution="HALF",
-            height=960,
             name="Video To Video video",
-            width=512,
         )
         ```
         """
@@ -168,26 +164,24 @@ class AsyncVideoToVideoClient:
             fps_resolution: 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: 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.
+            height: `height` is deprecated and no longer influences the output video's resolution.
 
-        See our [pricing page](https://magichour.ai/pricing) for more details.
-            name: The name of video
-            width: Used to determine the dimensions of the output video.
+        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.
 
-        * If width is provided, height will also be required. The larger value between width and height will be used to determine the maximum output resolution while maintaining the original aspect ratio.
-        * If both height and width are omitted, the video will be resized according to your subscription's maximum resolution, while preserving aspect ratio.
+        This field is retained only for backward compatibility and will be removed in a future release.
+            name: The name of video. This value is mainly used for your own identification of the video.
+            width: `width` is deprecated and no longer influences the output video's resolution.
 
-        Note: if the video's original resolution is less than the maximum, the video will not be resized.
+        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.
 
-        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.
             assets: 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: The end time of the input video in seconds
-            start_seconds: The start time of the input video in seconds
+            end_seconds: 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.
+            start_seconds: 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: V1VideoToVideoCreateBodyStyle
             request_options: Additional options to customize the HTTP request
 
@@ -209,15 +203,13 @@ class AsyncVideoToVideoClient:
             start_seconds=0.0,
             style={
                 "art_style": "3D Render",
-                "model": "Absolute Reality",
+                "model": "default",
                 "prompt": "string",
-                "prompt_type": "append_default",
+                "prompt_type": "default",
                 "version": "default",
             },
             fps_resolution="HALF",
-            height=960,
             name="Video To Video video",
-            width=512,
         )
         ```
         """

magic_hour/types/models/v1_face_detection_create_response.py

@@ -21,5 +21,5 @@ class V1FaceDetectionCreateResponse(pydantic.BaseModel):
         alias="id",
     )
     """
-    The id of the task
+    The id of the task. Use this value in the [get face detection details API](/api-reference/files/get-face-detection-details) to get the details of the face detection task.
     """

magic_hour/types/models/v1_face_detection_get_response.py

@@ -33,7 +33,7 @@ class V1FaceDetectionGetResponse(pydantic.BaseModel):
         alias="id",
     )
     """
-    The id of the task
+    The id of the task. This value is returned by the [face detection API](/api-reference/files/face-detection#response-id).
     """
     status: typing_extensions.Literal["complete", "error", "queued", "rendering"] = (
         pydantic.Field(

magic_hour/types/models/v1_files_upload_urls_create_response.py

@@ -19,3 +19,6 @@ class V1FilesUploadUrlsCreateResponse(pydantic.BaseModel):
     items: typing.List[V1FilesUploadUrlsCreateResponseItemsItem] = pydantic.Field(
         alias="items",
     )
+    """
+    The list of upload URLs and file paths for the assets. The response array will match the order of items in the request body. Refer to the [Input Files Guide](/integration/input-files) for more details.
+    """

magic_hour/types/models/v1_video_projects_get_response.py

@@ -49,7 +49,7 @@ class V1VideoProjectsGetResponse(pydantic.BaseModel):
         alias="end_seconds",
     )
     """
-    The end time of the input video in seconds
+    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.
     """
     error: typing.Optional[V1VideoProjectsGetResponseError] = pydantic.Field(
         alias="error",
@@ -85,7 +85,7 @@ class V1VideoProjectsGetResponse(pydantic.BaseModel):
         alias="start_seconds",
     )
     """
-    The start time of the input video in seconds
+    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.
     """
     status: typing_extensions.Literal[
         "canceled", "complete", "draft", "error", "queued", "rendering"

magic_hour/types/params/v1_ai_clothes_changer_create_body.py

@@ -20,7 +20,7 @@ class V1AiClothesChangerCreateBody(typing_extensions.TypedDict):
 
     name: typing_extensions.NotRequired[str]
     """
-    The name of image
+    The name of image. This value is mainly used for your own identification of the image.
     """
 
 

magic_hour/types/params/v1_ai_clothes_changer_create_body_assets.py

@@ -9,16 +9,29 @@ class V1AiClothesChangerCreateBodyAssets(typing_extensions.TypedDict):
 
     garment_file_path: typing_extensions.Required[str]
     """
-    The image of the outfit. 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 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 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 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.
+    
     """
 
 

magic_hour/types/params/v1_ai_face_editor_create_body.py

@@ -24,7 +24,7 @@ class V1AiFaceEditorCreateBody(typing_extensions.TypedDict):
 
     name: typing_extensions.NotRequired[str]
     """
-    The name of image
+    The name of image. This value is mainly used for your own identification of the image.
     """
 
     style: typing_extensions.Required[V1AiFaceEditorCreateBodyStyle]

magic_hour/types/params/v1_ai_face_editor_create_body_assets.py

@@ -9,7 +9,12 @@ class V1AiFaceEditorCreateBodyAssets(typing_extensions.TypedDict):
 
     image_file_path: typing_extensions.Required[str]
     """
-    This is the image whose face will be edited. 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.
+    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.
+    
     """
 
 

magic_hour/types/params/v1_ai_face_editor_create_body_style.py

@@ -1,4 +1,5 @@
 import pydantic
+import typing
 import typing_extensions
 
 
@@ -7,77 +8,77 @@ class V1AiFaceEditorCreateBodyStyle(typing_extensions.TypedDict):
     Face editing parameters
     """
 
-    enhance_face: typing_extensions.Required[bool]
+    enhance_face: typing_extensions.NotRequired[bool]
     """
     Enhance face features
     """
 
-    eye_gaze_horizontal: typing_extensions.Required[float]
+    eye_gaze_horizontal: typing_extensions.NotRequired[float]
     """
     Horizontal eye gaze (-100 to 100), in increments of 5
     """
 
-    eye_gaze_vertical: typing_extensions.Required[float]
+    eye_gaze_vertical: typing_extensions.NotRequired[float]
     """
     Vertical eye gaze (-100 to 100), in increments of 5
     """
 
-    eye_open_ratio: typing_extensions.Required[float]
+    eye_open_ratio: typing_extensions.NotRequired[float]
     """
     Eye open ratio (-100 to 100), in increments of 5
     """
 
-    eyebrow_direction: typing_extensions.Required[float]
+    eyebrow_direction: typing_extensions.NotRequired[float]
     """
     Eyebrow direction (-100 to 100), in increments of 5
     """
 
-    head_pitch: typing_extensions.Required[float]
+    head_pitch: typing_extensions.NotRequired[float]
     """
     Head pitch (-100 to 100), in increments of 5
     """
 
-    head_roll: typing_extensions.Required[float]
+    head_roll: typing_extensions.NotRequired[float]
     """
     Head roll (-100 to 100), in increments of 5
     """
 
-    head_yaw: typing_extensions.Required[float]
+    head_yaw: typing_extensions.NotRequired[float]
     """
     Head yaw (-100 to 100), in increments of 5
     """
 
-    lip_open_ratio: typing_extensions.Required[float]
+    lip_open_ratio: typing_extensions.NotRequired[float]
     """
     Lip open ratio (-100 to 100), in increments of 5
     """
 
-    mouth_grim: typing_extensions.Required[float]
+    mouth_grim: typing_extensions.NotRequired[float]
     """
     Mouth grim (-100 to 100), in increments of 5
     """
 
-    mouth_position_horizontal: typing_extensions.Required[float]
+    mouth_position_horizontal: typing_extensions.NotRequired[float]
     """
     Horizontal mouth position (-100 to 100), in increments of 5
     """
 
-    mouth_position_vertical: typing_extensions.Required[float]
+    mouth_position_vertical: typing_extensions.NotRequired[float]
     """
     Vertical mouth position (-100 to 100), in increments of 5
     """
 
-    mouth_pout: typing_extensions.Required[float]
+    mouth_pout: typing_extensions.NotRequired[float]
     """
     Mouth pout (-100 to 100), in increments of 5
     """
 
-    mouth_purse: typing_extensions.Required[float]
+    mouth_purse: typing_extensions.NotRequired[float]
     """
     Mouth purse (-100 to 100), in increments of 5
     """
 
-    mouth_smile: typing_extensions.Required[float]
+    mouth_smile: typing_extensions.NotRequired[float]
     """
     Mouth smile (-100 to 100), in increments of 5
     """
@@ -93,48 +94,44 @@ class _SerializerV1AiFaceEditorCreateBodyStyle(pydantic.BaseModel):
         populate_by_name=True,
     )
 
-    enhance_face: bool = pydantic.Field(
-        alias="enhance_face",
+    enhance_face: typing.Optional[bool] = pydantic.Field(
+        alias="enhance_face", default=None
     )
-    eye_gaze_horizontal: float = pydantic.Field(
-        alias="eye_gaze_horizontal",
+    eye_gaze_horizontal: typing.Optional[float] = pydantic.Field(
+        alias="eye_gaze_horizontal", default=None
     )
-    eye_gaze_vertical: float = pydantic.Field(
-        alias="eye_gaze_vertical",
+    eye_gaze_vertical: typing.Optional[float] = pydantic.Field(
+        alias="eye_gaze_vertical", default=None
     )
-    eye_open_ratio: float = pydantic.Field(
-        alias="eye_open_ratio",
+    eye_open_ratio: typing.Optional[float] = pydantic.Field(
+        alias="eye_open_ratio", default=None
     )
-    eyebrow_direction: float = pydantic.Field(
-        alias="eyebrow_direction",
+    eyebrow_direction: typing.Optional[float] = pydantic.Field(
+        alias="eyebrow_direction", default=None
     )
-    head_pitch: float = pydantic.Field(
-        alias="head_pitch",
+    head_pitch: typing.Optional[float] = pydantic.Field(
+        alias="head_pitch", default=None
     )
-    head_roll: float = pydantic.Field(
-        alias="head_roll",
+    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
     )
-    head_yaw: float = pydantic.Field(
-        alias="head_yaw",
+    mouth_grim: typing.Optional[float] = pydantic.Field(
+        alias="mouth_grim", default=None
     )
-    lip_open_ratio: float = pydantic.Field(
-        alias="lip_open_ratio",
+    mouth_position_horizontal: typing.Optional[float] = pydantic.Field(
+        alias="mouth_position_horizontal", default=None
     )
-    mouth_grim: float = pydantic.Field(
-        alias="mouth_grim",
+    mouth_position_vertical: typing.Optional[float] = pydantic.Field(
+        alias="mouth_position_vertical", default=None
     )
-    mouth_position_horizontal: float = pydantic.Field(
-        alias="mouth_position_horizontal",
+    mouth_pout: typing.Optional[float] = pydantic.Field(
+        alias="mouth_pout", default=None
     )
-    mouth_position_vertical: float = pydantic.Field(
-        alias="mouth_position_vertical",
+    mouth_purse: typing.Optional[float] = pydantic.Field(
+        alias="mouth_purse", default=None
     )
-    mouth_pout: float = pydantic.Field(
-        alias="mouth_pout",
-    )
-    mouth_purse: float = pydantic.Field(
-        alias="mouth_purse",
-    )
-    mouth_smile: float = pydantic.Field(
-        alias="mouth_smile",
+    mouth_smile: typing.Optional[float] = pydantic.Field(
+        alias="mouth_smile", default=None
     )

magic_hour/types/params/v1_ai_gif_generator_create_body.py

@@ -15,7 +15,7 @@ class V1AiGifGeneratorCreateBody(typing_extensions.TypedDict):
 
     name: typing_extensions.NotRequired[str]
     """
-    The name of gif
+    The name of gif. This value is mainly used for your own identification of the gif.
     """
 
     style: typing_extensions.Required[V1AiGifGeneratorCreateBodyStyle]

magic_hour/types/params/v1_ai_headshot_generator_create_body.py

@@ -24,7 +24,7 @@ class V1AiHeadshotGeneratorCreateBody(typing_extensions.TypedDict):
 
     name: typing_extensions.NotRequired[str]
     """
-    The name of image
+    The name of image. This value is mainly used for your own identification of the image.
     """
 
     style: typing_extensions.NotRequired[V1AiHeadshotGeneratorCreateBodyStyle]

magic_hour/types/params/v1_ai_headshot_generator_create_body_assets.py

@@ -9,7 +9,12 @@ class V1AiHeadshotGeneratorCreateBodyAssets(typing_extensions.TypedDict):
 
     image_file_path: typing_extensions.Required[str]
     """
-    The image used to generate the headshot. This image must contain one detectable 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.
+    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.
+    
     """
 
 

magic_hour/types/params/v1_ai_headshot_generator_create_body_style.py

@@ -10,7 +10,7 @@ class V1AiHeadshotGeneratorCreateBodyStyle(typing_extensions.TypedDict):
 
     prompt: typing_extensions.NotRequired[str]
     """
-    A prompt to guide the final image.
+    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.
     """
 
 

magic_hour/types/params/v1_ai_image_editor_create_body.py

@@ -24,7 +24,7 @@ class V1AiImageEditorCreateBody(typing_extensions.TypedDict):
 
     name: typing_extensions.NotRequired[str]
     """
-    The name of image
+    The name of image. This value is mainly used for your own identification of the image.
     """
 
     style: typing_extensions.Required[V1AiImageEditorCreateBodyStyle]

magic_hour/types/params/v1_ai_image_editor_create_body_assets.py

@@ -9,7 +9,12 @@ class V1AiImageEditorCreateBodyAssets(typing_extensions.TypedDict):
 
     image_file_path: typing_extensions.Required[str]
     """
-    The image used in the edit. 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 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.
+    
     """
 
 

magic_hour/types/params/v1_ai_image_generator_create_body.py

@@ -15,19 +15,25 @@ class V1AiImageGeneratorCreateBody(typing_extensions.TypedDict):
 
     image_count: typing_extensions.Required[int]
     """
-    number to images to generate
+    Number of images to generate.
     """
 
     name: typing_extensions.NotRequired[str]
     """
-    The name of image
+    The name of image. This value is mainly used for your own identification of the image.
     """
 
     orientation: typing_extensions.Required[
         typing_extensions.Literal["landscape", "portrait", "square"]
     ]
+    """
+    The orientation of the output image(s).
+    """
 
     style: typing_extensions.Required[V1AiImageGeneratorCreateBodyStyle]
+    """
+    The art style to use for image generation.
+    """
 
 
 class _SerializerV1AiImageGeneratorCreateBody(pydantic.BaseModel):

magic_hour/types/params/v1_ai_image_generator_create_body_style.py

@@ -5,12 +5,12 @@ import typing_extensions
 
 class V1AiImageGeneratorCreateBodyStyle(typing_extensions.TypedDict):
     """
-    V1AiImageGeneratorCreateBodyStyle
+    The art style to use for image generation.
     """
 
     prompt: typing_extensions.Required[str]
     """
-    The prompt used for the image.
+    The prompt used for the image(s).
     """
 
     tool: typing_extensions.NotRequired[

magic_hour/types/params/v1_ai_image_upscaler_create_body.py

@@ -24,12 +24,14 @@ class V1AiImageUpscalerCreateBody(typing_extensions.TypedDict):
 
     name: typing_extensions.NotRequired[str]
     """
-    The name of image
+    The name of image. This value is mainly used for your own identification of the image.
     """
 
     scale_factor: typing_extensions.Required[float]
     """
-    How much to scale the image. Must be either 2 or 4
+    How much to scale the image. Must be either 2 or 4.
+                
+    Note: 4x upscale is only available on Creator, Pro, or Business tier.
     """
 
     style: typing_extensions.Required[V1AiImageUpscalerCreateBodyStyle]

magic_hour/types/params/v1_ai_image_upscaler_create_body_assets.py

@@ -9,7 +9,12 @@ class V1AiImageUpscalerCreateBodyAssets(typing_extensions.TypedDict):
 
     image_file_path: typing_extensions.Required[str]
     """
-    The image to upscale. 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 image to upscale. 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.
+    
     """
 
 

magic_hour/types/params/v1_ai_photo_editor_create_body.py

@@ -24,7 +24,7 @@ class V1AiPhotoEditorCreateBody(typing_extensions.TypedDict):
 
     name: typing_extensions.NotRequired[str]
     """
-    The name of image
+    The name of image. This value is mainly used for your own identification of the image.
     """
 
     resolution: typing_extensions.Required[int]

magic_hour/types/params/v1_ai_photo_editor_create_body_assets.py

@@ -9,7 +9,12 @@ class V1AiPhotoEditorCreateBodyAssets(typing_extensions.TypedDict):
 
     image_file_path: typing_extensions.Required[str]
     """
-    The image used to generate the output. 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 image used to generate the output. 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.
+    
     """
 
 

magic_hour/types/params/v1_ai_qr_code_generator_create_body.py

@@ -20,7 +20,7 @@ class V1AiQrCodeGeneratorCreateBody(typing_extensions.TypedDict):
 
     name: typing_extensions.NotRequired[str]
     """
-    The name of image
+    The name of image. This value is mainly used for your own identification of the image.
     """
 
     style: typing_extensions.Required[V1AiQrCodeGeneratorCreateBodyStyle]

magic_hour/types/params/v1_ai_talking_photo_create_body.py

@@ -29,7 +29,7 @@ class V1AiTalkingPhotoCreateBody(typing_extensions.TypedDict):
 
     name: typing_extensions.NotRequired[str]
     """
-    The name of image
+    The name of image. This value is mainly used for your own identification of the image.
     """
 
     start_seconds: typing_extensions.Required[float]

magic_hour/types/params/v1_ai_talking_photo_create_body_assets.py

@@ -9,12 +9,22 @@ class V1AiTalkingPhotoCreateBodyAssets(typing_extensions.TypedDict):
 
     audio_file_path: typing_extensions.Required[str]
     """
-    The audio file to sync with the 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 audio file to sync with the 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.
+    
     """
 
     image_file_path: typing_extensions.Required[str]
     """
-    The source image to animate. 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 source image to animate. 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.
+    
     """