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

magic_hour/resources/v1/face_detection/README.md

@@ -1,7 +1,9 @@
 
 ### Get face detection details <a name="get"></a>
 
-Get the details of a face detection task.
+Get the details of a face detection task. 
+
+Use this API to get the list of faces detected in the image or video to use in the [face swap photo](/api-reference/face-swap-photo/face-swap-photo) or [face swap video](/api-reference/face-swap/face-swap-video) API calls for multi-face swaps.
 
 **API Endpoint**: `GET /v1/face-detection/{id}`
 
@@ -9,7 +11,7 @@ Get the details of a face detection task.
 
 | Parameter | Required | Description | Example |
 |-----------|:--------:|-------------|--------|
-| `id` | ✓ | The id of the task | `"string"` |
+| `id` | ✓ | The id of the task. This value is returned by the [face detection API](/api-reference/files/face-detection#response-id). | `"uuid-example"` |
 
 #### Synchronous Client
 
@@ -18,7 +20,7 @@ from magic_hour import Client
 from os import getenv
 
 client = Client(token=getenv("API_TOKEN"))
-res = client.v1.face_detection.get(id="string")
+res = client.v1.face_detection.get(id="uuid-example")
 
 ```
 
@@ -29,7 +31,7 @@ from magic_hour import AsyncClient
 from os import getenv
 
 client = AsyncClient(token=getenv("API_TOKEN"))
-res = await client.v1.face_detection.get(id="string")
+res = await client.v1.face_detection.get(id="uuid-example")
 
 ```
 
@@ -39,11 +41,13 @@ res = await client.v1.face_detection.get(id="string")
 [V1FaceDetectionGetResponse](/magic_hour/types/models/v1_face_detection_get_response.py)
 
 ##### Example
-`{"credits_charged": 123, "faces": [{"path": "api-assets/id/0-0.png", "url": "https://videos.magichour.ai/api-assets/id/0-0.png"}], "id": "string", "status": "complete"}`
+`{"credits_charged": 0, "faces": [{"path": "api-assets/id/0-0.png", "url": "https://videos.magichour.ai/api-assets/id/0-0.png"}], "id": "uuid-example", "status": "complete"}`
 
 ### Face Detection <a name="create"></a>
 
 Detect faces in an image or video. 
+      
+Use this API to get the list of faces detected in the image or video to use in the [face swap photo](/api-reference/face-swap-photo/face-swap-photo) or [face swap video](/api-reference/face-swap/face-swap-video) API calls for multi-face swaps.
 
 Note: Face detection is free to use for the near future. Pricing may change in the future.
 
@@ -88,4 +92,4 @@ res = await client.v1.face_detection.create(
 [V1FaceDetectionCreateResponse](/magic_hour/types/models/v1_face_detection_create_response.py)
 
 ##### Example
-`{"credits_charged": 123, "id": "string"}`
+`{"credits_charged": 123, "id": "uuid-example"}`

magic_hour/resources/v1/face_detection/client.py

@@ -23,10 +23,12 @@ class FaceDetectionClient:
 
         Get the details of a face detection task.
 
+        Use this API to get the list of faces detected in the image or video to use in the [face swap photo](/api-reference/face-swap-photo/face-swap-photo) or [face swap video](/api-reference/face-swap/face-swap-video) API calls for multi-face swaps.
+
         GET /v1/face-detection/{id}
 
         Args:
-            id: The id of the task
+            id: The id of the task. This value is returned by the [face detection API](/api-reference/files/face-detection#response-id).
             request_options: Additional options to customize the HTTP request
 
         Returns:
@@ -38,7 +40,7 @@ class FaceDetectionClient:
 
         Examples:
         ```py
-        client.v1.face_detection.get(id="string")
+        client.v1.face_detection.get(id="uuid-example")
         ```
         """
         return self._base_client.request(
@@ -63,6 +65,8 @@ class FaceDetectionClient:
 
         Detect faces in an image or video.
 
+        Use this API to get the list of faces detected in the image or video to use in the [face swap photo](/api-reference/face-swap-photo/face-swap-photo) or [face swap video](/api-reference/face-swap/face-swap-video) API calls for multi-face swaps.
+
         Note: Face detection is free to use for the near future. Pricing may change in the future.
 
         POST /v1/face-detection
@@ -114,10 +118,12 @@ class AsyncFaceDetectionClient:
 
         Get the details of a face detection task.
 
+        Use this API to get the list of faces detected in the image or video to use in the [face swap photo](/api-reference/face-swap-photo/face-swap-photo) or [face swap video](/api-reference/face-swap/face-swap-video) API calls for multi-face swaps.
+
         GET /v1/face-detection/{id}
 
         Args:
-            id: The id of the task
+            id: The id of the task. This value is returned by the [face detection API](/api-reference/files/face-detection#response-id).
             request_options: Additional options to customize the HTTP request
 
         Returns:
@@ -129,7 +135,7 @@ class AsyncFaceDetectionClient:
 
         Examples:
         ```py
-        await client.v1.face_detection.get(id="string")
+        await client.v1.face_detection.get(id="uuid-example")
         ```
         """
         return await self._base_client.request(
@@ -154,6 +160,8 @@ class AsyncFaceDetectionClient:
 
         Detect faces in an image or video.
 
+        Use this API to get the list of faces detected in the image or video to use in the [face swap photo](/api-reference/face-swap-photo/face-swap-photo) or [face swap video](/api-reference/face-swap/face-swap-video) API calls for multi-face swaps.
+
         Note: Face detection is free to use for the near future. Pricing may change in the future.
 
         POST /v1/face-detection

magic_hour/resources/v1/face_swap/README.md

@@ -13,11 +13,11 @@ Get more information about this mode at our [product page](https://magichour.ai/
 | Parameter | Required | Description | Example |
 |-----------|:--------:|-------------|--------|
 | `assets` | ✓ | Provide the assets for face swap. For video, The `video_source` field determines whether `video_file_path` or `youtube_url` field is used | `{"face_mappings": [{"new_face": "api-assets/id/1234.png", "original_face": "api-assets/id/0-0.png"}], "face_swap_mode": "all-faces", "image_file_path": "image/id/1234.png", "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` |
-| `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 | `"Face Swap 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` |
+| `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` |
+| `height` | ✗ | `height` is deprecated and no longer influences the output video's resolution.  Output resolution is determined by the **minimum** of: - The resolution of the input video - The maximum resolution allowed by your subscription tier. See our [pricing page](https://magichour.ai/pricing) for more details.  This field is retained only for backward compatibility and will be removed in a future release. | `123` |
+| `name` | ✗ | The name of video. This value is mainly used for your own identification of the video. | `"Face Swap video"` |
+| `width` | ✗ | `width` is deprecated and no longer influences the output video's resolution.  Output resolution is determined by the **minimum** of: - The resolution of the input video - The maximum resolution allowed by your subscription tier. See our [pricing page](https://magichour.ai/pricing) for more details.  This field is retained only for backward compatibility and will be removed in a future release. | `123` |
 
 #### Synchronous Client
 
@@ -41,9 +41,7 @@ res = client.v1.face_swap.create(
     },
     end_seconds=15.0,
     start_seconds=0.0,
-    height=960,
     name="Face Swap video",
-    width=512,
 )
 
 ```
@@ -70,9 +68,7 @@ res = await client.v1.face_swap.create(
     },
     end_seconds=15.0,
     start_seconds=0.0,
-    height=960,
     name="Face Swap video",
-    width=512,
 )
 
 ```
@@ -83,4 +79,4 @@ res = await client.v1.face_swap.create(
 [V1FaceSwapCreateResponse](/magic_hour/types/models/v1_face_swap_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/face_swap/client.py

@@ -43,26 +43,24 @@ class FaceSwapClient:
         POST /v1/face-swap
 
         Args:
-            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 face swap. 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:
@@ -89,9 +87,7 @@ class FaceSwapClient:
             },
             end_seconds=15.0,
             start_seconds=0.0,
-            height=960,
             name="Face Swap video",
-            width=512,
         )
         ```
         """
@@ -148,26 +144,24 @@ class AsyncFaceSwapClient:
         POST /v1/face-swap
 
         Args:
-            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 face swap. 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:
@@ -194,9 +188,7 @@ class AsyncFaceSwapClient:
             },
             end_seconds=15.0,
             start_seconds=0.0,
-            height=960,
             name="Face Swap video",
-            width=512,
         )
         ```
         """

magic_hour/resources/v1/face_swap_photo/README.md

@@ -10,7 +10,7 @@ Create a face swap photo. Each photo costs 5 credits. The height/width of the ou
 | Parameter | Required | Description | Example |
 |-----------|:--------:|-------------|--------|
 | `assets` | ✓ | Provide the assets for face swap photo | `{"face_mappings": [{"new_face": "api-assets/id/1234.png", "original_face": "api-assets/id/0-0.png"}], "face_swap_mode": "all-faces", "source_file_path": "api-assets/id/1234.png", "target_file_path": "api-assets/id/1234.png"}` |
-| `name` | ✗ | The name of image | `"Face Swap image"` |
+| `name` | ✗ | The name of image. This value is mainly used for your own identification of the image. | `"Face Swap image"` |
 
 #### Synchronous Client
 
@@ -66,4 +66,4 @@ res = await client.v1.face_swap_photo.create(
 [V1FaceSwapPhotoCreateResponse](/magic_hour/types/models/v1_face_swap_photo_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/face_swap_photo/client.py

@@ -32,7 +32,7 @@ class FaceSwapPhotoClient:
         POST /v1/face-swap-photo
 
         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 face swap photo
             request_options: Additional options to customize the HTTP request
 
@@ -96,7 +96,7 @@ class AsyncFaceSwapPhotoClient:
         POST /v1/face-swap-photo
 
         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 face swap photo
             request_options: Additional options to customize the HTTP request
 

magic_hour/resources/v1/files/upload_urls/README.md

@@ -1,19 +1,20 @@
 
 ### Generate asset upload urls <a name="create"></a>
 
-Create a list of urls used to upload the assets needed to generate a video. Each video type has their own requirements on what assets are required. Please refer to the specific mode API for more details. The response array will be in the same order as the request body.
+Generates a list of pre-signed upload URLs for the assets required. This API is only necessary if you want to upload to Magic Hour's storage. Refer to the [Input Files Guide](/integration/input-files) for more details.
 
-Below is the list of valid extensions for each asset type:
+The response array will match the order of items in the request body.
 
+**Valid file extensions per asset type**:
 - video: mp4, m4v, mov, webm
 - audio: mp3, mpeg, wav, aac, aiff, flac
 - image: png, jpg, jpeg, webp, avif, jp2, tiff, bmp
 
-Note: `.gif` is supported for face swap API `video_file_path` field.
+> Note: `gif` is only supported for face swap API `video_file_path` field.
 
-After receiving the upload url, you can upload the file by sending a PUT request.
+Once you receive an upload URL, send a `PUT` request to upload the file directly.
 
-For example using curl
+Example:
 
 ```
 curl -X PUT --data '@/path/to/file/video.mp4' \
@@ -27,7 +28,7 @@ curl -X PUT --data '@/path/to/file/video.mp4' \
 
 | Parameter | Required | Description | Example |
 |-----------|:--------:|-------------|--------|
-| `items` | ✓ |  | `[{"extension": "mp4", "type_": "video"}, {"extension": "mp3", "type_": "audio"}]` |
+| `items` | ✓ | The list of assets to upload. The response array will match the order of items in the request body. | `[{"extension": "mp4", "type_": "video"}, {"extension": "mp3", "type_": "audio"}]` |
 
 #### Synchronous Client
 

magic_hour/resources/v1/files/upload_urls/client.py

@@ -23,19 +23,20 @@ class UploadUrlsClient:
         """
         Generate asset upload urls
         
-        Create a list of urls used to upload the assets needed to generate a video. Each video type has their own requirements on what assets are required. Please refer to the specific mode API for more details. The response array will be in the same order as the request body.
+        Generates a list of pre-signed upload URLs for the assets required. This API is only necessary if you want to upload to Magic Hour's storage. Refer to the [Input Files Guide](/integration/input-files) for more details.
         
-        Below is the list of valid extensions for each asset type:
+        The response array will match the order of items in the request body.
         
+        **Valid file extensions per asset type**:
         - video: mp4, m4v, mov, webm
         - audio: mp3, mpeg, wav, aac, aiff, flac
         - image: png, jpg, jpeg, webp, avif, jp2, tiff, bmp
         
-        Note: `.gif` is supported for face swap API `video_file_path` field.
+        > Note: `gif` is only supported for face swap API `video_file_path` field.
         
-        After receiving the upload url, you can upload the file by sending a PUT request.
+        Once you receive an upload URL, send a `PUT` request to upload the file directly.
         
-        For example using curl
+        Example:
         
         ```
         curl -X PUT --data '@/path/to/file/video.mp4' \
@@ -46,7 +47,7 @@ class UploadUrlsClient:
         POST /v1/files/upload-urls
         
         Args:
-            items: typing.List[V1FilesUploadUrlsCreateBodyItemsItem]
+            items: The list of assets to upload. The response array will match the order of items in the request body.
             request_options: Additional options to customize the HTTP request
         
         Returns:
@@ -88,19 +89,20 @@ class AsyncUploadUrlsClient:
         """
         Generate asset upload urls
         
-        Create a list of urls used to upload the assets needed to generate a video. Each video type has their own requirements on what assets are required. Please refer to the specific mode API for more details. The response array will be in the same order as the request body.
+        Generates a list of pre-signed upload URLs for the assets required. This API is only necessary if you want to upload to Magic Hour's storage. Refer to the [Input Files Guide](/integration/input-files) for more details.
         
-        Below is the list of valid extensions for each asset type:
+        The response array will match the order of items in the request body.
         
+        **Valid file extensions per asset type**:
         - video: mp4, m4v, mov, webm
         - audio: mp3, mpeg, wav, aac, aiff, flac
         - image: png, jpg, jpeg, webp, avif, jp2, tiff, bmp
         
-        Note: `.gif` is supported for face swap API `video_file_path` field.
+        > Note: `gif` is only supported for face swap API `video_file_path` field.
         
-        After receiving the upload url, you can upload the file by sending a PUT request.
+        Once you receive an upload URL, send a `PUT` request to upload the file directly.
         
-        For example using curl
+        Example:
         
         ```
         curl -X PUT --data '@/path/to/file/video.mp4' \
@@ -111,7 +113,7 @@ class AsyncUploadUrlsClient:
         POST /v1/files/upload-urls
         
         Args:
-            items: typing.List[V1FilesUploadUrlsCreateBodyItemsItem]
+            items: The list of assets to upload. The response array will match the order of items in the request body.
             request_options: Additional options to customize the HTTP request
         
         Returns:

magic_hour/resources/v1/image_background_remover/README.md

@@ -10,7 +10,7 @@ Remove background from image. Each image costs 5 credits.
 | Parameter | Required | Description | Example |
 |-----------|:--------:|-------------|--------|
 | `assets` | ✓ | Provide the assets for background removal | `{"background_image_file_path": "api-assets/id/1234.png", "image_file_path": "api-assets/id/1234.png"}` |
-| `name` | ✗ | The name of image | `"Background Remover image"` |
+| `name` | ✗ | The name of image. This value is mainly used for your own identification of the image. | `"Background Remover image"` |
 
 #### Synchronous Client
 
@@ -52,4 +52,4 @@ res = await client.v1.image_background_remover.create(
 [V1ImageBackgroundRemoverCreateResponse](/magic_hour/types/models/v1_image_background_remover_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/image_background_remover/client.py

@@ -32,7 +32,7 @@ class ImageBackgroundRemoverClient:
         POST /v1/image-background-remover
 
         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 background removal
             request_options: Additional options to customize the HTTP request
 
@@ -89,7 +89,7 @@ class AsyncImageBackgroundRemoverClient:
         POST /v1/image-background-remover
 
         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 background removal
             request_options: Additional options to customize the HTTP request
 

magic_hour/resources/v1/image_projects/README.md

@@ -1,7 +1,7 @@
 
 ### Delete image <a name="delete"></a>
 
-Permanently delete the rendered image. This action is not reversible, please be sure before deleting.
+Permanently delete the rendered image(s). This action is not reversible, please be sure before deleting.
 
 **API Endpoint**: `DELETE /v1/image-projects/{id}`
 
@@ -9,7 +9,7 @@ Permanently delete the rendered image. This action is not reversible, please be
 
 | Parameter | Required | Description | Example |
 |-----------|:--------:|-------------|--------|
-| `id` | ✓ | The id of the image project | `"cm6pvghix03bvyz0zwash6noj"` |
+| `id` | ✓ | Unique ID of the image project. This value is returned by all of the POST APIs that create an image. | `"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.image_projects.delete(id="cm6pvghix03bvyz0zwash6noj")
+res = client.v1.image_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.image_projects.delete(id="cm6pvghix03bvyz0zwash6noj")
+res = await client.v1.image_projects.delete(id="cuid-example")
 
 ```
 
@@ -52,7 +52,7 @@ The image can be one of the following status
 
 | Parameter | Required | Description | Example |
 |-----------|:--------:|-------------|--------|
-| `id` | ✓ | The id of the image project | `"cm6pvghix03bvyz0zwash6noj"` |
+| `id` | ✓ | Unique ID of the image project. This value is returned by all of the POST APIs that create an image. | `"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.image_projects.get(id="cm6pvghix03bvyz0zwash6noj")
+res = client.v1.image_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.image_projects.get(id="cm6pvghix03bvyz0zwash6noj")
+res = await client.v1.image_projects.get(id="cuid-example")
 
 ```
 
@@ -82,4 +82,4 @@ res = await client.v1.image_projects.get(id="cm6pvghix03bvyz0zwash6noj")
 [V1ImageProjectsGetResponse](/magic_hour/types/models/v1_image_projects_get_response.py)
 
 ##### Example
-`{"created_at": "1970-01-01T00:00:00", "credits_charged": 5, "downloads": [{"expires_at": "2024-10-19T05:16:19.027Z", "url": "https://videos.magichour.ai/id/output.png"}], "enabled": True, "error": {"code": "no_source_face", "message": "Please use an image with a detectable face"}, "id": "clx7uu86w0a5qp55yxz315r6r", "image_count": 1, "name": "Example Name", "status": "complete", "total_frame_cost": 5, "type_": "AI_IMAGE"}`
+`{"created_at": "1970-01-01T00:00:00", "credits_charged": 5, "downloads": [{"expires_at": "2024-10-19T05:16:19.027Z", "url": "https://videos.magichour.ai/id/output.png"}], "enabled": True, "error": {"code": "no_source_face", "message": "Please use an image with a detectable face"}, "id": "cuid-example", "image_count": 1, "name": "Example Name", "status": "complete", "total_frame_cost": 5, "type_": "AI_IMAGE"}`

magic_hour/resources/v1/image_projects/client.py

@@ -19,12 +19,12 @@ class ImageProjectsClient:
         """
         Delete image
 
-        Permanently delete the rendered image. This action is not reversible, please be sure before deleting.
+        Permanently delete the rendered image(s). This action is not reversible, please be sure before deleting.
 
         DELETE /v1/image-projects/{id}
 
         Args:
-            id: The id of the image project
+            id: Unique ID of the image project. This value is returned by all of the POST APIs that create an image.
             request_options: Additional options to customize the HTTP request
 
         Returns:
@@ -36,7 +36,7 @@ class ImageProjectsClient:
 
         Examples:
         ```py
-        client.v1.image_projects.delete(id="cm6pvghix03bvyz0zwash6noj")
+        client.v1.image_projects.delete(id="cuid-example")
         ```
         """
         self._base_client.request(
@@ -67,7 +67,7 @@ class ImageProjectsClient:
         GET /v1/image-projects/{id}
 
         Args:
-            id: The id of the image project
+            id: Unique ID of the image project. This value is returned by all of the POST APIs that create an image.
             request_options: Additional options to customize the HTTP request
 
         Returns:
@@ -79,7 +79,7 @@ class ImageProjectsClient:
 
         Examples:
         ```py
-        client.v1.image_projects.get(id="cm6pvghix03bvyz0zwash6noj")
+        client.v1.image_projects.get(id="cuid-example")
         ```
         """
         return self._base_client.request(
@@ -101,12 +101,12 @@ class AsyncImageProjectsClient:
         """
         Delete image
 
-        Permanently delete the rendered image. This action is not reversible, please be sure before deleting.
+        Permanently delete the rendered image(s). This action is not reversible, please be sure before deleting.
 
         DELETE /v1/image-projects/{id}
 
         Args:
-            id: The id of the image project
+            id: Unique ID of the image project. This value is returned by all of the POST APIs that create an image.
             request_options: Additional options to customize the HTTP request
 
         Returns:
@@ -118,7 +118,7 @@ class AsyncImageProjectsClient:
 
         Examples:
         ```py
-        await client.v1.image_projects.delete(id="cm6pvghix03bvyz0zwash6noj")
+        await client.v1.image_projects.delete(id="cuid-example")
         ```
         """
         await self._base_client.request(
@@ -149,7 +149,7 @@ class AsyncImageProjectsClient:
         GET /v1/image-projects/{id}
 
         Args:
-            id: The id of the image project
+            id: Unique ID of the image project. This value is returned by all of the POST APIs that create an image.
             request_options: Additional options to customize the HTTP request
 
         Returns:
@@ -161,7 +161,7 @@ class AsyncImageProjectsClient:
 
         Examples:
         ```py
-        await client.v1.image_projects.get(id="cm6pvghix03bvyz0zwash6noj")
+        await client.v1.image_projects.get(id="cuid-example")
         ```
         """
         return await self._base_client.request(