magic_hour 0.23.0__tar.gz → 0.24.0__tar.gz

{magic_hour-0.23.0 → magic_hour-0.24.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: magic_hour
-Version: 0.23.0
+Version: 0.24.0
 Summary: Python SDK for Magic Hour API
 Requires-Python: >=3.8,<4.0
 Classifier: Programming Language :: Python :: 3

{magic_hour-0.23.0 → magic_hour-0.24.0}/magic_hour/core/query.py

@@ -2,7 +2,6 @@ import json
 
 from typing import Any, Dict, Union
 from typing_extensions import Literal, Sequence
-from urllib.parse import quote_plus, quote
 
 import httpx
 
@@ -47,19 +46,19 @@ def _encode_form(params: QueryParams, name: str, value: Any, explode: bool):
     """
     if isinstance(value, list) and not explode:
         # non-explode form lists should be encoded like /users?id=3,4,5
-        params[name] = quote_plus(",".join(map(_query_str, value)))
+        params[name] = ",".join(map(_query_str, value))
     elif isinstance(value, dict):
         if explode:
             # explode form objects should be encoded like /users?key0=val0&key1=val1
             # the input param name will be omitted
             for k, v in value.items():
-                params[k] = quote_plus(_query_str(v))
+                params[k] = _query_str(v)
         else:
             # non-explode form objects should be encoded like /users?id=key0,val0,key1,val1
             encoded_chunks = []
             for k, v in value.items():
                 encoded_chunks.extend([str(k), _query_str(v)])
-            params[name] = quote_plus(",".join(encoded_chunks))
+            params[name] = ",".join(encoded_chunks)
     else:
         params[name] = value
 
@@ -71,7 +70,7 @@ def _encode_spaced_delimited(params: QueryParams, name: str, value: Any, explode
     """
     if isinstance(value, list) and not explode:
         # non-explode spaceDelimited lists should be encoded like /users?id=3%204%205
-        params[name] = quote(" ".join(map(_query_str, value)))
+        params[name] = " ".join(map(_query_str, value))
     else:
         # according to the docs, spaceDelimited + explode=false only effects lists,
         # all other encodings are marked as n/a or are the same as `form` style
@@ -86,7 +85,7 @@ def _encode_pipe_delimited(params: QueryParams, name: str, value: Any, explode:
     """
     if isinstance(value, list) and not explode:
         # non-explode pipeDelimited lists should be encoded like /users?id=3|4|5
-        params[name] = quote("|".join(map(_query_str, value)))
+        params[name] = "|".join(map(_query_str, value))
     else:
         # according to the docs, pipeDelimited + explode=false only effects lists,
         # all other encodings are marked as n/a or are the same as `form` style

{magic_hour-0.23.0 → magic_hour-0.24.0}/magic_hour/environment.py

@@ -6,7 +6,7 @@ class Environment(enum.Enum):
     """Pre-defined base URLs for the API"""
 
     ENVIRONMENT = "https://api.magichour.ai"
-    MOCK_SERVER = "https://api.sideko.dev/v1/mock/magichour/magic-hour/0.23.0"
+    MOCK_SERVER = "https://api.sideko.dev/v1/mock/magichour/magic-hour/0.24.0"
 
 
 def _get_base_url(

{magic_hour-0.23.0 → magic_hour-0.24.0}/magic_hour/resources/v1/ai_clothes_changer/README.md

@@ -20,6 +20,7 @@ res = client.v1.ai_clothes_changer.create(
     },
     name="Clothes Changer image",
 )
+
 ```
 
 #### Asynchronous Client
@@ -37,4 +38,12 @@ res = await client.v1.ai_clothes_changer.create(
     },
     name="Clothes Changer image",
 )
+
 ```
+
+#### Parameters
+
+| Parameter | Required | Description | Example |
+|-----------|:--------:|-------------|--------|
+| `assets` | ✓ | Provide the assets for clothes changer | `{"garment_file_path": "api-assets/id/outfit.png", "garment_type": "dresses", "person_file_path": "api-assets/id/model.png"}` |
+| `name` | ✗ | The name of image | `"Clothes Changer image"` |

{magic_hour-0.23.0 → magic_hour-0.24.0}/magic_hour/resources/v1/ai_face_editor/README.md

@@ -33,6 +33,7 @@ res = client.v1.ai_face_editor.create(
     },
     name="Face Editor image",
 )
+
 ```
 
 #### Asynchronous Client
@@ -63,4 +64,13 @@ res = await client.v1.ai_face_editor.create(
     },
     name="Face Editor image",
 )
+
 ```
+
+#### Parameters
+
+| Parameter | Required | Description | Example |
+|-----------|:--------:|-------------|--------|
+| `assets` | ✓ | Provide the assets for face editor | `{"image_file_path": "api-assets/id/1234.png"}` |
+| `style` | ✓ | Face editing parameters | `{"enhance_face": False, "eye_gaze_horizontal": 0.0, "eye_gaze_vertical": 0.0, "eye_open_ratio": 0.0, "eyebrow_direction": 0.0, "head_pitch": 0.0, "head_roll": 0.0, "head_yaw": 0.0, "lip_open_ratio": 0.0, "mouth_grim": 0.0, "mouth_position_horizontal": 0.0, "mouth_position_vertical": 0.0, "mouth_pout": 0.0, "mouth_purse": 0.0, "mouth_smile": 0.0}` |
+| `name` | ✗ | The name of image | `"Face Editor image"` |

{magic_hour-0.23.0 → magic_hour-0.24.0}/magic_hour/resources/v1/ai_gif_generator/README.md

@@ -15,6 +15,7 @@ client = Client(token=getenv("API_TOKEN"))
 res = client.v1.ai_gif_generator.create(
     style={"prompt": "Cute dancing cat, pixel art"}, name="Ai Gif gif"
 )
+
 ```
 
 #### Asynchronous Client
@@ -27,4 +28,12 @@ client = AsyncClient(token=getenv("API_TOKEN"))
 res = await client.v1.ai_gif_generator.create(
     style={"prompt": "Cute dancing cat, pixel art"}, name="Ai Gif gif"
 )
+
 ```
+
+#### Parameters
+
+| Parameter | Required | Description | Example |
+|-----------|:--------:|-------------|--------|
+| `style` | ✓ |  | `{"prompt": "Cute dancing cat, pixel art"}` |
+| `name` | ✗ | The name of gif | `"Ai Gif gif"` |

{magic_hour-0.23.0 → magic_hour-0.24.0}/magic_hour/resources/v1/ai_headshot_generator/README.md

@@ -15,6 +15,7 @@ client = Client(token=getenv("API_TOKEN"))
 res = client.v1.ai_headshot_generator.create(
     assets={"image_file_path": "api-assets/id/1234.png"}, name="Ai Headshot image"
 )
+
 ```
 
 #### Asynchronous Client
@@ -27,4 +28,13 @@ client = AsyncClient(token=getenv("API_TOKEN"))
 res = await client.v1.ai_headshot_generator.create(
     assets={"image_file_path": "api-assets/id/1234.png"}, name="Ai Headshot image"
 )
+
 ```
+
+#### Parameters
+
+| Parameter | Required | Description | Example |
+|-----------|:--------:|-------------|--------|
+| `assets` | ✓ | Provide the assets for headshot photo | `{"image_file_path": "api-assets/id/1234.png"}` |
+| `name` | ✗ | The name of image | `"Ai Headshot image"` |
+| `style` | ✗ |  | `{"prompt": "professional passport photo, business attire, smiling, good posture, light blue background, centered, plain background"}` |

{magic_hour-0.23.0 → magic_hour-0.24.0}/magic_hour/resources/v1/ai_image_generator/README.md

@@ -15,9 +15,10 @@ client = Client(token=getenv("API_TOKEN"))
 res = client.v1.ai_image_generator.create(
     image_count=1,
     orientation="landscape",
-    style={"prompt": "Cool image"},
+    style={"prompt": "Cool image", "tool": "ai-anime-generator"},
     name="Ai Image image",
 )
+
 ```
 
 #### Asynchronous Client
@@ -30,7 +31,17 @@ client = AsyncClient(token=getenv("API_TOKEN"))
 res = await client.v1.ai_image_generator.create(
     image_count=1,
     orientation="landscape",
-    style={"prompt": "Cool image"},
+    style={"prompt": "Cool image", "tool": "ai-anime-generator"},
     name="Ai Image image",
 )
+
 ```
+
+#### Parameters
+
+| Parameter | Required | Description | Example |
+|-----------|:--------:|-------------|--------|
+| `image_count` | ✓ | number to images to generate | `1` |
+| `orientation` | ✓ |  | `"landscape"` |
+| `style` | ✓ |  | `{"prompt": "Cool image", "tool": "ai-anime-generator"}` |
+| `name` | ✗ | The name of image | `"Ai Image image"` |

{magic_hour-0.23.0 → magic_hour-0.24.0}/magic_hour/resources/v1/ai_image_generator/client.py

@@ -53,7 +53,7 @@ class AiImageGeneratorClient:
         client.v1.ai_image_generator.create(
             image_count=1,
             orientation="landscape",
-            style={"prompt": "Cool image"},
+            style={"prompt": "Cool image", "tool": "ai-anime-generator"},
             name="Ai Image image",
         )
         ```
@@ -118,7 +118,7 @@ class AsyncAiImageGeneratorClient:
         await client.v1.ai_image_generator.create(
             image_count=1,
             orientation="landscape",
-            style={"prompt": "Cool image"},
+            style={"prompt": "Cool image", "tool": "ai-anime-generator"},
             name="Ai Image image",
         )
         ```

{magic_hour-0.23.0 → magic_hour-0.24.0}/magic_hour/resources/v1/ai_image_upscaler/README.md

@@ -18,6 +18,7 @@ res = client.v1.ai_image_upscaler.create(
     style={"enhancement": "Balanced"},
     name="Image Upscaler image",
 )
+
 ```
 
 #### Asynchronous Client
@@ -33,4 +34,14 @@ res = await client.v1.ai_image_upscaler.create(
     style={"enhancement": "Balanced"},
     name="Image Upscaler image",
 )
+
 ```
+
+#### Parameters
+
+| Parameter | Required | Description | Example |
+|-----------|:--------:|-------------|--------|
+| `assets` | ✓ | Provide the assets for upscaling | `{"image_file_path": "api-assets/id/1234.png"}` |
+| `scale_factor` | ✓ | How much to scale the image. Must be either 2 or 4 | `2.0` |
+| `style` | ✓ |  | `{"enhancement": "Balanced"}` |
+| `name` | ✗ | The name of image | `"Image Upscaler image"` |

{magic_hour-0.23.0 → magic_hour-0.24.0}/magic_hour/resources/v1/ai_meme_generator/README.md

@@ -20,6 +20,7 @@ res = client.v1.ai_meme_generator.create(
     },
     name="My Funny Meme",
 )
+
 ```
 
 #### Asynchronous Client
@@ -37,4 +38,12 @@ res = await client.v1.ai_meme_generator.create(
     },
     name="My Funny Meme",
 )
+
 ```
+
+#### Parameters
+
+| Parameter | Required | Description | Example |
+|-----------|:--------:|-------------|--------|
+| `style` | ✓ |  | `{"search_web": False, "template": "Drake Hotline Bling", "topic": "When the code finally works"}` |
+| `name` | ✗ | The name of the meme. | `"My Funny Meme"` |

{magic_hour-0.23.0 → magic_hour-0.24.0}/magic_hour/resources/v1/ai_photo_editor/README.md

@@ -29,6 +29,7 @@ res = client.v1.ai_photo_editor.create(
     },
     name="Photo Editor image",
 )
+
 ```
 
 #### Asynchronous Client
@@ -53,4 +54,15 @@ res = await client.v1.ai_photo_editor.create(
     },
     name="Photo Editor image",
 )
+
 ```
+
+#### Parameters
+
+| Parameter | Required | Description | Example |
+|-----------|:--------:|-------------|--------|
+| `assets` | ✓ | Provide the assets for photo editor | `{"image_file_path": "api-assets/id/1234.png"}` |
+| `resolution` | ✓ | The resolution of the final output image. The allowed value is based on your subscription. Please refer to our [pricing page](https://magichour.ai/pricing) for more details | `768` |
+| `style` | ✓ |  | `{"image_description": "A photo of a person", "likeness_strength": 5.2, "negative_prompt": "painting, cartoon, sketch", "prompt": "A photo portrait of a person wearing a hat", "prompt_strength": 3.75, "steps": 4, "upscale_factor": 2, "upscale_fidelity": 0.5}` |
+| `name` | ✗ | The name of image | `"Photo Editor image"` |
+| `steps` | ✗ | Deprecated: Please use `.style.steps` instead. Number of iterations used to generate the output. Higher values improve quality and increase the strength of the prompt but increase processing time. | `123` |

{magic_hour-0.23.0 → magic_hour-0.24.0}/magic_hour/resources/v1/ai_qr_code_generator/README.md

@@ -17,6 +17,7 @@ res = client.v1.ai_qr_code_generator.create(
     style={"art_style": "Watercolor"},
     name="Qr Code image",
 )
+
 ```
 
 #### Asynchronous Client
@@ -31,4 +32,13 @@ res = await client.v1.ai_qr_code_generator.create(
     style={"art_style": "Watercolor"},
     name="Qr Code image",
 )
+
 ```
+
+#### Parameters
+
+| Parameter | Required | Description | Example |
+|-----------|:--------:|-------------|--------|
+| `content` | ✓ | The content of the QR code. | `"https://magichour.ai"` |
+| `style` | ✓ |  | `{"art_style": "Watercolor"}` |
+| `name` | ✗ | The name of image | `"Qr Code image"` |

{magic_hour-0.23.0 → magic_hour-0.24.0}/magic_hour/resources/v1/ai_talking_photo/README.md

@@ -21,6 +21,7 @@ res = client.v1.ai_talking_photo.create(
     start_seconds=0.0,
     name="Talking Photo image",
 )
+
 ```
 
 #### Asynchronous Client
@@ -39,4 +40,15 @@ res = await client.v1.ai_talking_photo.create(
     start_seconds=0.0,
     name="Talking Photo image",
 )
+
 ```
+
+#### Parameters
+
+| Parameter | Required | Description | Example |
+|-----------|:--------:|-------------|--------|
+| `assets` | ✓ | Provide the assets for creating a talking photo | `{"audio_file_path": "api-assets/id/1234.mp3", "image_file_path": "api-assets/id/1234.png"}` |
+| `end_seconds` | ✓ | The end time of the input audio in seconds. The maximum duration allowed is 30 seconds. | `15.0` |
+| `start_seconds` | ✓ | The start time of the input audio in seconds. The maximum duration allowed is 30 seconds. | `0.0` |
+| `name` | ✗ | The name of image | `"Talking Photo image"` |
+| `style` | ✗ | Attributes used to dictate the style of the output | `{"generation_mode": "expressive", "intensity": 1.5}` |

{magic_hour-0.23.0 → magic_hour-0.24.0}/magic_hour/resources/v1/animation/README.md

@@ -31,6 +31,7 @@ res = client.v1.animation.create(
     width=512,
     name="Animation video",
 )
+
 ```
 
 #### Asynchronous Client
@@ -59,4 +60,17 @@ res = await client.v1.animation.create(
     width=512,
     name="Animation video",
 )
+
 ```
+
+#### Parameters
+
+| Parameter | Required | Description | Example |
+|-----------|:--------:|-------------|--------|
+| `assets` | ✓ | Provide the assets for animation. | `{"audio_file_path": "api-assets/id/1234.mp3", "audio_source": "file", "image_file_path": "api-assets/id/1234.png"}` |
+| `end_seconds` | ✓ | The end time of the input video in seconds | `15.0` |
+| `fps` | ✓ | The desire output video frame rate | `12.0` |
+| `height` | ✓ | The height of the final output video. The maximum height depends on your subscription. Please refer to our [pricing page](https://magichour.ai/pricing) for more details | `960` |
+| `style` | ✓ | Defines the style of the output video | `{"art_style": "Painterly Illustration", "camera_effect": "Accelerate", "prompt": "Cyberpunk city", "prompt_type": "ai_choose", "transition_speed": 5}` |
+| `width` | ✓ | The width of the final output video. The maximum width depends on your subscription. Please refer to our [pricing page](https://magichour.ai/pricing) for more details | `512` |
+| `name` | ✗ | The name of video | `"Animation video"` |

magic_hour-0.24.0/magic_hour/resources/v1/face_swap/README.md

@@ -0,0 +1,64 @@
+
+### Face Swap video <a name="create"></a>
+
+Create a Face Swap video. The estimated frame cost is calculated using 30 FPS. This amount is deducted from your account balance when a video is queued. Once the video is complete, the cost will be updated based on the actual number of frames rendered.
+  
+Get more information about this mode at our [product page](/products/face-swap).
+  
+
+**API Endpoint**: `POST /v1/face-swap`
+
+#### Synchronous Client
+
+```python
+from magic_hour import Client
+from os import getenv
+
+client = Client(token=getenv("API_TOKEN"))
+res = client.v1.face_swap.create(
+    assets={
+        "image_file_path": "image/id/1234.png",
+        "video_file_path": "api-assets/id/1234.mp4",
+        "video_source": "file",
+    },
+    end_seconds=15.0,
+    start_seconds=0.0,
+    height=960,
+    name="Face Swap video",
+    width=512,
+)
+
+```
+
+#### Asynchronous Client
+
+```python
+from magic_hour import AsyncClient
+from os import getenv
+
+client = AsyncClient(token=getenv("API_TOKEN"))
+res = await client.v1.face_swap.create(
+    assets={
+        "image_file_path": "image/id/1234.png",
+        "video_file_path": "api-assets/id/1234.mp4",
+        "video_source": "file",
+    },
+    end_seconds=15.0,
+    start_seconds=0.0,
+    height=960,
+    name="Face Swap video",
+    width=512,
+)
+
+```
+
+#### Parameters
+
+| 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 | `{"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` |

{magic_hour-0.23.0 → magic_hour-0.24.0}/magic_hour/resources/v1/face_swap_photo/README.md

@@ -19,6 +19,7 @@ res = client.v1.face_swap_photo.create(
     },
     name="Face Swap image",
 )
+
 ```
 
 #### Asynchronous Client
@@ -35,4 +36,12 @@ res = await client.v1.face_swap_photo.create(
     },
     name="Face Swap image",
 )
+
 ```
+
+#### Parameters
+
+| Parameter | Required | Description | Example |
+|-----------|:--------:|-------------|--------|
+| `assets` | ✓ | Provide the assets for face swap photo | `{"source_file_path": "api-assets/id/1234.png", "target_file_path": "api-assets/id/1234.png"}` |
+| `name` | ✗ | The name of image | `"Face Swap image"` |

{magic_hour-0.23.0 → magic_hour-0.24.0}/magic_hour/resources/v1/files/upload_urls/README.md

@@ -37,6 +37,7 @@ res = client.v1.files.upload_urls.create(
         {"extension": "mp3", "type_": "audio"},
     ]
 )
+
 ```
 
 #### Asynchronous Client
@@ -52,4 +53,11 @@ res = await client.v1.files.upload_urls.create(
         {"extension": "mp3", "type_": "audio"},
     ]
 )
+
 ```
+
+#### Parameters
+
+| Parameter | Required | Description | Example |
+|-----------|:--------:|-------------|--------|
+| `items` | ✓ |  | `[{"extension": "mp4", "type_": "video"}, {"extension": "mp3", "type_": "audio"}]` |

{magic_hour-0.23.0 → magic_hour-0.24.0}/magic_hour/resources/v1/image_background_remover/README.md

@@ -16,6 +16,7 @@ res = client.v1.image_background_remover.create(
     assets={"image_file_path": "api-assets/id/1234.png"},
     name="Background Remover image",
 )
+
 ```
 
 #### Asynchronous Client
@@ -29,4 +30,12 @@ res = await client.v1.image_background_remover.create(
     assets={"image_file_path": "api-assets/id/1234.png"},
     name="Background Remover image",
 )
+
 ```
+
+#### Parameters
+
+| Parameter | Required | Description | Example |
+|-----------|:--------:|-------------|--------|
+| `assets` | ✓ | Provide the assets for background removal | `{"image_file_path": "api-assets/id/1234.png"}` |
+| `name` | ✗ | The name of image | `"Background Remover image"` |

{magic_hour-0.23.0 → magic_hour-0.24.0}/magic_hour/resources/v1/image_projects/README.md

@@ -13,6 +13,7 @@ from os import getenv
 
 client = Client(token=getenv("API_TOKEN"))
 res = client.v1.image_projects.delete(id="cm6pvghix03bvyz0zwash6noj")
+
 ```
 
 #### Asynchronous Client
@@ -23,8 +24,15 @@ from os import getenv
 
 client = AsyncClient(token=getenv("API_TOKEN"))
 res = await client.v1.image_projects.delete(id="cm6pvghix03bvyz0zwash6noj")
+
 ```
 
+#### Parameters
+
+| Parameter | Required | Description | Example |
+|-----------|:--------:|-------------|--------|
+| `id` | ✓ | The id of the image project | `"cm6pvghix03bvyz0zwash6noj"` |
+
 ### Get image details <a name="get"></a>
 
 Get the details of a image project. The `downloads` field will be empty unless the image was successfully rendered.
@@ -48,6 +56,7 @@ from os import getenv
 
 client = Client(token=getenv("API_TOKEN"))
 res = client.v1.image_projects.get(id="cm6pvghix03bvyz0zwash6noj")
+
 ```
 
 #### Asynchronous Client
@@ -58,4 +67,11 @@ from os import getenv
 
 client = AsyncClient(token=getenv("API_TOKEN"))
 res = await client.v1.image_projects.get(id="cm6pvghix03bvyz0zwash6noj")
+
 ```
+
+#### Parameters
+
+| Parameter | Required | Description | Example |
+|-----------|:--------:|-------------|--------|
+| `id` | ✓ | The id of the image project | `"cm6pvghix03bvyz0zwash6noj"` |

{magic_hour-0.23.0 → magic_hour-0.24.0}/magic_hour/resources/v1/image_to_video/README.md

@@ -23,6 +23,7 @@ res = client.v1.image_to_video.create(
     name="Image To Video video",
     width=512,
 )
+
 ```
 
 #### Asynchronous Client
@@ -40,4 +41,16 @@ res = await client.v1.image_to_video.create(
     name="Image To Video video",
     width=512,
 )
+
 ```
+
+#### Parameters
+
+| Parameter | Required | Description | Example |
+|-----------|:--------:|-------------|--------|
+| `assets` | ✓ | Provide the assets for image-to-video. | `{"image_file_path": "api-assets/id/1234.png"}` |
+| `end_seconds` | ✓ | The total duration of the output video in seconds. | `5.0` |
+| `style` | ✓ | Attributed used to dictate the style of the output | `{"prompt": "a dog running"}` |
+| `height` | ✗ | This field does not affect the output video's resolution. The video's orientation will match that of the input image.  It is retained solely for backward compatibility and will be deprecated in the future. | `960` |
+| `name` | ✗ | The name of video | `"Image To Video video"` |
+| `width` | ✗ | This field does not affect the output video's resolution. The video's orientation will match that of the input image.  It is retained solely for backward compatibility and will be deprecated in the future. | `512` |

magic_hour-0.24.0/magic_hour/resources/v1/lip_sync/README.md

@@ -0,0 +1,67 @@
+
+### Lip Sync <a name="create"></a>
+
+Create a Lip Sync video. The estimated frame cost is calculated using 30 FPS. This amount is deducted from your account balance when a video is queued. Once the video is complete, the cost will be updated based on the actual number of frames rendered.
+  
+Get more information about this mode at our [product page](/products/lip-sync).
+  
+
+**API Endpoint**: `POST /v1/lip-sync`
+
+#### Synchronous Client
+
+```python
+from magic_hour import Client
+from os import getenv
+
+client = Client(token=getenv("API_TOKEN"))
+res = client.v1.lip_sync.create(
+    assets={
+        "audio_file_path": "api-assets/id/1234.mp3",
+        "video_file_path": "api-assets/id/1234.mp4",
+        "video_source": "file",
+    },
+    end_seconds=15.0,
+    start_seconds=0.0,
+    height=960,
+    max_fps_limit=12.0,
+    name="Lip Sync video",
+    width=512,
+)
+
+```
+
+#### Asynchronous Client
+
+```python
+from magic_hour import AsyncClient
+from os import getenv
+
+client = AsyncClient(token=getenv("API_TOKEN"))
+res = await client.v1.lip_sync.create(
+    assets={
+        "audio_file_path": "api-assets/id/1234.mp3",
+        "video_file_path": "api-assets/id/1234.mp4",
+        "video_source": "file",
+    },
+    end_seconds=15.0,
+    start_seconds=0.0,
+    height=960,
+    max_fps_limit=12.0,
+    name="Lip Sync video",
+    width=512,
+)
+
+```
+
+#### Parameters
+
+| Parameter | Required | Description | Example |
+|-----------|:--------:|-------------|--------|
+| `assets` | ✓ | Provide the assets for lip-sync. For video, The `video_source` field determines whether `video_file_path` or `youtube_url` field is used | `{"audio_file_path": "api-assets/id/1234.mp3", "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` |
+| `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. | `12.0` |
+| `name` | ✗ | The name of video | `"Lip Sync 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` |

{magic_hour-0.23.0 → magic_hour-0.24.0}/magic_hour/resources/v1/photo_colorizer/README.md

@@ -15,6 +15,7 @@ client = Client(token=getenv("API_TOKEN"))
 res = client.v1.photo_colorizer.create(
     assets={"image_file_path": "api-assets/id/1234.png"}, name="Photo Colorizer image"
 )
+
 ```
 
 #### Asynchronous Client
@@ -27,4 +28,12 @@ client = AsyncClient(token=getenv("API_TOKEN"))
 res = await client.v1.photo_colorizer.create(
     assets={"image_file_path": "api-assets/id/1234.png"}, name="Photo Colorizer image"
 )
+
 ```
+
+#### Parameters
+
+| 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"` |

{magic_hour-0.23.0 → magic_hour-0.24.0}/magic_hour/resources/v1/text_to_video/README.md

@@ -21,6 +21,7 @@ res = client.v1.text_to_video.create(
     style={"prompt": "a dog running"},
     name="Text To Video video",
 )
+
 ```
 
 #### Asynchronous Client
@@ -36,4 +37,14 @@ res = await client.v1.text_to_video.create(
     style={"prompt": "a dog running"},
     name="Text To Video video",
 )
+
 ```
+
+#### Parameters
+
+| Parameter | Required | Description | Example |
+|-----------|:--------:|-------------|--------|
+| `end_seconds` | ✓ | The total duration of the output video in seconds. | `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"` |