magic_hour 0.36.1

Python SDK for Magic Hour API

Magic Hour Python SDK

The Magic Hour Python Library provides convenient access to the Magic Hour API. This library offers both synchronous and asynchronous clients powered by 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.

Install

pip install magic_hour

Synchronous Client Usage

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",
        "source/image": "/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

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)

# 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

# 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

v1.ai_clothes_changer

• create - AI Clothes Changer
• generate - AI Clothes Changer Generate Workflow

v1.ai_face_editor

• create - AI Face Editor
• generate - Ai Face Editor Generate Workflow

v1.ai_gif_generator

• create - AI GIFs
• generate - Ai Gif Generator Generate Workflow

v1.ai_headshot_generator

• create - AI Headshots
• generate - Ai Headshot Generator Generate Workflow

v1.ai_image_editor

• create - AI Image Editor
• generate - Ai Image Editor Generate Workflow

v1.ai_image_generator

• create - AI Images
• generate - Ai Image Generator Generate Workflow

v1.ai_image_upscaler

• create - AI Image Upscaler
• generate - Ai Image Upscaler Generate Workflow

v1.ai_meme_generator

• create - AI Meme Generator
• generate - Ai Meme Generator Generate Workflow

v1.ai_photo_editor

• create - AI Photo Editor
• generate - Ai Photo Editor Generate Workflow

v1.ai_qr_code_generator

• create - AI QR Code
• generate - Ai Qr Code Generator Generate Workflow

v1.ai_talking_photo

• create - AI Talking Photo
• generate - Ai Talking Photo Generate Workflow

v1.animation

• create - Animation
• generate - Animation Generate Workflow

v1.auto_subtitle_generator

• create - Auto Subtitle Generator
• generate - Auto Subtitle Generator Generate Workflow

v1.face_detection

• create - Face Detection
• generate - Face Detection Generate Workflow
• get - Get face detection details

v1.face_swap

• create - Face Swap video
• generate - Face Swap Generate Workflow

v1.face_swap_photo

• create - Face Swap Photo
• generate - Face Swap Photo Generate Workflow

v1.files

• upload-file - Upload File

v1.files.upload_urls

• create - Generate asset upload urls

v1.image_background_remover

• create - Image Background Remover
• generate - Image Background Remover Generate Workflow

v1.image_projects

• check-result - Check results
• delete - Delete image
• get - Get image details

v1.image_to_video

• create - Image-to-Video
• generate - Image To Video Generate Workflow

v1.lip_sync

• create - Lip Sync
• generate - Lip Sync Generate Workflow

v1.photo_colorizer

• create - Photo Colorizer
• generate - Photo Colorizer Generate Workflow

v1.text_to_video

• create - Text-to-Video
• generate - Text To Video Generate Workflow

v1.video_projects

• check-result - Check results
• delete - Delete video
• get - Get video details

v1.video_to_video

• create - Video-to-Video
• generate - Video To Video Generate Workflow