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

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,41 +20,39 @@ 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]
+    height: typing_extensions.NotRequired[typing.Optional[int]]
     """
-    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.
+    `height` 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.
     """
 
     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]
+    width: typing_extensions.NotRequired[typing.Optional[int]]
     """
-    Used to determine the dimensions of the output video. 
-      
-    * 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.
+    `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.
     """
 
 

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

magic_hour/types/params/v1_face_swap_photo_create_body_assets.py

@@ -33,12 +33,22 @@ class V1FaceSwapPhotoCreateBodyAssets(typing_extensions.TypedDict):
     """
     This is the image from which the face is extracted. 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.
+    
     """
 
     target_file_path: typing_extensions.Required[str]
     """
-    This is the image where the face from the source image will be placed. 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 where the face from the source image will be placed. This value is either
+    - a direct URL to the video file
+    - `file_path` field from the response of the [upload urls API](https://docs.magichour.ai/api-reference/files/generate-asset-upload-urls).
+    
+    Please refer to the [Input File documentation](https://docs.magichour.ai/api-reference/files/generate-asset-upload-urls#input-file) to learn more.
+    
     """
 
 

magic_hour/types/params/v1_face_swap_photo_create_body_assets_face_mappings_item.py

@@ -9,7 +9,12 @@ class V1FaceSwapPhotoCreateBodyAssetsFaceMappingsItem(typing_extensions.TypedDic
 
     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_files_upload_urls_create_body.py

@@ -14,6 +14,9 @@ class V1FilesUploadUrlsCreateBody(typing_extensions.TypedDict):
     """
 
     items: typing_extensions.Required[typing.List[V1FilesUploadUrlsCreateBodyItemsItem]]
+    """
+    The list of assets to upload. The response array will match the order of items in the request body.
+    """
 
 
 class _SerializerV1FilesUploadUrlsCreateBody(pydantic.BaseModel):

magic_hour/types/params/v1_files_upload_urls_create_body_items_item.py

@@ -9,14 +9,14 @@ class V1FilesUploadUrlsCreateBodyItemsItem(typing_extensions.TypedDict):
 
     extension: typing_extensions.Required[str]
     """
-    the extension of the file to upload. Do not include the dot (.) before the extension.
+    The extension of the file to upload. Do not include the dot (.) before the extension. Possible extensions are mp4,m4v,mov,webm,mp3,mpeg,wav,aac,aiff,flac,png,jpg,jpeg,webp,avif,jp2,tiff,bmp
     """
 
     type_: typing_extensions.Required[
         typing_extensions.Literal["audio", "image", "video"]
     ]
     """
-    The type of asset to upload
+    The type of asset to upload. Possible types are video, audio, image
     """
 
 

magic_hour/types/params/v1_image_background_remover_create_body.py

@@ -20,7 +20,7 @@ class V1ImageBackgroundRemoverCreateBody(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_image_background_remover_create_body_assets.py

@@ -12,12 +12,22 @@ class V1ImageBackgroundRemoverCreateBodyAssets(typing_extensions.TypedDict):
     """
     The image used as the new background for the image_file_path. This image will be resized to match the image in image_file_path. Please make sure the resolution between the images are similar.
     
-    This value 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.
+    
     """
 
     image_file_path: typing_extensions.Required[str]
     """
-    The image to remove the background. 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 remove the background. This value is either
+    - a direct URL to the video file
+    - `file_path` field from the response of the [upload urls API](https://docs.magichour.ai/api-reference/files/generate-asset-upload-urls).
+    
+    Please refer to the [Input File documentation](https://docs.magichour.ai/api-reference/files/generate-asset-upload-urls#input-file) to learn more.
+    
     """
 
 

magic_hour/types/params/v1_image_to_video_create_body.py

@@ -27,16 +27,20 @@ class V1ImageToVideoCreateBody(typing_extensions.TypedDict):
     The total duration of the output video in seconds.
     """
 
-    height: typing_extensions.NotRequired[int]
+    height: typing_extensions.NotRequired[typing.Optional[int]]
     """
-    This field does not affect the output video's resolution. The video's orientation will match that of the input image.
+    `height` is deprecated and no longer influences the output video's resolution.
     
-    It is retained solely for backward compatibility and will be deprecated in the future.
+    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
+    The name of video. This value is mainly used for your own identification of the video.
     """
 
     resolution: typing_extensions.NotRequired[
@@ -45,10 +49,12 @@ class V1ImageToVideoCreateBody(typing_extensions.TypedDict):
     """
     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. **Requires** `pro` or `business` tier.
+    - `1080p` - Supports videos between 5-60 seconds. Output: 30fps. Cost: 600 credits per 5 seconds.
     """
 
     style: typing_extensions.NotRequired[V1ImageToVideoCreateBodyStyle]
@@ -56,11 +62,15 @@ class V1ImageToVideoCreateBody(typing_extensions.TypedDict):
     Attributed used to dictate the style of the output
     """
 
-    width: typing_extensions.NotRequired[int]
+    width: typing_extensions.NotRequired[typing.Optional[int]]
     """
-    This field does not affect the output video's resolution. The video's orientation will match that of the input image.
+    `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.
     
-    It is retained solely for backward compatibility and will be deprecated in the future.
+    This field is retained only for backward compatibility and will be removed in a future release.
     """
 
 

magic_hour/types/params/v1_image_to_video_create_body_assets.py

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

magic_hour/types/params/v1_lip_sync_create_body.py

@@ -20,19 +20,18 @@ class V1LipSyncCreateBody(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]
+    height: typing_extensions.NotRequired[typing.Optional[int]]
     """
-    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.
+    `height` 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.
     """
 
     max_fps_limit: typing_extensions.NotRequired[float]
@@ -42,24 +41,23 @@ class V1LipSyncCreateBody(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]
+    width: typing_extensions.NotRequired[typing.Optional[int]]
     """
-    Used to determine the dimensions of the output video. 
-      
-    * 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.
+    `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.
     """
 
 

magic_hour/types/params/v1_lip_sync_create_body_assets.py

@@ -10,12 +10,22 @@ class V1LipSyncCreateBodyAssets(typing_extensions.TypedDict):
 
     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[

magic_hour/types/params/v1_photo_colorizer_create_body.py

@@ -20,7 +20,7 @@ class V1PhotoColorizerCreateBody(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_photo_colorizer_create_body_assets.py

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

magic_hour/types/params/v1_text_to_video_create_body.py

@@ -16,11 +16,15 @@ class V1TextToVideoCreateBody(typing_extensions.TypedDict):
     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
+    The name of video. This value is mainly used for your own identification of the video.
     """
 
     orientation: typing_extensions.Required[
@@ -36,10 +40,12 @@ class V1TextToVideoCreateBody(typing_extensions.TypedDict):
     """
     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. **Requires** `pro` or `business` tier.
+    - `1080p` - Supports videos between 5-60 seconds. Output: 30fps. Cost: 600 credits per 5 seconds.
     """
 
     style: typing_extensions.Required[V1TextToVideoCreateBodyStyle]