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

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.
+    
     """
 
 

magic_hour/types/params/v1_animation_create_body.py

@@ -24,7 +24,7 @@ class V1AnimationCreateBody(typing_extensions.TypedDict):
 
     end_seconds: typing_extensions.Required[float]
     """
-    The end time of the input video in seconds
+    This value determines the duration of the output video.
     """
 
     fps: typing_extensions.Required[float]
@@ -39,7 +39,7 @@ class V1AnimationCreateBody(typing_extensions.TypedDict):
 
     name: typing_extensions.NotRequired[str]
     """
-    The name of video
+    The name of video. This value is mainly used for your own identification of the video.
     """
 
     style: typing_extensions.Required[V1AnimationCreateBodyStyle]

magic_hour/types/params/v1_animation_create_body_assets.py

@@ -10,7 +10,12 @@ class V1AnimationCreateBodyAssets(typing_extensions.TypedDict):
 
     audio_file_path: typing_extensions.NotRequired[str]
     """
-    The path of the input audio. This field is required if `audio_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.
+    The path of the input audio. This field is required if `audio_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.
+    
     """
 
     audio_source: typing_extensions.Required[
@@ -22,7 +27,12 @@ class V1AnimationCreateBodyAssets(typing_extensions.TypedDict):
 
     image_file_path: typing_extensions.NotRequired[str]
     """
-    An initial image to use a the first frame of the video. 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.
+    An initial image to use a the first frame of the video. 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.
+    
     """
 
     youtube_url: typing_extensions.NotRequired[str]

magic_hour/types/params/v1_animation_create_body_style.py

@@ -60,7 +60,7 @@ class V1AnimationCreateBodyStyle(typing_extensions.TypedDict):
         ]
     ]
     """
-    The art style of the final output video
+    The art style used to create the output video
     """
 
     art_style_custom: typing_extensions.NotRequired[str]
@@ -124,8 +124,11 @@ class V1AnimationCreateBodyStyle(typing_extensions.TypedDict):
             "Zoom Out - Audio Sync",
         ]
     ]
+    """
+    The camera effect used to create the output video
+    """
 
-    prompt: typing_extensions.Required[typing.Optional[str]]
+    prompt: typing_extensions.NotRequired[str]
     """
     The prompt used for the video. Prompt is required if `prompt_type` is `custom`. Otherwise this value is ignored
     """
@@ -135,14 +138,16 @@ class V1AnimationCreateBodyStyle(typing_extensions.TypedDict):
     ]
     """
     
-    * `custom` - use your own prompt for the video.
+    * `custom` - Use your own prompt for the video.
     * `use_lyrics` - Use the lyrics of the audio to create the prompt. If this option is selected, then `assets.audio_source` must be `file` or `youtube`.
     * `ai_choose` - Let AI write the prompt. If this option is selected, then `assets.audio_source` must be `file` or `youtube`.
     """
 
     transition_speed: typing_extensions.Required[int]
     """
-    Change determines how quickly the video's content changes across frames. Higher = more rapid transitions. Lower = more stable visual experience.
+    Change determines how quickly the video's content changes across frames. 
+    * Higher = more rapid transitions.
+    * Lower = more stable visual experience.
     """
 
 
@@ -266,9 +271,7 @@ class _SerializerV1AnimationCreateBodyStyle(pydantic.BaseModel):
     ] = pydantic.Field(
         alias="camera_effect",
     )
-    prompt: typing.Optional[str] = pydantic.Field(
-        alias="prompt",
-    )
+    prompt: typing.Optional[str] = pydantic.Field(alias="prompt", default=None)
     prompt_type: typing_extensions.Literal["ai_choose", "custom", "use_lyrics"] = (
         pydantic.Field(
             alias="prompt_type",

magic_hour/types/params/v1_auto_subtitle_generator_create_body.py

@@ -24,17 +24,17 @@ class V1AutoSubtitleGeneratorCreateBody(typing_extensions.TypedDict):
 
     end_seconds: typing_extensions.Required[float]
     """
-    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.
     """
 
     name: typing_extensions.NotRequired[str]
     """
-    The name of video
+    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
+    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[V1AutoSubtitleGeneratorCreateBodyStyle]

magic_hour/types/params/v1_auto_subtitle_generator_create_body_assets.py

@@ -9,7 +9,12 @@ class V1AutoSubtitleGeneratorCreateBodyAssets(typing_extensions.TypedDict):
 
     video_file_path: typing_extensions.Required[str]
     """
-    This is the video used to add subtitles. 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 video used to add subtitles. 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_face_detection_create_body_assets.py

@@ -9,7 +9,12 @@ class V1FaceDetectionCreateBodyAssets(typing_extensions.TypedDict):
 
     target_file_path: typing_extensions.Required[str]
     """
-    This is the image or video where the face will be detected. 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 or video where the face will be detected. 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_face_swap_create_body.py

@@ -20,7 +20,7 @@ class V1FaceSwapCreateBody(typing_extensions.TypedDict):
 
     end_seconds: typing_extensions.Required[float]
     """
-    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.
     """
 
     height: typing_extensions.NotRequired[int]
@@ -37,12 +37,12 @@ class V1FaceSwapCreateBody(typing_extensions.TypedDict):
 
     name: typing_extensions.NotRequired[str]
     """
-    The name of video
+    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
+    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.
     """
 
     width: typing_extensions.NotRequired[int]

magic_hour/types/params/v1_face_swap_create_body_assets.py

@@ -33,12 +33,22 @@ class V1FaceSwapCreateBodyAssets(typing_extensions.TypedDict):
     """
     The path of the input image with the face to be swapped.  The value is required if `face_swap_mode` is `all-faces`.
     
-    This value can be either the `file_path` field from the response of the [upload urls API](https://docs.magichour.ai/api-reference/files/generate-asset-upload-urls), or the url of the file.
+    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[

magic_hour/types/params/v1_face_swap_create_body_assets_face_mappings_item.py

@@ -9,7 +9,12 @@ class V1FaceSwapCreateBodyAssetsFaceMappingsItem(typing_extensions.TypedDict):
 
     new_face: typing_extensions.Required[str]
     """
-    The face image that will be used to replace the face in the `original_face`. This value can be either the `file_path` field from the response of the [upload urls API](https://docs.magichour.ai/api-reference/files/generate-asset-upload-urls), or the url of the file.
+    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]

magic_hour/types/params/v1_face_swap_photo_create_body.py

@@ -20,7 +20,7 @@ class V1FaceSwapPhotoCreateBody(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.
     """