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

magic_hour/resources/v1/lip_sync/client.py

@@ -55,7 +55,7 @@ class LipSyncClient:
 
         See our [pricing page](https://magichour.ai/pricing) for more details.
             max_fps_limit: 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: The name of video
+            name: The name of video. This value is mainly used for your own identification of the video.
             width: 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.
@@ -65,8 +65,8 @@ class LipSyncClient:
 
         See our [pricing page](https://magichour.ai/pricing) for more details.
             assets: 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: 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.
             request_options: Additional options to customize the HTTP request
 
         Returns:
@@ -159,7 +159,7 @@ class AsyncLipSyncClient:
 
         See our [pricing page](https://magichour.ai/pricing) for more details.
             max_fps_limit: 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: The name of video
+            name: The name of video. This value is mainly used for your own identification of the video.
             width: 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.
@@ -169,8 +169,8 @@ class AsyncLipSyncClient:
 
         See our [pricing page](https://magichour.ai/pricing) for more details.
             assets: 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: 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.
             request_options: Additional options to customize the HTTP request
 
         Returns:

magic_hour/resources/v1/photo_colorizer/README.md

@@ -10,7 +10,7 @@ Colorize image. Each image costs 5 credits.
 | Parameter | Required | Description | Example |
 |-----------|:--------:|-------------|--------|
 | `assets` | ✓ | Provide the assets for photo colorization | `{"image_file_path": "api-assets/id/1234.png"}` |
-| `name` | ✗ | The name of image | `"Photo Colorizer image"` |
+| `name` | ✗ | The name of image. This value is mainly used for your own identification of the image. | `"Photo Colorizer image"` |
 
 #### Synchronous Client
 
@@ -44,4 +44,4 @@ res = await client.v1.photo_colorizer.create(
 [V1PhotoColorizerCreateResponse](/magic_hour/types/models/v1_photo_colorizer_create_response.py)
 
 ##### Example
-`{"credits_charged": 5, "frame_cost": 5, "id": "clx7uu86w0a5qp55yxz315r6r"}`
+`{"credits_charged": 5, "frame_cost": 5, "id": "cuid-example"}`

magic_hour/resources/v1/photo_colorizer/client.py

@@ -32,7 +32,7 @@ class PhotoColorizerClient:
         POST /v1/photo-colorizer
 
         Args:
-            name: The name of image
+            name: The name of image. This value is mainly used for your own identification of the image.
             assets: Provide the assets for photo colorization
             request_options: Additional options to customize the HTTP request
 
@@ -86,7 +86,7 @@ class AsyncPhotoColorizerClient:
         POST /v1/photo-colorizer
 
         Args:
-            name: The name of image
+            name: The name of image. This value is mainly used for your own identification of the image.
             assets: Provide the assets for photo colorization
             request_options: Additional options to customize the HTTP request
 

magic_hour/resources/v1/text_to_video/README.md

@@ -12,11 +12,11 @@ Get more information about this mode at our [product page](https://magichour.ai/
 
 | Parameter | Required | Description | Example |
 |-----------|:--------:|-------------|--------|
-| `end_seconds` | ✓ | The total duration of the output video in seconds. | `5.0` |
+| `end_seconds` | ✓ | 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. | `5.0` |
 | `orientation` | ✓ | Determines the orientation of the output video | `"landscape"` |
 | `style` | ✓ |  | `{"prompt": "a dog running"}` |
-| `name` | ✗ | The name of video | `"Text To Video video"` |
-| `resolution` | ✗ | Controls the output video resolution. Defaults to `720p` if not specified.  **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"` |
+| `name` | ✗ | The name of video. This value is mainly used for your own identification of the video. | `"Text To Video video"` |
+| `resolution` | ✗ | 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. | `"720p"` |
 
 #### Synchronous Client
 
@@ -30,6 +30,7 @@ res = client.v1.text_to_video.create(
     orientation="landscape",
     style={"prompt": "a dog running"},
     name="Text To Video video",
+    resolution="720p",
 )
 
 ```
@@ -46,6 +47,7 @@ res = await client.v1.text_to_video.create(
     orientation="landscape",
     style={"prompt": "a dog running"},
     name="Text To Video video",
+    resolution="720p",
 )
 
 ```
@@ -56,4 +58,4 @@ res = await client.v1.text_to_video.create(
 [V1TextToVideoCreateResponse](/magic_hour/types/models/v1_text_to_video_create_response.py)
 
 ##### Example
-`{"credits_charged": 450, "estimated_frame_cost": 450, "id": "clx7uu86w0a5qp55yxz315r6r"}`
+`{"credits_charged": 450, "estimated_frame_cost": 450, "id": "cuid-example"}`

magic_hour/resources/v1/text_to_video/client.py

@@ -42,14 +42,20 @@ class TextToVideoClient:
         POST /v1/text-to-video
 
         Args:
-            name: The name of video
+            name: The name of video. This value is mainly used for your own identification of the video.
             resolution: 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.
             end_seconds: 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.
             orientation: Determines the orientation of the output video
             style: V1TextToVideoCreateBodyStyle
             request_options: Additional options to customize the HTTP request
@@ -68,6 +74,7 @@ class TextToVideoClient:
             orientation="landscape",
             style={"prompt": "a dog running"},
             name="Text To Video video",
+            resolution="720p",
         )
         ```
         """
@@ -121,14 +128,20 @@ class AsyncTextToVideoClient:
         POST /v1/text-to-video
 
         Args:
-            name: The name of video
+            name: The name of video. This value is mainly used for your own identification of the video.
             resolution: 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.
             end_seconds: 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.
             orientation: Determines the orientation of the output video
             style: V1TextToVideoCreateBodyStyle
             request_options: Additional options to customize the HTTP request
@@ -147,6 +160,7 @@ class AsyncTextToVideoClient:
             orientation="landscape",
             style={"prompt": "a dog running"},
             name="Text To Video video",
+            resolution="720p",
         )
         ```
         """

magic_hour/resources/v1/video_projects/README.md

@@ -9,7 +9,7 @@ Permanently delete the rendered video. This action is not reversible, please be
 
 | Parameter | Required | Description | Example |
 |-----------|:--------:|-------------|--------|
-| `id` | ✓ | The id of the video project | `"cm6pvghix03bvyz0zwash6noj"` |
+| `id` | ✓ | Unique ID of the video project. This value is returned by all of the POST APIs that create a video. | `"cuid-example"` |
 
 #### Synchronous Client
 
@@ -18,7 +18,7 @@ from magic_hour import Client
 from os import getenv
 
 client = Client(token=getenv("API_TOKEN"))
-res = client.v1.video_projects.delete(id="cm6pvghix03bvyz0zwash6noj")
+res = client.v1.video_projects.delete(id="cuid-example")
 
 ```
 
@@ -29,7 +29,7 @@ from magic_hour import AsyncClient
 from os import getenv
 
 client = AsyncClient(token=getenv("API_TOKEN"))
-res = await client.v1.video_projects.delete(id="cm6pvghix03bvyz0zwash6noj")
+res = await client.v1.video_projects.delete(id="cuid-example")
 
 ```
 
@@ -52,7 +52,7 @@ The video can be one of the following status
 
 | Parameter | Required | Description | Example |
 |-----------|:--------:|-------------|--------|
-| `id` | ✓ | The id of the video | `"cm6pvghix03bvyz0zwash6noj"` |
+| `id` | ✓ | Unique ID of the video project. This value is returned by all of the POST APIs that create a video. | `"cuid-example"` |
 
 #### Synchronous Client
 
@@ -61,7 +61,7 @@ from magic_hour import Client
 from os import getenv
 
 client = Client(token=getenv("API_TOKEN"))
-res = client.v1.video_projects.get(id="cm6pvghix03bvyz0zwash6noj")
+res = client.v1.video_projects.get(id="cuid-example")
 
 ```
 
@@ -72,7 +72,7 @@ from magic_hour import AsyncClient
 from os import getenv
 
 client = AsyncClient(token=getenv("API_TOKEN"))
-res = await client.v1.video_projects.get(id="cm6pvghix03bvyz0zwash6noj")
+res = await client.v1.video_projects.get(id="cuid-example")
 
 ```
 
@@ -82,4 +82,4 @@ res = await client.v1.video_projects.get(id="cm6pvghix03bvyz0zwash6noj")
 [V1VideoProjectsGetResponse](/magic_hour/types/models/v1_video_projects_get_response.py)
 
 ##### Example
-`{"created_at": "1970-01-01T00:00:00", "credits_charged": 450, "download": {"expires_at": "2024-10-19T05:16:19.027Z", "url": "https://videos.magichour.ai/id/output.mp4"}, "downloads": [{"expires_at": "2024-10-19T05:16:19.027Z", "url": "https://videos.magichour.ai/id/output.mp4"}], "enabled": True, "end_seconds": 15.0, "error": {"code": "no_source_face", "message": "Please use an image with a detectable face"}, "fps": 30.0, "height": 960, "id": "clx7uu86w0a5qp55yxz315r6r", "name": "Example Name", "start_seconds": 0.0, "status": "complete", "total_frame_cost": 450, "type_": "FACE_SWAP", "width": 512}`
+`{"created_at": "1970-01-01T00:00:00", "credits_charged": 450, "download": {"expires_at": "2024-10-19T05:16:19.027Z", "url": "https://videos.magichour.ai/id/output.mp4"}, "downloads": [{"expires_at": "2024-10-19T05:16:19.027Z", "url": "https://videos.magichour.ai/id/output.mp4"}], "enabled": True, "end_seconds": 15.0, "error": {"code": "no_source_face", "message": "Please use an image with a detectable face"}, "fps": 30.0, "height": 960, "id": "cuid-example", "name": "Example Name", "start_seconds": 0.0, "status": "complete", "total_frame_cost": 450, "type_": "FACE_SWAP", "width": 512}`

magic_hour/resources/v1/video_projects/client.py

@@ -24,7 +24,7 @@ class VideoProjectsClient:
         DELETE /v1/video-projects/{id}
 
         Args:
-            id: The id of the video project
+            id: Unique ID of the video project. This value is returned by all of the POST APIs that create a video.
             request_options: Additional options to customize the HTTP request
 
         Returns:
@@ -36,7 +36,7 @@ class VideoProjectsClient:
 
         Examples:
         ```py
-        client.v1.video_projects.delete(id="cm6pvghix03bvyz0zwash6noj")
+        client.v1.video_projects.delete(id="cuid-example")
         ```
         """
         self._base_client.request(
@@ -67,7 +67,7 @@ class VideoProjectsClient:
         GET /v1/video-projects/{id}
 
         Args:
-            id: The id of the video
+            id: Unique ID of the video project. This value is returned by all of the POST APIs that create a video.
             request_options: Additional options to customize the HTTP request
 
         Returns:
@@ -79,7 +79,7 @@ class VideoProjectsClient:
 
         Examples:
         ```py
-        client.v1.video_projects.get(id="cm6pvghix03bvyz0zwash6noj")
+        client.v1.video_projects.get(id="cuid-example")
         ```
         """
         return self._base_client.request(
@@ -106,7 +106,7 @@ class AsyncVideoProjectsClient:
         DELETE /v1/video-projects/{id}
 
         Args:
-            id: The id of the video project
+            id: Unique ID of the video project. This value is returned by all of the POST APIs that create a video.
             request_options: Additional options to customize the HTTP request
 
         Returns:
@@ -118,7 +118,7 @@ class AsyncVideoProjectsClient:
 
         Examples:
         ```py
-        await client.v1.video_projects.delete(id="cm6pvghix03bvyz0zwash6noj")
+        await client.v1.video_projects.delete(id="cuid-example")
         ```
         """
         await self._base_client.request(
@@ -149,7 +149,7 @@ class AsyncVideoProjectsClient:
         GET /v1/video-projects/{id}
 
         Args:
-            id: The id of the video
+            id: Unique ID of the video project. This value is returned by all of the POST APIs that create a video.
             request_options: Additional options to customize the HTTP request
 
         Returns:
@@ -161,7 +161,7 @@ class AsyncVideoProjectsClient:
 
         Examples:
         ```py
-        await client.v1.video_projects.get(id="cm6pvghix03bvyz0zwash6noj")
+        await client.v1.video_projects.get(id="cuid-example")
         ```
         """
         return await self._base_client.request(

magic_hour/resources/v1/video_to_video/README.md

@@ -13,12 +13,12 @@ Get more information about this mode at our [product page](https://magichour.ai/
 | Parameter | Required | Description | Example |
 |-----------|:--------:|-------------|--------|
 | `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 | `{"video_file_path": "api-assets/id/1234.mp4", "video_source": "file"}` |
-| `end_seconds` | ✓ | The end time of the input video in seconds | `15.0` |
-| `start_seconds` | ✓ | The start time of the input video in seconds | `0.0` |
-| `style` | ✓ |  | `{"art_style": "3D Render", "model": "Absolute Reality", "prompt": "string", "prompt_type": "append_default", "version": "default"}` |
+| `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. | `15.0` |
+| `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. | `0.0` |
+| `style` | ✓ |  | `{"art_style": "3D Render", "model": "default", "prompt": "string", "prompt_type": "default", "version": "default"}` |
 | `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 | `"HALF"` |
 | `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.  See our [pricing page](https://magichour.ai/pricing) for more details. | `960` |
-| `name` | ✗ | The name of video | `"Video To Video video"` |
+| `name` | ✗ | The name of video. This value is mainly used for your own identification of the video. | `"Video To Video video"` |
 | `width` | ✗ | 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.  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. | `512` |
 
 #### Synchronous Client
@@ -34,9 +34,9 @@ res = client.v1.video_to_video.create(
     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",
@@ -60,9 +60,9 @@ res = await client.v1.video_to_video.create(
     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",
@@ -79,4 +79,4 @@ res = await client.v1.video_to_video.create(
 [V1VideoToVideoCreateResponse](/magic_hour/types/models/v1_video_to_video_create_response.py)
 
 ##### Example
-`{"credits_charged": 450, "estimated_frame_cost": 450, "id": "clx7uu86w0a5qp55yxz315r6r"}`
+`{"credits_charged": 450, "estimated_frame_cost": 450, "id": "cuid-example"}`

magic_hour/resources/v1/video_to_video/client.py

@@ -60,7 +60,7 @@ class VideoToVideoClient:
         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.
-            name: The name of video
+            name: The name of video. This value is mainly used for your own identification of the video.
             width: 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.
@@ -70,8 +70,8 @@ class VideoToVideoClient:
 
         See our [pricing page](https://magichour.ai/pricing) for more details.
             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,9 +93,9 @@ 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",
@@ -176,7 +176,7 @@ class AsyncVideoToVideoClient:
         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.
-            name: The name of video
+            name: The name of video. This value is mainly used for your own identification of the video.
             width: 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.
@@ -186,8 +186,8 @@ class AsyncVideoToVideoClient:
 
         See our [pricing page](https://magichour.ai/pricing) for more details.
             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,9 +209,9 @@ 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",

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