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

magic_hour/resources/v1/ai_meme_generator/README.md

@@ -0,0 +1,129 @@
+# v1.ai_meme_generator
+
+## Module Functions
+
+<!-- CUSTOM DOCS START -->
+
+### Ai Meme Generator Generate Workflow <a name="generate"></a>
+
+The workflow performs the following action
+
+1. upload local assets to Magic Hour storage. So you can pass in a local path instead of having to upload files yourself
+2. trigger a generation
+3. poll for a completion status. This is configurable
+4. if success, download the output to local directory
+
+> [!TIP]
+> This is the recommended way to use the SDK unless you have specific needs where it is necessary to split up the actions.
+
+#### Parameters
+
+In Additional to the parameters listed in the `.create` section below, `.generate` introduces 3 new 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)
+
+#### Synchronous Client
+
+```python
+from magic_hour import Client
+from os import getenv
+
+client = Client(token=getenv("API_TOKEN"))
+res = client.v1.ai_meme_generator.generate(
+    style={
+        "search_web": False,
+        "template": "Drake Hotline Bling",
+        "topic": "When the code finally works",
+    },
+    name="My Funny Meme",
+    wait_for_completion=True,
+    download_outputs=True,
+    download_directory="outputs"
+)
+```
+
+#### Asynchronous Client
+
+```python
+from magic_hour import AsyncClient
+from os import getenv
+
+client = AsyncClient(token=getenv("API_TOKEN"))
+res = await client.v1.ai_meme_generator.generate(
+    style={
+        "search_web": False,
+        "template": "Drake Hotline Bling",
+        "topic": "When the code finally works",
+    },
+    name="My Funny Meme",
+    wait_for_completion=True,
+    download_outputs=True,
+    download_directory="outputs"
+)
+```
+
+<!-- CUSTOM DOCS END -->
+
+### AI Meme Generator <a name="create"></a>
+
+Create an AI generated meme. Each meme costs 10 credits.
+
+**API Endpoint**: `POST /v1/ai-meme-generator`
+
+#### Parameters
+
+| Parameter       | Required | Description                                           | Example                                                                                            |
+| --------------- | :------: | ----------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
+| `style`         |    ✓     |                                                       | `{"search_web": False, "template": "Drake Hotline Bling", "topic": "When the code finally works"}` |
+| `└─ search_web` |    ✗     | Whether to search the web for meme content.           | `False`                                                                                            |
+| `└─ template`   |    ✓     | To use our templates, pass in one of the enum values. | `"Drake Hotline Bling"`                                                                            |
+| `└─ topic`      |    ✓     | The topic of the meme.                                | `"When the code finally works"`                                                                    |
+| `name`          |    ✗     | The name of the meme.                                 | `"My Funny Meme"`                                                                                  |
+
+#### Synchronous Client
+
+```python
+from magic_hour import Client
+from os import getenv
+
+client = Client(token=getenv("API_TOKEN"))
+res = client.v1.ai_meme_generator.create(
+    style={
+        "search_web": False,
+        "template": "Drake Hotline Bling",
+        "topic": "When the code finally works",
+    },
+    name="My Funny Meme",
+)
+```
+
+#### Asynchronous Client
+
+```python
+from magic_hour import AsyncClient
+from os import getenv
+
+client = AsyncClient(token=getenv("API_TOKEN"))
+res = await client.v1.ai_meme_generator.create(
+    style={
+        "search_web": False,
+        "template": "Drake Hotline Bling",
+        "topic": "When the code finally works",
+    },
+    name="My Funny Meme",
+)
+```
+
+#### Response
+
+##### Type
+
+[V1AiMemeGeneratorCreateResponse](/magic_hour/types/models/v1_ai_meme_generator_create_response.py)
+
+##### Example
+
+```python
+{"credits_charged": 10, "frame_cost": 10, "id": "cuid-example"}
+```

magic_hour/resources/v1/ai_meme_generator/__init__.py

@@ -0,0 +1,4 @@
+from .client import AiMemeGeneratorClient, AsyncAiMemeGeneratorClient
+
+
+__all__ = ["AiMemeGeneratorClient", "AsyncAiMemeGeneratorClient"]

magic_hour/resources/v1/ai_meme_generator/client.py

@@ -0,0 +1,253 @@
+import typing
+
+from magic_hour.helpers.logger import get_sdk_logger
+from magic_hour.resources.v1.image_projects.client import (
+    AsyncImageProjectsClient,
+    ImageProjectsClient,
+)
+from magic_hour.types import models, params
+from make_api_request import (
+    AsyncBaseClient,
+    RequestOptions,
+    SyncBaseClient,
+    default_request_options,
+    to_encodable,
+    type_utils,
+)
+
+
+logger = get_sdk_logger(__name__)
+
+
+class AiMemeGeneratorClient:
+    def __init__(self, *, base_client: SyncBaseClient):
+        self._base_client = base_client
+
+    def generate(
+        self,
+        *,
+        style: params.V1AiMemeGeneratorCreateBodyStyle,
+        name: typing.Union[
+            typing.Optional[str], type_utils.NotGiven
+        ] = type_utils.NOT_GIVEN,
+        wait_for_completion: bool = True,
+        download_outputs: bool = True,
+        download_directory: typing.Optional[str] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ):
+        """
+        Generate meme (alias for create with additional functionality).
+
+        Create an AI meme. Each meme costs 5 credits.
+
+        Args:
+            name: The name of image. This value is mainly used for your own identification of the image.
+            style: The art style to use for meme generation
+            wait_for_completion: Whether to wait for the image project to complete
+            download_outputs: Whether to download the outputs
+            download_directory: The directory to download the outputs to. If not provided, the outputs will be downloaded to the current working directory
+            request_options: Additional options to customize the HTTP request
+
+        Returns:
+            V1ImageProjectsGetResponseWithDownloads: The response from the AI Meme Generator API with the downloaded paths if `download_outputs` is True.
+
+        Examples:
+        ```py
+        response = client.v1.ai_meme_generator.generate(
+            style={
+                "search_web": False,
+                "template": "Drake Hotline Bling",
+                "topic": "When the code finally works",
+            },
+            name="Funny Programming Meme",
+            wait_for_completion=True,
+            download_outputs=True,
+            download_directory="outputs/",
+        )
+        ```
+        """
+
+        create_response = self.create(
+            style=style, name=name, request_options=request_options
+        )
+        logger.info(f"AI Meme Generator response: {create_response}")
+
+        image_projects_client = ImageProjectsClient(base_client=self._base_client)
+        response = image_projects_client.check_result(
+            id=create_response.id,
+            wait_for_completion=wait_for_completion,
+            download_outputs=download_outputs,
+            download_directory=download_directory,
+        )
+
+        return response
+
+    def create(
+        self,
+        *,
+        style: params.V1AiMemeGeneratorCreateBodyStyle,
+        name: typing.Union[
+            typing.Optional[str], type_utils.NotGiven
+        ] = type_utils.NOT_GIVEN,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> models.V1AiMemeGeneratorCreateResponse:
+        """
+        AI Meme Generator
+
+        Create an AI generated meme. Each meme costs 10 credits.
+
+        POST /v1/ai-meme-generator
+
+        Args:
+            name: The name of the meme.
+            style: V1AiMemeGeneratorCreateBodyStyle
+            request_options: Additional options to customize the HTTP request
+
+        Returns:
+            Success
+
+        Raises:
+            ApiError: A custom exception class that provides additional context
+                for API errors, including the HTTP status code and response body.
+
+        Examples:
+        ```py
+        client.v1.ai_meme_generator.create(
+            style={
+                "search_web": False,
+                "template": "Drake Hotline Bling",
+                "topic": "When the code finally works",
+            },
+            name="My Funny Meme",
+        )
+        ```
+        """
+        _json = to_encodable(
+            item={"name": name, "style": style},
+            dump_with=params._SerializerV1AiMemeGeneratorCreateBody,
+        )
+        return self._base_client.request(
+            method="POST",
+            path="/v1/ai-meme-generator",
+            auth_names=["bearerAuth"],
+            json=_json,
+            cast_to=models.V1AiMemeGeneratorCreateResponse,
+            request_options=request_options or default_request_options(),
+        )
+
+
+class AsyncAiMemeGeneratorClient:
+    def __init__(self, *, base_client: AsyncBaseClient):
+        self._base_client = base_client
+
+    async def generate(
+        self,
+        *,
+        style: params.V1AiMemeGeneratorCreateBodyStyle,
+        name: typing.Union[
+            typing.Optional[str], type_utils.NotGiven
+        ] = type_utils.NOT_GIVEN,
+        wait_for_completion: bool = True,
+        download_outputs: bool = True,
+        download_directory: typing.Optional[str] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ):
+        """
+        Generate meme (alias for create with additional functionality).
+
+        Create an AI meme. Each meme costs 5 credits.
+
+        Args:
+            name: The name of image. This value is mainly used for your own identification of the image.
+            style: The art style to use for meme generation
+            wait_for_completion: Whether to wait for the image project to complete
+            download_outputs: Whether to download the outputs
+            download_directory: The directory to download the outputs to. If not provided, the outputs will be downloaded to the current working directory
+            request_options: Additional options to customize the HTTP request
+
+        Returns:
+            V1ImageProjectsGetResponseWithDownloads: The response from the AI Meme Generator API with the downloaded paths if `download_outputs` is True.
+
+        Examples:
+        ```py
+        response = await client.v1.ai_meme_generator.generate(
+            style={
+                "search_web": False,
+                "template": "Drake Hotline Bling",
+                "topic": "When the code finally works",
+            },
+            name="Funny Programming Meme",
+            wait_for_completion=True,
+            download_outputs=True,
+            download_directory="outputs/",
+        )
+        ```
+        """
+
+        create_response = await self.create(
+            style=style, name=name, request_options=request_options
+        )
+        logger.info(f"AI Meme Generator response: {create_response}")
+
+        image_projects_client = AsyncImageProjectsClient(base_client=self._base_client)
+        response = await image_projects_client.check_result(
+            id=create_response.id,
+            wait_for_completion=wait_for_completion,
+            download_outputs=download_outputs,
+            download_directory=download_directory,
+        )
+
+        return response
+
+    async def create(
+        self,
+        *,
+        style: params.V1AiMemeGeneratorCreateBodyStyle,
+        name: typing.Union[
+            typing.Optional[str], type_utils.NotGiven
+        ] = type_utils.NOT_GIVEN,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> models.V1AiMemeGeneratorCreateResponse:
+        """
+        AI Meme Generator
+
+        Create an AI generated meme. Each meme costs 10 credits.
+
+        POST /v1/ai-meme-generator
+
+        Args:
+            name: The name of the meme.
+            style: V1AiMemeGeneratorCreateBodyStyle
+            request_options: Additional options to customize the HTTP request
+
+        Returns:
+            Success
+
+        Raises:
+            ApiError: A custom exception class that provides additional context
+                for API errors, including the HTTP status code and response body.
+
+        Examples:
+        ```py
+        await client.v1.ai_meme_generator.create(
+            style={
+                "search_web": False,
+                "template": "Drake Hotline Bling",
+                "topic": "When the code finally works",
+            },
+            name="My Funny Meme",
+        )
+        ```
+        """
+        _json = to_encodable(
+            item={"name": name, "style": style},
+            dump_with=params._SerializerV1AiMemeGeneratorCreateBody,
+        )
+        return await self._base_client.request(
+            method="POST",
+            path="/v1/ai-meme-generator",
+            auth_names=["bearerAuth"],
+            json=_json,
+            cast_to=models.V1AiMemeGeneratorCreateResponse,
+            request_options=request_options or default_request_options(),
+        )

magic_hour/resources/v1/ai_photo_editor/README.md

@@ -1,13 +1,112 @@
+# v1.ai_photo_editor
 
-### create <a name="create"></a>
-AI Photo Editor
+## Module Functions
 
-> **NOTE**: this API is still in early development stages, and should be avoided. Please reach out to us if you're interested in this API. 
+<!-- CUSTOM DOCS START -->
 
-Edit photo using AI. Each photo costs 10 frames.
+### Ai Photo Editor Generate Workflow <a name="generate"></a>
+
+The workflow performs the following action
+
+1. upload local assets to Magic Hour storage. So you can pass in a local path instead of having to upload files yourself
+2. trigger a generation
+3. poll for a completion status. This is configurable
+4. if success, download the output to local directory
+
+> [!TIP]
+> This is the recommended way to use the SDK unless you have specific needs where it is necessary to split up the actions.
+
+#### Parameters
+
+In Additional to the parameters listed in the `.create` section below, `.generate` introduces 3 new 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)
+
+#### Synchronous Client
+
+```python
+from magic_hour import Client
+from os import getenv
+
+client = Client(token=getenv("API_TOKEN"))
+res = client.v1.ai_photo_editor.generate(
+    assets={"image_file_path": "/path/to/1234.png"},
+    resolution=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="Photo Editor image",
+    wait_for_completion=True,
+    download_outputs=True,
+    download_directory="outputs"
+)
+```
+
+#### Asynchronous Client
+
+```python
+from magic_hour import AsyncClient
+from os import getenv
+
+client = AsyncClient(token=getenv("API_TOKEN"))
+res = await client.v1.ai_photo_editor.generate(
+    assets={"image_file_path": "/path/to/1234.png"},
+    resolution=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="Photo Editor image",
+    wait_for_completion=True,
+    download_outputs=True,
+    download_directory="outputs"
+)
+```
+
+<!-- CUSTOM DOCS END -->
+
+### AI Photo Editor <a name="create"></a>
+
+> **NOTE**: this API is still in early development stages, and should be avoided. Please reach out to us if you're interested in this API.
+
+Edit photo using AI. Each photo costs 10 credits.
 
 **API Endpoint**: `POST /v1/ai-photo-editor`
 
+#### Parameters
+
+| Parameter              | Required | Deprecated | Description                                                                                                                                                                                                                                                                                                                                                                               | Example                                                                                                                                                                                                                                                             |
+| ---------------------- | :------: | :--------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `assets`               |    ✓     |     ✗      | Provide the assets for photo editor                                                                                                                                                                                                                                                                                                                                                       | `{"image_file_path": "api-assets/id/1234.png"}`                                                                                                                                                                                                                     |
+| `└─ image_file_path`   |    ✓     |     —      | The image used to generate the output. This value is either - a direct URL to the video file - `file_path` field from the response of the [upload urls API](https://docs.magichour.ai/api-reference/files/generate-asset-upload-urls). Please refer to the [Input File documentation](https://docs.magichour.ai/api-reference/files/generate-asset-upload-urls#input-file) to learn more. | `"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}` |
+| `└─ image_description` |    ✓     |     —      | Use this to describe what your input image is. This helps maintain aspects of the image you don't want to change.                                                                                                                                                                                                                                                                         | `"A photo of a person"`                                                                                                                                                                                                                                             |
+| `└─ likeness_strength` |    ✓     |     —      | Determines the input image's influence. Higher values align the output more with the initial image.                                                                                                                                                                                                                                                                                       | `5.2`                                                                                                                                                                                                                                                               |
+| `└─ negative_prompt`   |    ✗     |     —      | What you want to avoid seeing in the final output; has a minor effect.                                                                                                                                                                                                                                                                                                                    | `"painting, cartoon, sketch"`                                                                                                                                                                                                                                       |
+| `└─ prompt`            |    ✓     |     —      | What you want your final output to look like. We recommend starting with the image description and making minor edits for best results.                                                                                                                                                                                                                                                   | `"A photo portrait of a person wearing a hat"`                                                                                                                                                                                                                      |
+| `└─ prompt_strength`   |    ✓     |     —      | Determines the prompt's influence. Higher values align the output more with the prompt.                                                                                                                                                                                                                                                                                                   | `3.75`                                                                                                                                                                                                                                                              |
+| `└─ steps`             |    ✗     |     —      | Number of iterations used to generate the output. Higher values improve quality and increase the strength of the prompt but increase processing time.                                                                                                                                                                                                                                     | `4`                                                                                                                                                                                                                                                                 |
+| `└─ upscale_factor`    |    ✗     |     —      | The multiplier applied to an image's original dimensions during the upscaling process. For example, a scale of 2 doubles the width and height (e.g., from 512x512 to 1024x1024).                                                                                                                                                                                                          | `2`                                                                                                                                                                                                                                                                 |
+| `└─ upscale_fidelity`  |    ✗     |     —      | Upscale fidelity refers to the level of quality desired in the generated image. Fidelity value of 1 means more details.                                                                                                                                                                                                                                                                   | `0.5`                                                                                                                                                                                                                                                               |
+| `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
 
 ```python
@@ -25,6 +124,8 @@ res = client.v1.ai_photo_editor.create(
         "prompt": "A photo portrait of a person wearing a hat",
         "prompt_strength": 3.75,
         "steps": 4,
+        "upscale_factor": 2,
+        "upscale_fidelity": 0.5,
     },
     name="Photo Editor image",
 )
@@ -47,7 +148,21 @@ res = await client.v1.ai_photo_editor.create(
         "prompt": "A photo portrait of a person wearing a hat",
         "prompt_strength": 3.75,
         "steps": 4,
+        "upscale_factor": 2,
+        "upscale_fidelity": 0.5,
     },
     name="Photo Editor image",
 )
 ```
+
+#### Response
+
+##### Type
+
+[V1AiPhotoEditorCreateResponse](/magic_hour/types/models/v1_ai_photo_editor_create_response.py)
+
+##### Example
+
+```python
+{"credits_charged": 10, "frame_cost": 10, "id": "cuid-example"}
+```