magic_hour 0.9.5__py3-none-any.whl → 0.44.0__py3-none-any.whl

magic_hour/types/params/{post_v1_video_to_video_body_style.py → v1_video_to_video_create_body_style.py}

@@ -3,9 +3,9 @@ import typing
 import typing_extensions
 
 
-class PostV1VideoToVideoBodyStyle(typing_extensions.TypedDict):
+class V1VideoToVideoCreateBodyStyle(typing_extensions.TypedDict):
     """
-    PostV1VideoToVideoBodyStyle
+    V1VideoToVideoCreateBodyStyle
     """
 
     art_style: typing_extensions.Required[
@@ -19,7 +19,9 @@ class PostV1VideoToVideoBodyStyle(typing_extensions.TypedDict):
             "Avatar",
             "Black Spiderman",
             "Boba Fett",
+            "Bold Anime",
             "Celestial Skin",
+            "Chinese Swordsmen",
             "Clay",
             "Comic",
             "Cyberpunk",
@@ -29,6 +31,7 @@ class PostV1VideoToVideoBodyStyle(typing_extensions.TypedDict):
             "Future Bot",
             "Futuristic Fantasy",
             "GTA",
+            "Ghibli Anime",
             "Ghost",
             "Gundam",
             "Hologram",
@@ -41,21 +44,31 @@ class PostV1VideoToVideoBodyStyle(typing_extensions.TypedDict):
             "Lego",
             "Link",
             "Marble",
+            "Mario",
             "Master Chief",
             "Mech",
             "Minecraft",
+            "Mystique",
             "Naruto",
             "Neon Dream",
+            "No Art Style",
             "Oil Painting",
             "On Fire",
             "Origami",
+            "Painterly Anime",
+            "Pixar",
             "Pixel",
             "Power Armor",
             "Power Ranger",
+            "Radiant Anime",
+            "Realistic Anime",
+            "Realistic Pixar",
             "Retro Anime",
             "Retro Sci-Fi",
             "Samurai",
             "Samurai Bot",
+            "Sharp Anime",
+            "Soft Anime",
             "Solid Snake",
             "Spartan",
             "Starfield",
@@ -63,33 +76,43 @@ class PostV1VideoToVideoBodyStyle(typing_extensions.TypedDict):
             "Studio Ghibli",
             "Sub-Zero",
             "The Void",
+            "Tomb Raider",
             "Underwater",
             "Van Gogh",
             "Viking",
             "Watercolor",
+            "Western Anime",
             "Wu Kong",
+            "Wuxia Anime",
             "Zelda",
         ]
     ]
 
-    model: typing_extensions.Required[
+    model: typing_extensions.NotRequired[
         typing_extensions.Literal[
-            "Absolute Reality", "Dreamshaper", "Flat 2D Anime", "default"
+            "3D Anime",
+            "Absolute Reality",
+            "Dreamshaper",
+            "Flat 2D Anime",
+            "Kaywaii",
+            "Soft Anime",
+            "Western Anime",
+            "default",
         ]
     ]
     """
-    * `Dreamshaper` - a good all-around model that works for both animations as well as realism. 
-    * `Absolute Reality` - better at realism, but you'll often get similar results with Dreamshaper as well. 
+    * `Dreamshaper` - a good all-around model that works for both animations as well as realism.
+    * `Absolute Reality` - better at realism, but you'll often get similar results with Dreamshaper as well.
     * `Flat 2D Anime` - best for a flat illustration style that's common in most anime.
     * `default` - use the default recommended model for the selected art style.
     """
 
-    prompt: typing_extensions.Required[typing.Optional[str]]
+    prompt: typing_extensions.NotRequired[typing.Optional[str]]
     """
     The prompt used for the video. Prompt is required if `prompt_type` is `custom` or `append_default`. If `prompt_type` is `default`, then the `prompt` value passed will be ignored.
     """
 
-    prompt_type: typing_extensions.Required[
+    prompt_type: typing_extensions.NotRequired[
         typing_extensions.Literal["append_default", "custom", "default"]
     ]
     """
@@ -98,7 +121,7 @@ class PostV1VideoToVideoBodyStyle(typing_extensions.TypedDict):
     * `append_default` - Add the default recommended prompt to the end of the prompt passed in the API.
     """
 
-    version: typing_extensions.Required[
+    version: typing_extensions.NotRequired[
         typing_extensions.Literal["default", "v1", "v2"]
     ]
     """
@@ -108,9 +131,9 @@ class PostV1VideoToVideoBodyStyle(typing_extensions.TypedDict):
     """
 
 
-class _SerializerPostV1VideoToVideoBodyStyle(pydantic.BaseModel):
+class _SerializerV1VideoToVideoCreateBodyStyle(pydantic.BaseModel):
     """
-    Serializer for PostV1VideoToVideoBodyStyle handling case conversions
+    Serializer for V1VideoToVideoCreateBodyStyle handling case conversions
     and file omissions as dictated by the API
     """
 
@@ -128,7 +151,9 @@ class _SerializerPostV1VideoToVideoBodyStyle(pydantic.BaseModel):
         "Avatar",
         "Black Spiderman",
         "Boba Fett",
+        "Bold Anime",
         "Celestial Skin",
+        "Chinese Swordsmen",
         "Clay",
         "Comic",
         "Cyberpunk",
@@ -138,6 +163,7 @@ class _SerializerPostV1VideoToVideoBodyStyle(pydantic.BaseModel):
         "Future Bot",
         "Futuristic Fantasy",
         "GTA",
+        "Ghibli Anime",
         "Ghost",
         "Gundam",
         "Hologram",
@@ -150,21 +176,31 @@ class _SerializerPostV1VideoToVideoBodyStyle(pydantic.BaseModel):
         "Lego",
         "Link",
         "Marble",
+        "Mario",
         "Master Chief",
         "Mech",
         "Minecraft",
+        "Mystique",
         "Naruto",
         "Neon Dream",
+        "No Art Style",
         "Oil Painting",
         "On Fire",
         "Origami",
+        "Painterly Anime",
+        "Pixar",
         "Pixel",
         "Power Armor",
         "Power Ranger",
+        "Radiant Anime",
+        "Realistic Anime",
+        "Realistic Pixar",
         "Retro Anime",
         "Retro Sci-Fi",
         "Samurai",
         "Samurai Bot",
+        "Sharp Anime",
+        "Soft Anime",
         "Solid Snake",
         "Spartan",
         "Starfield",
@@ -172,28 +208,34 @@ class _SerializerPostV1VideoToVideoBodyStyle(pydantic.BaseModel):
         "Studio Ghibli",
         "Sub-Zero",
         "The Void",
+        "Tomb Raider",
         "Underwater",
         "Van Gogh",
         "Viking",
         "Watercolor",
+        "Western Anime",
         "Wu Kong",
+        "Wuxia Anime",
         "Zelda",
     ] = pydantic.Field(
         alias="art_style",
     )
-    model: typing_extensions.Literal[
-        "Absolute Reality", "Dreamshaper", "Flat 2D Anime", "default"
-    ] = pydantic.Field(
-        alias="model",
-    )
-    prompt: typing.Optional[str] = pydantic.Field(
-        alias="prompt",
-    )
-    prompt_type: typing_extensions.Literal["append_default", "custom", "default"] = (
-        pydantic.Field(
-            alias="prompt_type",
-        )
-    )
-    version: typing_extensions.Literal["default", "v1", "v2"] = pydantic.Field(
-        alias="version",
+    model: typing.Optional[
+        typing_extensions.Literal[
+            "3D Anime",
+            "Absolute Reality",
+            "Dreamshaper",
+            "Flat 2D Anime",
+            "Kaywaii",
+            "Soft Anime",
+            "Western Anime",
+            "default",
+        ]
+    ] = pydantic.Field(alias="model", default=None)
+    prompt: typing.Optional[str] = pydantic.Field(alias="prompt", default=None)
+    prompt_type: typing.Optional[
+        typing_extensions.Literal["append_default", "custom", "default"]
+    ] = pydantic.Field(alias="prompt_type", default=None)
+    version: typing.Optional[typing_extensions.Literal["default", "v1", "v2"]] = (
+        pydantic.Field(alias="version", default=None)
     )

magic_hour/types/params/v1_video_to_video_generate_body_assets.py

@@ -0,0 +1,27 @@
+import pydantic
+import typing
+import typing_extensions
+
+
+class V1VideoToVideoGenerateBodyAssets(typing_extensions.TypedDict):
+    """
+    Provide the assets for video-to-video. For video, The `video_source` field determines whether `video_file_path` or `youtube_url` field is used
+    """
+
+    video_file_path: typing_extensions.NotRequired[str]
+    """
+    Required if `video_source` is `file`. This value is either
+    - a direct URL to the video file
+    - a path to a local file
+
+    Note: if the path begins with `api-assets`, it will be assumed to already be uploaded to Magic Hour's storage, and will not be uploaded again.
+    """
+
+    video_source: typing_extensions.Required[
+        typing_extensions.Literal["file", "youtube"]
+    ]
+
+    youtube_url: typing_extensions.NotRequired[str]
+    """
+    Using a youtube video as the input source. This field is required if `video_source` is `youtube`
+    """

magic_hour-0.44.0.dist-info/METADATA

@@ -0,0 +1,328 @@
+Metadata-Version: 2.1
+Name: magic_hour
+Version: 0.44.0
+Summary: Python SDK for Magic Hour API
+Requires-Python: >=3.8,<4.0
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: make-api-request (>=0.1.3,<0.2.0)
+Description-Content-Type: text/markdown
+
+# Magic Hour Python SDK
+
+[![PyPI - Version](https://img.shields.io/pypi/v/magic_hour)](https://pypi.org/project/magic_hour/)
+
+The Magic Hour Python Library provides convenient access to the Magic Hour API. This library offers both synchronous and asynchronous clients powered by [httpx](https://github.com/encode/httpx).
+
+## Documentation
+
+For full documentation of all APIs, please visit https://docs.magichour.ai
+
+If you have any questions, please reach out to us via [discord](https://discord.gg/JX5rgsZaJp).
+
+## Install
+
+```sh
+pip install magic_hour
+```
+
+## Cookbook
+
+For end-to-end examples demonstrating all available Magic Hour APIs, check out our interactive Google Colab cookbook:
+
+- **Interactive Notebook**: [Magic Hour API Cookbook](https://colab.research.google.com/drive/1NTHL_lr_s-qBJ-mSecSXPzRLi9_V5JiU?usp=sharing)
+
+The cookbook includes:
+
+- Setup instructions
+- Examples for all available APIs (image generation, face swap, lip sync, video generation, and more)
+- Display helpers for previewing outputs
+- Production-ready patterns and best practices
+
+## Synchronous Client Usage
+
+```python
+from magic_hour import Client
+
+# generate your API Key at https://magichour.ai/developer
+client = Client(token="my api key")
+
+response = client.v1.face_swap_photo.generate(
+    assets={
+        "face_swap_mode": "all-faces",
+        "source_file_path": "/path/to/source/image.png",
+        "target_file_path": "/path/to/target/image.png",
+    },
+    name="Face Swap image",
+    wait_for_completion=True,
+    download_outputs=True,
+    download_directory="./outputs/",
+)
+print(f"Project ID: {response.id}")
+print(f"Status: {response.status}")
+print(f"Downloaded files: {response.downloaded_paths}")
+```
+
+### Asynchronous Client Usage
+
+```python
+from magic_hour import AsyncClient
+
+# generate your API Key at https://magichour.ai/developer
+client = AsyncClient(token="my api key")
+
+response = await client.v1.face_swap_photo.generate(
+    assets={
+        "face_swap_mode": "all-faces",
+        "source_file_path": "/path/to/source/image.png",
+        "target_file_path": "/path/to/target/image.png",
+    },
+    name="Face Swap image",
+    wait_for_completion=True,
+    download_outputs=True,
+    download_directory="./outputs/",
+)
+print(f"Project ID: {response.id}")
+print(f"Status: {response.status}")
+print(f"Downloaded files: {response.downloaded_paths}")
+```
+
+## Client Functions
+
+Most resources that generate media content support two methods:
+
+- **`generate()`** - A high-level convenience method that handles the entire workflow
+- **`create()`** - A low-level method that only initiates the generation process
+
+### Generate Function
+
+The `generate()` function provides a complete end-to-end solution:
+
+- Uploads local file to Magic Hour storage
+- Calls the API to start generation
+- Automatically polls for completion
+- Downloads generated files to your local machine
+- Returns both API response data and local file paths
+
+**Additional Parameters:**
+
+- `wait_for_completion` (bool, default True): Whether to wait for the project to complete.
+- `download_outputs` (bool, default True): Whether to download the generated files
+- `download_directory` (str, optional): Directory to save downloaded files (defaults to current directory)
+
+```python
+# Generate function - handles everything automatically
+response = client.v1.ai_image_generator.generate(
+    style={"prompt": "A beautiful sunset over mountains"},
+    name="Sunset Image",
+    wait_for_completion=True,       # Wait for status to be complete/error/canceled
+    download_outputs=True,          # Download files automatically
+    download_directory="./outputs/" # Where to save files
+)
+
+# You get both the API response AND downloaded file paths
+print(f"Project ID: {response.id}")
+print(f"Status: {response.status}")
+print(f"Downloaded files: {response.downloaded_paths}")
+```
+
+### Create Function
+
+The `create()` function provides granular control:
+
+- Only calls the API to start the generation process
+- Returns immediately with a project ID and amount of credits used
+- Requires manual status checking and file downloading
+
+```python
+# Create function - only starts the process
+create_response = client.v1.ai_image_generator.create(
+    style={"prompt": "A beautiful sunset over mountains"},
+    name="Sunset Image"
+)
+
+# You get just the project ID and initial response
+project_id = create_response.id
+print(f"Started project: {project_id}")
+
+# You must handle the rest:
+# 1. Poll for completion. We provide a helper function to handle polling for you
+result = client.v1.image_projects.check_status(
+    wait_for_completion=True,
+    download_outputs=False,
+)
+# 2. Download files using the download URLs
+download_urls = result.downloads
+# download the files using your preferred way
+```
+
+### Choosing Between Which Function to use
+
+**Use `generate()` when:**
+
+- You want a simple, one-call solution
+- You're building a straightforward application
+- You don't need custom polling or download logic
+
+**Use `create()` when:**
+
+- You need custom status checking logic
+- You're integrating with existing job processing systems
+- You want to separate generation initiation from completion handling
+- You need fine-grained control over the entire workflow
+
+## Module Documentation and Snippets
+
+### [v1.ai_clothes_changer](magic_hour/resources/v1/ai_clothes_changer/README.md)
+
+- [create](magic_hour/resources/v1/ai_clothes_changer/README.md#create) - AI Clothes Changer
+- [generate](magic_hour/resources/v1/ai_clothes_changer/README.md#generate) - AI Clothes Changer Generate Workflow
+
+### [v1.ai_face_editor](magic_hour/resources/v1/ai_face_editor/README.md)
+
+- [create](magic_hour/resources/v1/ai_face_editor/README.md#create) - AI Face Editor
+- [generate](magic_hour/resources/v1/ai_face_editor/README.md#generate) - Ai Face Editor Generate Workflow
+
+### [v1.ai_gif_generator](magic_hour/resources/v1/ai_gif_generator/README.md)
+
+- [create](magic_hour/resources/v1/ai_gif_generator/README.md#create) - AI GIF Generator
+- [generate](magic_hour/resources/v1/ai_gif_generator/README.md#generate) - Ai Gif Generator Generate Workflow
+
+### [v1.ai_headshot_generator](magic_hour/resources/v1/ai_headshot_generator/README.md)
+
+- [create](magic_hour/resources/v1/ai_headshot_generator/README.md#create) - AI Headshot Generator
+- [generate](magic_hour/resources/v1/ai_headshot_generator/README.md#generate) - Ai Headshot Generator Generate Workflow
+
+### [v1.ai_image_editor](magic_hour/resources/v1/ai_image_editor/README.md)
+
+- [create](magic_hour/resources/v1/ai_image_editor/README.md#create) - AI Image Editor
+- [generate](magic_hour/resources/v1/ai_image_editor/README.md#generate) - Ai Image Editor Generate Workflow
+
+### [v1.ai_image_generator](magic_hour/resources/v1/ai_image_generator/README.md)
+
+- [create](magic_hour/resources/v1/ai_image_generator/README.md#create) - AI Image Generator
+- [generate](magic_hour/resources/v1/ai_image_generator/README.md#generate) - Ai Image Generator Generate Workflow
+
+### [v1.ai_image_upscaler](magic_hour/resources/v1/ai_image_upscaler/README.md)
+
+- [create](magic_hour/resources/v1/ai_image_upscaler/README.md#create) - AI Image Upscaler
+- [generate](magic_hour/resources/v1/ai_image_upscaler/README.md#generate) - Ai Image Upscaler Generate Workflow
+
+### [v1.ai_meme_generator](magic_hour/resources/v1/ai_meme_generator/README.md)
+
+- [create](magic_hour/resources/v1/ai_meme_generator/README.md#create) - AI Meme Generator
+- [generate](magic_hour/resources/v1/ai_meme_generator/README.md#generate) - Ai Meme Generator Generate Workflow
+
+### [v1.ai_photo_editor](magic_hour/resources/v1/ai_photo_editor/README.md)
+
+- [create](magic_hour/resources/v1/ai_photo_editor/README.md#create) - AI Photo Editor
+- [generate](magic_hour/resources/v1/ai_photo_editor/README.md#generate) - Ai Photo Editor Generate Workflow
+
+### [v1.ai_qr_code_generator](magic_hour/resources/v1/ai_qr_code_generator/README.md)
+
+- [create](magic_hour/resources/v1/ai_qr_code_generator/README.md#create) - AI QR Code Generator
+- [generate](magic_hour/resources/v1/ai_qr_code_generator/README.md#generate) - Ai Qr Code Generator Generate Workflow
+
+### [v1.ai_talking_photo](magic_hour/resources/v1/ai_talking_photo/README.md)
+
+- [create](magic_hour/resources/v1/ai_talking_photo/README.md#create) - AI Talking Photo
+- [generate](magic_hour/resources/v1/ai_talking_photo/README.md#generate) - Ai Talking Photo Generate Workflow
+
+### [v1.ai_voice_cloner](magic_hour/resources/v1/ai_voice_cloner/README.md)
+
+- [create](magic_hour/resources/v1/ai_voice_cloner/README.md#create) - AI Voice Cloner
+
+### [v1.ai_voice_generator](magic_hour/resources/v1/ai_voice_generator/README.md)
+
+- [create](magic_hour/resources/v1/ai_voice_generator/README.md#create) - AI Voice Generator
+- [generate](magic_hour/resources/v1/ai_voice_generator/README.md#generate) - Ai Talking Photo Generate Workflow
+
+### [v1.animation](magic_hour/resources/v1/animation/README.md)
+
+- [create](magic_hour/resources/v1/animation/README.md#create) - Animation
+- [generate](magic_hour/resources/v1/animation/README.md#generate) - Animation Generate Workflow
+
+### [v1.audio_projects](magic_hour/resources/v1/audio_projects/README.md)
+
+- [check-result](magic_hour/resources/v1/audio_projects/README.md#check-result) - Check results
+- [delete](magic_hour/resources/v1/audio_projects/README.md#delete) - Delete audio
+- [get](magic_hour/resources/v1/audio_projects/README.md#get) - Get audio details
+
+### [v1.auto_subtitle_generator](magic_hour/resources/v1/auto_subtitle_generator/README.md)
+
+- [create](magic_hour/resources/v1/auto_subtitle_generator/README.md#create) - Auto Subtitle Generator
+- [generate](magic_hour/resources/v1/auto_subtitle_generator/README.md#generate) - Auto Subtitle Generator Generate Workflow
+
+### [v1.face_detection](magic_hour/resources/v1/face_detection/README.md)
+
+- [create](magic_hour/resources/v1/face_detection/README.md#create) - Face Detection
+- [generate](magic_hour/resources/v1/face_detection/README.md#generate) - Face Detection Generate Workflow
+- [get](magic_hour/resources/v1/face_detection/README.md#get) - Get face detection details
+
+### [v1.face_swap](magic_hour/resources/v1/face_swap/README.md)
+
+- [create](magic_hour/resources/v1/face_swap/README.md#create) - Face Swap Video
+- [generate](magic_hour/resources/v1/face_swap/README.md#generate) - Face Swap Generate Workflow
+
+### [v1.face_swap_photo](magic_hour/resources/v1/face_swap_photo/README.md)
+
+- [create](magic_hour/resources/v1/face_swap_photo/README.md#create) - Face Swap Photo
+- [generate](magic_hour/resources/v1/face_swap_photo/README.md#generate) - Face Swap Photo Generate Workflow
+
+### [v1.files](magic_hour/resources/v1/files/README.md)
+
+- [upload-file](magic_hour/resources/v1/files/README.md#upload-file) - Upload File
+
+### [v1.files.upload_urls](magic_hour/resources/v1/files/upload_urls/README.md)
+
+- [create](magic_hour/resources/v1/files/upload_urls/README.md#create) - Generate asset upload urls
+
+### [v1.image_background_remover](magic_hour/resources/v1/image_background_remover/README.md)
+
+- [create](magic_hour/resources/v1/image_background_remover/README.md#create) - Image Background Remover
+- [generate](magic_hour/resources/v1/image_background_remover/README.md#generate) - Image Background Remover Generate Workflow
+
+### [v1.image_projects](magic_hour/resources/v1/image_projects/README.md)
+
+- [check-result](magic_hour/resources/v1/image_projects/README.md#check-result) - Check results
+- [delete](magic_hour/resources/v1/image_projects/README.md#delete) - Delete image
+- [get](magic_hour/resources/v1/image_projects/README.md#get) - Get image details
+
+### [v1.image_to_video](magic_hour/resources/v1/image_to_video/README.md)
+
+- [create](magic_hour/resources/v1/image_to_video/README.md#create) - Image-to-Video
+- [generate](magic_hour/resources/v1/image_to_video/README.md#generate) - Image To Video Generate Workflow
+
+### [v1.lip_sync](magic_hour/resources/v1/lip_sync/README.md)
+
+- [create](magic_hour/resources/v1/lip_sync/README.md#create) - Lip Sync
+- [generate](magic_hour/resources/v1/lip_sync/README.md#generate) - Lip Sync Generate Workflow
+
+### [v1.photo_colorizer](magic_hour/resources/v1/photo_colorizer/README.md)
+
+- [create](magic_hour/resources/v1/photo_colorizer/README.md#create) - Photo Colorizer
+- [generate](magic_hour/resources/v1/photo_colorizer/README.md#generate) - Photo Colorizer Generate Workflow
+
+### [v1.text_to_video](magic_hour/resources/v1/text_to_video/README.md)
+
+- [create](magic_hour/resources/v1/text_to_video/README.md#create) - Text-to-Video
+- [generate](magic_hour/resources/v1/text_to_video/README.md#generate) - Text To Video Generate Workflow
+
+### [v1.video_projects](magic_hour/resources/v1/video_projects/README.md)
+
+- [check-result](magic_hour/resources/v1/video_projects/README.md#check-result) - Check results
+- [delete](magic_hour/resources/v1/video_projects/README.md#delete) - Delete video
+- [get](magic_hour/resources/v1/video_projects/README.md#get) - Get video details
+
+### [v1.video_to_video](magic_hour/resources/v1/video_to_video/README.md)
+
+- [create](magic_hour/resources/v1/video_to_video/README.md#create) - Video-to-Video
+- [generate](magic_hour/resources/v1/video_to_video/README.md#generate) - Video To Video Generate Workflow
+
+<!-- MODULE DOCS END -->
+