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

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.33.1"
+    MOCK_SERVER = "https://api.sideko.dev/v1/mock/magichour/magic-hour/0.34.0"
 
 
 def _get_base_url(

magic_hour/resources/v1/ai_clothes_changer/README.md

@@ -9,8 +9,8 @@ Change outfits in photos in seconds with just a photo reference. Each photo cost
 
 | 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"` |
+| `assets` | ✓ | Provide the assets for clothes changer | `{"garment_file_path": "api-assets/id/outfit.png", "garment_type": "upper_body", "person_file_path": "api-assets/id/model.png"}` |
+| `name` | ✗ | The name of image. This value is mainly used for your own identification of the image. | `"Clothes Changer image"` |
 
 #### Synchronous Client
 
@@ -22,7 +22,7 @@ client = Client(token=getenv("API_TOKEN"))
 res = client.v1.ai_clothes_changer.create(
     assets={
         "garment_file_path": "api-assets/id/outfit.png",
-        "garment_type": "dresses",
+        "garment_type": "upper_body",
         "person_file_path": "api-assets/id/model.png",
     },
     name="Clothes Changer image",
@@ -40,7 +40,7 @@ client = AsyncClient(token=getenv("API_TOKEN"))
 res = await client.v1.ai_clothes_changer.create(
     assets={
         "garment_file_path": "api-assets/id/outfit.png",
-        "garment_type": "dresses",
+        "garment_type": "upper_body",
         "person_file_path": "api-assets/id/model.png",
     },
     name="Clothes Changer image",
@@ -54,4 +54,4 @@ res = await client.v1.ai_clothes_changer.create(
 [V1AiClothesChangerCreateResponse](/magic_hour/types/models/v1_ai_clothes_changer_create_response.py)
 
 ##### Example
-`{"credits_charged": 25, "frame_cost": 25, "id": "clx7uu86w0a5qp55yxz315r6r"}`
+`{"credits_charged": 25, "frame_cost": 25, "id": "cuid-example"}`

magic_hour/resources/v1/ai_clothes_changer/client.py

@@ -32,7 +32,7 @@ class AiClothesChangerClient:
         POST /v1/ai-clothes-changer
 
         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 clothes changer
             request_options: Additional options to customize the HTTP request
 
@@ -48,7 +48,7 @@ class AiClothesChangerClient:
         client.v1.ai_clothes_changer.create(
             assets={
                 "garment_file_path": "api-assets/id/outfit.png",
-                "garment_type": "dresses",
+                "garment_type": "upper_body",
                 "person_file_path": "api-assets/id/model.png",
             },
             name="Clothes Changer image",
@@ -90,7 +90,7 @@ class AsyncAiClothesChangerClient:
         POST /v1/ai-clothes-changer
 
         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 clothes changer
             request_options: Additional options to customize the HTTP request
 
@@ -106,7 +106,7 @@ class AsyncAiClothesChangerClient:
         await client.v1.ai_clothes_changer.create(
             assets={
                 "garment_file_path": "api-assets/id/outfit.png",
-                "garment_type": "dresses",
+                "garment_type": "upper_body",
                 "person_file_path": "api-assets/id/model.png",
             },
             name="Clothes Changer image",

magic_hour/resources/v1/ai_face_editor/README.md

@@ -11,7 +11,7 @@ Edit facial features of an image using AI. Each edit costs 1 frame. The height/w
 |-----------|:--------:|-------------|--------|
 | `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"` |
+| `name` | ✗ | The name of image. This value is mainly used for your own identification of the image. | `"Face Editor image"` |
 
 #### Synchronous Client
 
@@ -81,4 +81,4 @@ res = await client.v1.ai_face_editor.create(
 [V1AiFaceEditorCreateResponse](/magic_hour/types/models/v1_ai_face_editor_create_response.py)
 
 ##### Example
-`{"credits_charged": 1, "frame_cost": 1, "id": "clx7uu86w0a5qp55yxz315r6r"}`
+`{"credits_charged": 1, "frame_cost": 1, "id": "cuid-example"}`

magic_hour/resources/v1/ai_face_editor/client.py

@@ -33,7 +33,7 @@ class AiFaceEditorClient:
         POST /v1/ai-face-editor
 
         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 editor
             style: Face editing parameters
             request_options: Additional options to customize the HTTP request
@@ -106,7 +106,7 @@ class AsyncAiFaceEditorClient:
         POST /v1/ai-face-editor
 
         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 editor
             style: Face editing parameters
             request_options: Additional options to customize the HTTP request

magic_hour/resources/v1/ai_gif_generator/README.md

@@ -10,7 +10,7 @@ Create an AI GIF. Each GIF costs 50 credits.
 | Parameter | Required | Description | Example |
 |-----------|:--------:|-------------|--------|
 | `style` | ✓ |  | `{"prompt": "Cute dancing cat, pixel art"}` |
-| `name` | ✗ | The name of gif | `"Ai Gif gif"` |
+| `name` | ✗ | The name of gif. This value is mainly used for your own identification of the gif. | `"Ai Gif gif"` |
 
 #### Synchronous Client
 
@@ -44,4 +44,4 @@ res = await client.v1.ai_gif_generator.create(
 [V1AiGifGeneratorCreateResponse](/magic_hour/types/models/v1_ai_gif_generator_create_response.py)
 
 ##### Example
-`{"credits_charged": 50, "frame_cost": 50, "id": "clx7uu86w0a5qp55yxz315r6r"}`
+`{"credits_charged": 50, "frame_cost": 50, "id": "cuid-example"}`

magic_hour/resources/v1/ai_gif_generator/client.py

@@ -32,7 +32,7 @@ class AiGifGeneratorClient:
         POST /v1/ai-gif-generator
 
         Args:
-            name: The name of gif
+            name: The name of gif. This value is mainly used for your own identification of the gif.
             style: V1AiGifGeneratorCreateBodyStyle
             request_options: Additional options to customize the HTTP request
 
@@ -85,7 +85,7 @@ class AsyncAiGifGeneratorClient:
         POST /v1/ai-gif-generator
 
         Args:
-            name: The name of gif
+            name: The name of gif. This value is mainly used for your own identification of the gif.
             style: V1AiGifGeneratorCreateBodyStyle
             request_options: Additional options to customize the HTTP request
 

magic_hour/resources/v1/ai_headshot_generator/README.md

@@ -10,8 +10,8 @@ Create an AI headshot. Each headshot costs 50 credits.
 | 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"}` |
+| `name` | ✗ | The name of image. This value is mainly used for your own identification of the image. | `"Ai Headshot image"` |
+| `style` | ✗ |  | `{}` |
 
 #### Synchronous Client
 
@@ -45,4 +45,4 @@ res = await client.v1.ai_headshot_generator.create(
 [V1AiHeadshotGeneratorCreateResponse](/magic_hour/types/models/v1_ai_headshot_generator_create_response.py)
 
 ##### Example
-`{"credits_charged": 50, "frame_cost": 50, "id": "clx7uu86w0a5qp55yxz315r6r"}`
+`{"credits_charged": 50, "frame_cost": 50, "id": "cuid-example"}`

magic_hour/resources/v1/ai_headshot_generator/client.py

@@ -36,7 +36,7 @@ class AiHeadshotGeneratorClient:
         POST /v1/ai-headshot-generator
 
         Args:
-            name: The name of image
+            name: The name of image. This value is mainly used for your own identification of the image.
             style: V1AiHeadshotGeneratorCreateBodyStyle
             assets: Provide the assets for headshot photo
             request_options: Additional options to customize the HTTP request
@@ -95,7 +95,7 @@ class AsyncAiHeadshotGeneratorClient:
         POST /v1/ai-headshot-generator
 
         Args:
-            name: The name of image
+            name: The name of image. This value is mainly used for your own identification of the image.
             style: V1AiHeadshotGeneratorCreateBodyStyle
             assets: Provide the assets for headshot photo
             request_options: Additional options to customize the HTTP request

magic_hour/resources/v1/ai_image_editor/README.md

@@ -11,7 +11,7 @@ Edit images with AI. Each edit costs 50 credits.
 |-----------|:--------:|-------------|--------|
 | `assets` | ✓ | Provide the assets for image edit | `{"image_file_path": "api-assets/id/1234.png"}` |
 | `style` | ✓ |  | `{"prompt": "Give me sunglasses"}` |
-| `name` | ✗ | The name of image | `"Ai Image Editor image"` |
+| `name` | ✗ | The name of image. This value is mainly used for your own identification of the image. | `"Ai Image Editor image"` |
 
 #### Synchronous Client
 
@@ -49,4 +49,4 @@ res = await client.v1.ai_image_editor.create(
 [V1AiImageEditorCreateResponse](/magic_hour/types/models/v1_ai_image_editor_create_response.py)
 
 ##### Example
-`{"credits_charged": 50, "frame_cost": 50, "id": "clx7uu86w0a5qp55yxz315r6r"}`
+`{"credits_charged": 50, "frame_cost": 50, "id": "cuid-example"}`

magic_hour/resources/v1/ai_image_editor/client.py

@@ -33,7 +33,7 @@ class AiImageEditorClient:
         POST /v1/ai-image-editor
 
         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 image edit
             style: V1AiImageEditorCreateBodyStyle
             request_options: Additional options to customize the HTTP request
@@ -90,7 +90,7 @@ class AsyncAiImageEditorClient:
         POST /v1/ai-image-editor
 
         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 image edit
             style: V1AiImageEditorCreateBodyStyle
             request_options: Additional options to customize the HTTP request

magic_hour/resources/v1/ai_image_generator/README.md

@@ -9,10 +9,10 @@ Create an AI image. Each image costs 5 credits.
 
 | 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"` |
+| `image_count` | ✓ | Number of images to generate. | `1` |
+| `orientation` | ✓ | The orientation of the output image(s). | `"landscape"` |
+| `style` | ✓ | The art style to use for image generation. | `{"prompt": "Cool image", "tool": "ai-anime-generator"}` |
+| `name` | ✗ | The name of image. This value is mainly used for your own identification of the image. | `"Ai Image image"` |
 
 #### Synchronous Client
 
@@ -52,4 +52,4 @@ res = await client.v1.ai_image_generator.create(
 [V1AiImageGeneratorCreateResponse](/magic_hour/types/models/v1_ai_image_generator_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/ai_image_generator/client.py

@@ -35,10 +35,10 @@ class AiImageGeneratorClient:
         POST /v1/ai-image-generator
 
         Args:
-            name: The name of image
-            image_count: number to images to generate
-            orientation: typing_extensions.Literal["landscape", "portrait", "square"]
-            style: V1AiImageGeneratorCreateBodyStyle
+            name: The name of image. This value is mainly used for your own identification of the image.
+            image_count: Number of images to generate.
+            orientation: The orientation of the output image(s).
+            style: The art style to use for image generation.
             request_options: Additional options to customize the HTTP request
 
         Returns:
@@ -100,10 +100,10 @@ class AsyncAiImageGeneratorClient:
         POST /v1/ai-image-generator
 
         Args:
-            name: The name of image
-            image_count: number to images to generate
-            orientation: typing_extensions.Literal["landscape", "portrait", "square"]
-            style: V1AiImageGeneratorCreateBodyStyle
+            name: The name of image. This value is mainly used for your own identification of the image.
+            image_count: Number of images to generate.
+            orientation: The orientation of the output image(s).
+            style: The art style to use for image generation.
             request_options: Additional options to customize the HTTP request
 
         Returns:

magic_hour/resources/v1/ai_image_upscaler/README.md

@@ -10,9 +10,9 @@ Upscale your image using AI. Each 2x upscale costs 50 credits, and 4x upscale co
 | 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` |
+| `scale_factor` | ✓ | How much to scale the image. Must be either 2 or 4.              Note: 4x upscale is only available on Creator, Pro, or Business tier. | `2.0` |
 | `style` | ✓ |  | `{"enhancement": "Balanced"}` |
-| `name` | ✗ | The name of image | `"Image Upscaler image"` |
+| `name` | ✗ | The name of image. This value is mainly used for your own identification of the image. | `"Image Upscaler image"` |
 
 #### Synchronous Client
 
@@ -52,4 +52,4 @@ res = await client.v1.ai_image_upscaler.create(
 [V1AiImageUpscalerCreateResponse](/magic_hour/types/models/v1_ai_image_upscaler_create_response.py)
 
 ##### Example
-`{"credits_charged": 50, "frame_cost": 50, "id": "clx7uu86w0a5qp55yxz315r6r"}`
+`{"credits_charged": 50, "frame_cost": 50, "id": "cuid-example"}`

magic_hour/resources/v1/ai_image_upscaler/client.py

@@ -34,9 +34,11 @@ class AiImageUpscalerClient:
         POST /v1/ai-image-upscaler
 
         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 upscaling
-            scale_factor: How much to scale the image. Must be either 2 or 4
+            scale_factor: How much to scale the image. Must be either 2 or 4.
+
+        Note: 4x upscale is only available on Creator, Pro, or Business tier.
             style: V1AiImageUpscalerCreateBodyStyle
             request_options: Additional options to customize the HTTP request
 
@@ -99,9 +101,11 @@ class AsyncAiImageUpscalerClient:
         POST /v1/ai-image-upscaler
 
         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 upscaling
-            scale_factor: How much to scale the image. Must be either 2 or 4
+            scale_factor: How much to scale the image. Must be either 2 or 4.
+
+        Note: 4x upscale is only available on Creator, Pro, or Business tier.
             style: V1AiImageUpscalerCreateBodyStyle
             request_options: Additional options to customize the HTTP request
 

magic_hour/resources/v1/ai_meme_generator/README.md

@@ -54,4 +54,4 @@ res = await client.v1.ai_meme_generator.create(
 [V1AiMemeGeneratorCreateResponse](/magic_hour/types/models/v1_ai_meme_generator_create_response.py)
 
 ##### Example
-`{"credits_charged": 10, "frame_cost": 10, "id": "clx7uu86w0a5qp55yxz315r6r"}`
+`{"credits_charged": 10, "frame_cost": 10, "id": "cuid-example"}`

magic_hour/resources/v1/ai_photo_editor/README.md

@@ -14,7 +14,7 @@ Edit photo using AI. Each photo costs 10 credits.
 | `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"` |
+| `name` | ✗ | The name of image. This value is mainly used for your own identification of the 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` |
 
 #### Synchronous Client
@@ -73,4 +73,4 @@ res = await client.v1.ai_photo_editor.create(
 [V1AiPhotoEditorCreateResponse](/magic_hour/types/models/v1_ai_photo_editor_create_response.py)
 
 ##### Example
-`{"credits_charged": 10, "frame_cost": 10, "id": "clx7uu86w0a5qp55yxz315r6r"}`
+`{"credits_charged": 10, "frame_cost": 10, "id": "cuid-example"}`

magic_hour/resources/v1/ai_photo_editor/client.py

@@ -39,7 +39,7 @@ class AiPhotoEditorClient:
         POST /v1/ai-photo-editor
 
         Args:
-            name: The name of image
+            name: The name of image. This value is mainly used for your own identification of the 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.
             assets: Provide the assets for photo editor
             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
@@ -120,7 +120,7 @@ class AsyncAiPhotoEditorClient:
         POST /v1/ai-photo-editor
 
         Args:
-            name: The name of image
+            name: The name of image. This value is mainly used for your own identification of the 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.
             assets: Provide the assets for photo editor
             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

magic_hour/resources/v1/ai_qr_code_generator/README.md

@@ -11,7 +11,7 @@ Create an AI QR code. Each QR code costs 20 credits.
 |-----------|:--------:|-------------|--------|
 | `content` | ✓ | The content of the QR code. | `"https://magichour.ai"` |
 | `style` | ✓ |  | `{"art_style": "Watercolor"}` |
-| `name` | ✗ | The name of image | `"Qr Code image"` |
+| `name` | ✗ | The name of image. This value is mainly used for your own identification of the image. | `"Qr Code image"` |
 
 #### Synchronous Client
 
@@ -49,4 +49,4 @@ res = await client.v1.ai_qr_code_generator.create(
 [V1AiQrCodeGeneratorCreateResponse](/magic_hour/types/models/v1_ai_qr_code_generator_create_response.py)
 
 ##### Example
-`{"credits_charged": 20, "frame_cost": 20, "id": "clx7uu86w0a5qp55yxz315r6r"}`
+`{"credits_charged": 20, "frame_cost": 20, "id": "cuid-example"}`

magic_hour/resources/v1/ai_qr_code_generator/client.py

@@ -33,7 +33,7 @@ class AiQrCodeGeneratorClient:
         POST /v1/ai-qr-code-generator
 
         Args:
-            name: The name of image
+            name: The name of image. This value is mainly used for your own identification of the image.
             content: The content of the QR code.
             style: V1AiQrCodeGeneratorCreateBodyStyle
             request_options: Additional options to customize the HTTP request
@@ -90,7 +90,7 @@ class AsyncAiQrCodeGeneratorClient:
         POST /v1/ai-qr-code-generator
 
         Args:
-            name: The name of image
+            name: The name of image. This value is mainly used for your own identification of the image.
             content: The content of the QR code.
             style: V1AiQrCodeGeneratorCreateBodyStyle
             request_options: Additional options to customize the HTTP request

magic_hour/resources/v1/ai_talking_photo/README.md

@@ -12,7 +12,7 @@ Create a talking photo from an image and audio or text input.
 | `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 60 seconds. | `15.0` |
 | `start_seconds` | ✓ | The start time of the input audio in seconds. The maximum duration allowed is 60 seconds. | `0.0` |
-| `name` | ✗ | The name of image | `"Talking Photo image"` |
+| `name` | ✗ | The name of image. This value is mainly used for your own identification of the image. | `"Talking Photo image"` |
 | `style` | ✗ | Attributes used to dictate the style of the output | `{"generation_mode": "expressive", "intensity": 1.5}` |
 
 #### Synchronous Client
@@ -59,4 +59,4 @@ res = await client.v1.ai_talking_photo.create(
 [V1AiTalkingPhotoCreateResponse](/magic_hour/types/models/v1_ai_talking_photo_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/ai_talking_photo/client.py

@@ -37,7 +37,7 @@ class AiTalkingPhotoClient:
         POST /v1/ai-talking-photo
 
         Args:
-            name: The name of image
+            name: The name of image. This value is mainly used for your own identification of the image.
             style: Attributes used to dictate the style of the output
             assets: Provide the assets for creating a talking photo
             end_seconds: The end time of the input audio in seconds. The maximum duration allowed is 60 seconds.
@@ -110,7 +110,7 @@ class AsyncAiTalkingPhotoClient:
         POST /v1/ai-talking-photo
 
         Args:
-            name: The name of image
+            name: The name of image. This value is mainly used for your own identification of the image.
             style: Attributes used to dictate the style of the output
             assets: Provide the assets for creating a talking photo
             end_seconds: The end time of the input audio in seconds. The maximum duration allowed is 60 seconds.

magic_hour/resources/v1/animation/README.md

@@ -10,12 +10,12 @@ Create a Animation video. The estimated frame cost is calculated based on the `f
 | 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` |
+| `end_seconds` | ✓ | This value determines the duration of the output video. | `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}` |
+| `style` | ✓ | Defines the style of the output video | `{"art_style": "Painterly Illustration", "camera_effect": "Simple Zoom In", "prompt": "Cyberpunk city", "prompt_type": "custom", "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"` |
+| `name` | ✗ | The name of video. This value is mainly used for your own identification of the video. | `"Animation video"` |
 
 #### Synchronous Client
 
@@ -35,9 +35,9 @@ res = client.v1.animation.create(
     height=960,
     style={
         "art_style": "Painterly Illustration",
-        "camera_effect": "Accelerate",
+        "camera_effect": "Simple Zoom In",
         "prompt": "Cyberpunk city",
-        "prompt_type": "ai_choose",
+        "prompt_type": "custom",
         "transition_speed": 5,
     },
     width=512,
@@ -64,9 +64,9 @@ res = await client.v1.animation.create(
     height=960,
     style={
         "art_style": "Painterly Illustration",
-        "camera_effect": "Accelerate",
+        "camera_effect": "Simple Zoom In",
         "prompt": "Cyberpunk city",
-        "prompt_type": "ai_choose",
+        "prompt_type": "custom",
         "transition_speed": 5,
     },
     width=512,
@@ -81,4 +81,4 @@ res = await client.v1.animation.create(
 [V1AnimationCreateResponse](/magic_hour/types/models/v1_animation_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/animation/client.py

@@ -37,9 +37,9 @@ class AnimationClient:
         POST /v1/animation
 
         Args:
-            name: The name of video
+            name: The name of video. This value is mainly used for your own identification of the video.
             assets: Provide the assets for animation.
-            end_seconds: The end time of the input video in seconds
+            end_seconds: This value determines the duration of the output video.
             fps: The desire output video frame rate
             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
             style: Defines the style of the output video
@@ -66,9 +66,9 @@ class AnimationClient:
             height=960,
             style={
                 "art_style": "Painterly Illustration",
-                "camera_effect": "Accelerate",
+                "camera_effect": "Simple Zoom In",
                 "prompt": "Cyberpunk city",
-                "prompt_type": "ai_choose",
+                "prompt_type": "custom",
                 "transition_speed": 5,
             },
             width=512,
@@ -124,9 +124,9 @@ class AsyncAnimationClient:
         POST /v1/animation
 
         Args:
-            name: The name of video
+            name: The name of video. This value is mainly used for your own identification of the video.
             assets: Provide the assets for animation.
-            end_seconds: The end time of the input video in seconds
+            end_seconds: This value determines the duration of the output video.
             fps: The desire output video frame rate
             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
             style: Defines the style of the output video
@@ -153,9 +153,9 @@ class AsyncAnimationClient:
             height=960,
             style={
                 "art_style": "Painterly Illustration",
-                "camera_effect": "Accelerate",
+                "camera_effect": "Simple Zoom In",
                 "prompt": "Cyberpunk city",
-                "prompt_type": "ai_choose",
+                "prompt_type": "custom",
                 "transition_speed": 5,
             },
             width=512,

magic_hour/resources/v1/auto_subtitle_generator/README.md

@@ -10,10 +10,10 @@ Automatically generate subtitles for your video in multiple languages.
 | Parameter | Required | Description | Example |
 |-----------|:--------:|-------------|--------|
 | `assets` | ✓ | Provide the assets for auto subtitle generator | `{"video_file_path": "api-assets/id/1234.mp4"}` |
-| `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` |
+| `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` | ✓ | Style of the subtitle. At least one of `.style.template` or `.style.custom_config` must be provided.  * If only `.style.template` is provided, default values for the template will be used. * If both are provided, the fields in `.style.custom_config` will be used to overwrite the fields in `.style.template`. * If only `.style.custom_config` is provided, then all fields in `.style.custom_config` will be used.  To use custom config only, the following `custom_config` params are required: * `.style.custom_config.font` * `.style.custom_config.text_color` * `.style.custom_config.vertical_position` * `.style.custom_config.horizontal_position`  | `{}` |
-| `name` | ✗ | The name of video | `"Auto Subtitle video"` |
+| `name` | ✗ | The name of video. This value is mainly used for your own identification of the video. | `"Auto Subtitle video"` |
 
 #### Synchronous Client
 
@@ -55,4 +55,4 @@ res = await client.v1.auto_subtitle_generator.create(
 [V1AutoSubtitleGeneratorCreateResponse](/magic_hour/types/models/v1_auto_subtitle_generator_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/auto_subtitle_generator/client.py

@@ -35,10 +35,10 @@ class AutoSubtitleGeneratorClient:
         POST /v1/auto-subtitle-generator
 
         Args:
-            name: The name of video
+            name: The name of video. This value is mainly used for your own identification of the video.
             assets: Provide the assets for auto subtitle generator
-            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: Style of the subtitle. At least one of `.style.template` or `.style.custom_config` must be provided.
         * If only `.style.template` is provided, default values for the template will be used.
         * If both are provided, the fields in `.style.custom_config` will be used to overwrite the fields in `.style.template`.
@@ -114,10 +114,10 @@ class AsyncAutoSubtitleGeneratorClient:
         POST /v1/auto-subtitle-generator
 
         Args:
-            name: The name of video
+            name: The name of video. This value is mainly used for your own identification of the video.
             assets: Provide the assets for auto subtitle generator
-            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: Style of the subtitle. At least one of `.style.template` or `.style.custom_config` must be provided.
         * If only `.style.template` is provided, default values for the template will be used.
         * If both are provided, the fields in `.style.custom_config` will be used to overwrite the fields in `.style.template`.