magic_hour 0.23.0__py3-none-any.whl → 0.25.0__py3-none-any.whl

magic_hour/resources/v1/ai_image_editor/client.py

@@ -0,0 +1,125 @@
+import typing
+
+from magic_hour.core import (
+    AsyncBaseClient,
+    RequestOptions,
+    SyncBaseClient,
+    default_request_options,
+    to_encodable,
+    type_utils,
+)
+from magic_hour.types import models, params
+
+
+class AiImageEditorClient:
+    def __init__(self, *, base_client: SyncBaseClient):
+        self._base_client = base_client
+
+    def create(
+        self,
+        *,
+        assets: params.V1AiImageEditorCreateBodyAssets,
+        style: params.V1AiImageEditorCreateBodyStyle,
+        name: typing.Union[
+            typing.Optional[str], type_utils.NotGiven
+        ] = type_utils.NOT_GIVEN,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> models.V1AiImageEditorCreateResponse:
+        """
+        AI Image Editor
+
+        Edit images with AI. Each edit costs 50 credits.
+
+        POST /v1/ai-image-editor
+
+        Args:
+            name: The name of image
+            assets: Provide the assets for image edit
+            style: V1AiImageEditorCreateBodyStyle
+            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_image_editor.create(
+            assets={"image_file_path": "api-assets/id/1234.png"},
+            style={"prompt": "Give me sunglasses"},
+            name="Ai Image Editor image",
+        )
+        ```
+        """
+        _json = to_encodable(
+            item={"name": name, "assets": assets, "style": style},
+            dump_with=params._SerializerV1AiImageEditorCreateBody,
+        )
+        return self._base_client.request(
+            method="POST",
+            path="/v1/ai-image-editor",
+            auth_names=["bearerAuth"],
+            json=_json,
+            cast_to=models.V1AiImageEditorCreateResponse,
+            request_options=request_options or default_request_options(),
+        )
+
+
+class AsyncAiImageEditorClient:
+    def __init__(self, *, base_client: AsyncBaseClient):
+        self._base_client = base_client
+
+    async def create(
+        self,
+        *,
+        assets: params.V1AiImageEditorCreateBodyAssets,
+        style: params.V1AiImageEditorCreateBodyStyle,
+        name: typing.Union[
+            typing.Optional[str], type_utils.NotGiven
+        ] = type_utils.NOT_GIVEN,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> models.V1AiImageEditorCreateResponse:
+        """
+        AI Image Editor
+
+        Edit images with AI. Each edit costs 50 credits.
+
+        POST /v1/ai-image-editor
+
+        Args:
+            name: The name of image
+            assets: Provide the assets for image edit
+            style: V1AiImageEditorCreateBodyStyle
+            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_image_editor.create(
+            assets={"image_file_path": "api-assets/id/1234.png"},
+            style={"prompt": "Give me sunglasses"},
+            name="Ai Image Editor image",
+        )
+        ```
+        """
+        _json = to_encodable(
+            item={"name": name, "assets": assets, "style": style},
+            dump_with=params._SerializerV1AiImageEditorCreateBody,
+        )
+        return await self._base_client.request(
+            method="POST",
+            path="/v1/ai-image-editor",
+            auth_names=["bearerAuth"],
+            json=_json,
+            cast_to=models.V1AiImageEditorCreateResponse,
+            request_options=request_options or default_request_options(),
+        )

magic_hour/resources/v1/ai_image_generator/README.md

@@ -5,6 +5,15 @@ Create an AI image. Each image costs 5 credits.
 
 **API Endpoint**: `POST /v1/ai-image-generator`
 
+#### Parameters
+
+| Parameter | Required | Description | Example |
+|-----------|:--------:|-------------|--------|
+| `image_count` | ✓ | number to images to generate | `1` |
+| `orientation` | ✓ |  | `"landscape"` |
+| `style` | ✓ |  | `{"prompt": "Cool image", "tool": "ai-anime-generator"}` |
+| `name` | ✗ | The name of image | `"Ai Image image"` |
+
 #### Synchronous Client
 
 ```python
@@ -15,9 +24,10 @@ client = Client(token=getenv("API_TOKEN"))
 res = client.v1.ai_image_generator.create(
     image_count=1,
     orientation="landscape",
-    style={"prompt": "Cool image"},
+    style={"prompt": "Cool image", "tool": "ai-anime-generator"},
     name="Ai Image image",
 )
+
 ```
 
 #### Asynchronous Client
@@ -30,7 +40,16 @@ client = AsyncClient(token=getenv("API_TOKEN"))
 res = await client.v1.ai_image_generator.create(
     image_count=1,
     orientation="landscape",
-    style={"prompt": "Cool image"},
+    style={"prompt": "Cool image", "tool": "ai-anime-generator"},
     name="Ai Image image",
 )
+
 ```
+
+#### Response
+
+##### Type
+[V1AiImageGeneratorCreateResponse](/magic_hour/types/models/v1_ai_image_generator_create_response.py)
+
+##### Example
+`{"credits_charged": 5, "frame_cost": 5, "id": "clx7uu86w0a5qp55yxz315r6r"}`

magic_hour/resources/v1/ai_image_generator/client.py

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

magic_hour/resources/v1/ai_image_upscaler/README.md

@@ -5,6 +5,15 @@ Upscale your image using AI. Each 2x upscale costs 50 credits, and 4x upscale co
 
 **API Endpoint**: `POST /v1/ai-image-upscaler`
 
+#### Parameters
+
+| Parameter | Required | Description | Example |
+|-----------|:--------:|-------------|--------|
+| `assets` | ✓ | Provide the assets for upscaling | `{"image_file_path": "api-assets/id/1234.png"}` |
+| `scale_factor` | ✓ | How much to scale the image. Must be either 2 or 4 | `2.0` |
+| `style` | ✓ |  | `{"enhancement": "Balanced"}` |
+| `name` | ✗ | The name of image | `"Image Upscaler image"` |
+
 #### Synchronous Client
 
 ```python
@@ -18,6 +27,7 @@ res = client.v1.ai_image_upscaler.create(
     style={"enhancement": "Balanced"},
     name="Image Upscaler image",
 )
+
 ```
 
 #### Asynchronous Client
@@ -33,4 +43,13 @@ res = await client.v1.ai_image_upscaler.create(
     style={"enhancement": "Balanced"},
     name="Image Upscaler image",
 )
+
 ```
+
+#### Response
+
+##### Type
+[V1AiImageUpscalerCreateResponse](/magic_hour/types/models/v1_ai_image_upscaler_create_response.py)
+
+##### Example
+`{"credits_charged": 50, "frame_cost": 50, "id": "clx7uu86w0a5qp55yxz315r6r"}`

magic_hour/resources/v1/ai_meme_generator/README.md

@@ -5,6 +5,13 @@ 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"}` |
+| `name` | ✗ | The name of the meme. | `"My Funny Meme"` |
+
 #### Synchronous Client
 
 ```python
@@ -20,6 +27,7 @@ res = client.v1.ai_meme_generator.create(
     },
     name="My Funny Meme",
 )
+
 ```
 
 #### Asynchronous Client
@@ -37,4 +45,13 @@ res = await client.v1.ai_meme_generator.create(
     },
     name="My Funny Meme",
 )
+
 ```
+
+#### Response
+
+##### Type
+[V1AiMemeGeneratorCreateResponse](/magic_hour/types/models/v1_ai_meme_generator_create_response.py)
+
+##### Example
+`{"credits_charged": 10, "frame_cost": 10, "id": "clx7uu86w0a5qp55yxz315r6r"}`

magic_hour/resources/v1/ai_photo_editor/README.md

@@ -7,6 +7,16 @@ Edit photo using AI. Each photo costs 10 credits.
 
 **API Endpoint**: `POST /v1/ai-photo-editor`
 
+#### Parameters
+
+| Parameter | Required | Description | Example |
+|-----------|:--------:|-------------|--------|
+| `assets` | ✓ | Provide the assets for photo editor | `{"image_file_path": "api-assets/id/1234.png"}` |
+| `resolution` | ✓ | The resolution of the final output image. The allowed value is based on your subscription. Please refer to our [pricing page](https://magichour.ai/pricing) for more details | `768` |
+| `style` | ✓ |  | `{"image_description": "A photo of a person", "likeness_strength": 5.2, "negative_prompt": "painting, cartoon, sketch", "prompt": "A photo portrait of a person wearing a hat", "prompt_strength": 3.75, "steps": 4, "upscale_factor": 2, "upscale_fidelity": 0.5}` |
+| `name` | ✗ | The name of image | `"Photo Editor image"` |
+| `steps` | ✗ | Deprecated: Please use `.style.steps` instead. Number of iterations used to generate the output. Higher values improve quality and increase the strength of the prompt but increase processing time. | `123` |
+
 #### Synchronous Client
 
 ```python
@@ -29,6 +39,7 @@ res = client.v1.ai_photo_editor.create(
     },
     name="Photo Editor image",
 )
+
 ```
 
 #### Asynchronous Client
@@ -53,4 +64,13 @@ res = await client.v1.ai_photo_editor.create(
     },
     name="Photo Editor image",
 )
+
 ```
+
+#### Response
+
+##### Type
+[V1AiPhotoEditorCreateResponse](/magic_hour/types/models/v1_ai_photo_editor_create_response.py)
+
+##### Example
+`{"credits_charged": 10, "frame_cost": 10, "id": "clx7uu86w0a5qp55yxz315r6r"}`

magic_hour/resources/v1/ai_qr_code_generator/README.md

@@ -5,6 +5,14 @@ Create an AI QR code. Each QR code costs 20 credits.
 
 **API Endpoint**: `POST /v1/ai-qr-code-generator`
 
+#### Parameters
+
+| Parameter | Required | Description | Example |
+|-----------|:--------:|-------------|--------|
+| `content` | ✓ | The content of the QR code. | `"https://magichour.ai"` |
+| `style` | ✓ |  | `{"art_style": "Watercolor"}` |
+| `name` | ✗ | The name of image | `"Qr Code image"` |
+
 #### Synchronous Client
 
 ```python
@@ -17,6 +25,7 @@ res = client.v1.ai_qr_code_generator.create(
     style={"art_style": "Watercolor"},
     name="Qr Code image",
 )
+
 ```
 
 #### Asynchronous Client
@@ -31,4 +40,13 @@ res = await client.v1.ai_qr_code_generator.create(
     style={"art_style": "Watercolor"},
     name="Qr Code image",
 )
+
 ```
+
+#### Response
+
+##### Type
+[V1AiQrCodeGeneratorCreateResponse](/magic_hour/types/models/v1_ai_qr_code_generator_create_response.py)
+
+##### Example
+`{"credits_charged": 20, "frame_cost": 20, "id": "clx7uu86w0a5qp55yxz315r6r"}`

magic_hour/resources/v1/ai_talking_photo/README.md

@@ -5,6 +5,16 @@ Create a talking photo from an image and audio or text input.
 
 **API Endpoint**: `POST /v1/ai-talking-photo`
 
+#### Parameters
+
+| Parameter | Required | Description | Example |
+|-----------|:--------:|-------------|--------|
+| `assets` | ✓ | Provide the assets for creating a talking photo | `{"audio_file_path": "api-assets/id/1234.mp3", "image_file_path": "api-assets/id/1234.png"}` |
+| `end_seconds` | ✓ | The end time of the input audio in seconds. The maximum duration allowed is 30 seconds. | `15.0` |
+| `start_seconds` | ✓ | The start time of the input audio in seconds. The maximum duration allowed is 30 seconds. | `0.0` |
+| `name` | ✗ | The name of image | `"Talking Photo image"` |
+| `style` | ✗ | Attributes used to dictate the style of the output | `{"generation_mode": "expressive", "intensity": 1.5}` |
+
 #### Synchronous Client
 
 ```python
@@ -21,6 +31,7 @@ res = client.v1.ai_talking_photo.create(
     start_seconds=0.0,
     name="Talking Photo image",
 )
+
 ```
 
 #### Asynchronous Client
@@ -39,4 +50,13 @@ res = await client.v1.ai_talking_photo.create(
     start_seconds=0.0,
     name="Talking Photo image",
 )
+
 ```
+
+#### Response
+
+##### Type
+[V1AiTalkingPhotoCreateResponse](/magic_hour/types/models/v1_ai_talking_photo_create_response.py)
+
+##### Example
+`{"credits_charged": 450, "estimated_frame_cost": 450, "id": "clx7uu86w0a5qp55yxz315r6r"}`

magic_hour/resources/v1/animation/README.md

@@ -5,6 +5,18 @@ Create a Animation video. The estimated frame cost is calculated based on the `f
 
 **API Endpoint**: `POST /v1/animation`
 
+#### Parameters
+
+| Parameter | Required | Description | Example |
+|-----------|:--------:|-------------|--------|
+| `assets` | ✓ | Provide the assets for animation. | `{"audio_file_path": "api-assets/id/1234.mp3", "audio_source": "file", "image_file_path": "api-assets/id/1234.png"}` |
+| `end_seconds` | ✓ | The end time of the input video in seconds | `15.0` |
+| `fps` | ✓ | The desire output video frame rate | `12.0` |
+| `height` | ✓ | The height of the final output video. The maximum height depends on your subscription. Please refer to our [pricing page](https://magichour.ai/pricing) for more details | `960` |
+| `style` | ✓ | Defines the style of the output video | `{"art_style": "Painterly Illustration", "camera_effect": "Accelerate", "prompt": "Cyberpunk city", "prompt_type": "ai_choose", "transition_speed": 5}` |
+| `width` | ✓ | The width of the final output video. The maximum width depends on your subscription. Please refer to our [pricing page](https://magichour.ai/pricing) for more details | `512` |
+| `name` | ✗ | The name of video | `"Animation video"` |
+
 #### Synchronous Client
 
 ```python
@@ -31,6 +43,7 @@ res = client.v1.animation.create(
     width=512,
     name="Animation video",
 )
+
 ```
 
 #### Asynchronous Client
@@ -59,4 +72,13 @@ res = await client.v1.animation.create(
     width=512,
     name="Animation video",
 )
+
 ```
+
+#### Response
+
+##### Type
+[V1AnimationCreateResponse](/magic_hour/types/models/v1_animation_create_response.py)
+
+##### Example
+`{"credits_charged": 450, "estimated_frame_cost": 450, "id": "clx7uu86w0a5qp55yxz315r6r"}`

magic_hour/resources/v1/client.py

@@ -15,6 +15,10 @@ from magic_hour.resources.v1.ai_headshot_generator import (
     AiHeadshotGeneratorClient,
     AsyncAiHeadshotGeneratorClient,
 )
+from magic_hour.resources.v1.ai_image_editor import (
+    AiImageEditorClient,
+    AsyncAiImageEditorClient,
+)
 from magic_hour.resources.v1.ai_image_generator import (
     AiImageGeneratorClient,
     AsyncAiImageGeneratorClient,
@@ -88,6 +92,7 @@ class V1Client:
         self.ai_headshot_generator = AiHeadshotGeneratorClient(
             base_client=self._base_client
         )
+        self.ai_image_editor = AiImageEditorClient(base_client=self._base_client)
         self.ai_image_generator = AiImageGeneratorClient(base_client=self._base_client)
         self.ai_image_upscaler = AiImageUpscalerClient(base_client=self._base_client)
         self.ai_meme_generator = AiMemeGeneratorClient(base_client=self._base_client)
@@ -123,6 +128,7 @@ class AsyncV1Client:
         self.ai_headshot_generator = AsyncAiHeadshotGeneratorClient(
             base_client=self._base_client
         )
+        self.ai_image_editor = AsyncAiImageEditorClient(base_client=self._base_client)
         self.ai_image_generator = AsyncAiImageGeneratorClient(
             base_client=self._base_client
         )

magic_hour/resources/v1/face_swap/README.md

@@ -8,6 +8,17 @@ Get more information about this mode at our [product page](/products/face-swap).
 
 **API Endpoint**: `POST /v1/face-swap`
 
+#### Parameters
+
+| Parameter | Required | Description | Example |
+|-----------|:--------:|-------------|--------|
+| `assets` | ✓ | Provide the assets for face swap. For video, The `video_source` field determines whether `video_file_path` or `youtube_url` field is used | `{"image_file_path": "image/id/1234.png", "video_file_path": "api-assets/id/1234.mp4", "video_source": "file"}` |
+| `end_seconds` | ✓ | The end time of the input video in seconds | `15.0` |
+| `start_seconds` | ✓ | The start time of the input video in seconds | `0.0` |
+| `height` | ✗ | Used to determine the dimensions of the output video.     * If height is provided, width will also be required. The larger value between width and height will be used to determine the maximum output resolution while maintaining the original aspect ratio. * If both height and width are omitted, the video will be resized according to your subscription's maximum resolution, while preserving aspect ratio.  Note: if the video's original resolution is less than the maximum, the video will not be resized.  See our [pricing page](https://magichour.ai/pricing) for more details. | `960` |
+| `name` | ✗ | The name of video | `"Face Swap video"` |
+| `width` | ✗ | Used to determine the dimensions of the output video.     * If width is provided, height will also be required. The larger value between width and height will be used to determine the maximum output resolution while maintaining the original aspect ratio. * If both height and width are omitted, the video will be resized according to your subscription's maximum resolution, while preserving aspect ratio.  Note: if the video's original resolution is less than the maximum, the video will not be resized.  See our [pricing page](https://magichour.ai/pricing) for more details. | `512` |
+
 #### Synchronous Client
 
 ```python
@@ -27,6 +38,7 @@ res = client.v1.face_swap.create(
     name="Face Swap video",
     width=512,
 )
+
 ```
 
 #### Asynchronous Client
@@ -48,4 +60,13 @@ res = await client.v1.face_swap.create(
     name="Face Swap video",
     width=512,
 )
+
 ```
+
+#### Response
+
+##### Type
+[V1FaceSwapCreateResponse](/magic_hour/types/models/v1_face_swap_create_response.py)
+
+##### Example
+`{"credits_charged": 450, "estimated_frame_cost": 450, "id": "clx7uu86w0a5qp55yxz315r6r"}`

magic_hour/resources/v1/face_swap_photo/README.md

@@ -5,6 +5,13 @@ Create a face swap photo. Each photo costs 5 credits. The height/width of the ou
 
 **API Endpoint**: `POST /v1/face-swap-photo`
 
+#### Parameters
+
+| Parameter | Required | Description | Example |
+|-----------|:--------:|-------------|--------|
+| `assets` | ✓ | Provide the assets for face swap photo | `{"source_file_path": "api-assets/id/1234.png", "target_file_path": "api-assets/id/1234.png"}` |
+| `name` | ✗ | The name of image | `"Face Swap image"` |
+
 #### Synchronous Client
 
 ```python
@@ -19,6 +26,7 @@ res = client.v1.face_swap_photo.create(
     },
     name="Face Swap image",
 )
+
 ```
 
 #### Asynchronous Client
@@ -35,4 +43,13 @@ res = await client.v1.face_swap_photo.create(
     },
     name="Face Swap image",
 )
+
 ```
+
+#### Response
+
+##### Type
+[V1FaceSwapPhotoCreateResponse](/magic_hour/types/models/v1_face_swap_photo_create_response.py)
+
+##### Example
+`{"credits_charged": 5, "frame_cost": 5, "id": "clx7uu86w0a5qp55yxz315r6r"}`

magic_hour/resources/v1/files/upload_urls/README.md

@@ -11,19 +11,24 @@ Below is the list of valid extensions for each asset type:
 
 Note: `.gif` is supported for face swap API `video_file_path` field.
 
-After receiving the upload url, you can upload the file by sending a PUT request with the header `'Content-Type: application/octet-stream'`.
+After receiving the upload url, you can upload the file by sending a PUT request.
 
 For example using curl
 
 ```
-curl -X PUT -H 'Content-Type: application/octet-stream' \
-  --data '@/path/to/file/video.mp4' \
-  https://videos.magichour.ai/api-assets/id/video.mp4?auth-value=1234567890
+curl -X PUT --data '@/path/to/file/video.mp4' \
+  https://videos.magichour.ai/api-assets/id/video.mp4?<auth params from the API response>
 ```
 
 
 **API Endpoint**: `POST /v1/files/upload-urls`
 
+#### Parameters
+
+| Parameter | Required | Description | Example |
+|-----------|:--------:|-------------|--------|
+| `items` | ✓ |  | `[{"extension": "mp4", "type_": "video"}, {"extension": "mp3", "type_": "audio"}]` |
+
 #### Synchronous Client
 
 ```python
@@ -37,6 +42,7 @@ res = client.v1.files.upload_urls.create(
         {"extension": "mp3", "type_": "audio"},
     ]
 )
+
 ```
 
 #### Asynchronous Client
@@ -52,4 +58,13 @@ res = await client.v1.files.upload_urls.create(
         {"extension": "mp3", "type_": "audio"},
     ]
 )
+
 ```
+
+#### Response
+
+##### Type
+[V1FilesUploadUrlsCreateResponse](/magic_hour/types/models/v1_files_upload_urls_create_response.py)
+
+##### Example
+`{"items": [{"expires_at": "2024-07-25T16:56:21.932Z", "file_path": "api-assets/id/video.mp4", "upload_url": "https://videos.magichour.ai/api-assets/id/video.mp4?auth-value=1234567890"}, {"expires_at": "2024-07-25T16:56:21.932Z", "file_path": "api-assets/id/audio.mp3", "upload_url": "https://videos.magichour.ai/api-assets/id/audio.mp3?auth-value=1234567890"}]}`

magic_hour/resources/v1/files/upload_urls/client.py

@@ -33,14 +33,13 @@ class UploadUrlsClient:
         
         Note: `.gif` is supported for face swap API `video_file_path` field.
         
-        After receiving the upload url, you can upload the file by sending a PUT request with the header `'Content-Type: application/octet-stream'`.
+        After receiving the upload url, you can upload the file by sending a PUT request.
         
         For example using curl
         
         ```
-        curl -X PUT -H 'Content-Type: application/octet-stream' \
-          --data '@/path/to/file/video.mp4' \
-          https://videos.magichour.ai/api-assets/id/video.mp4?auth-value=1234567890
+        curl -X PUT --data '@/path/to/file/video.mp4' \
+          https://videos.magichour.ai/api-assets/id/video.mp4?<auth params from the API response>
         ```
         
         
@@ -99,14 +98,13 @@ class AsyncUploadUrlsClient:
         
         Note: `.gif` is supported for face swap API `video_file_path` field.
         
-        After receiving the upload url, you can upload the file by sending a PUT request with the header `'Content-Type: application/octet-stream'`.
+        After receiving the upload url, you can upload the file by sending a PUT request.
         
         For example using curl
         
         ```
-        curl -X PUT -H 'Content-Type: application/octet-stream' \
-          --data '@/path/to/file/video.mp4' \
-          https://videos.magichour.ai/api-assets/id/video.mp4?auth-value=1234567890
+        curl -X PUT --data '@/path/to/file/video.mp4' \
+          https://videos.magichour.ai/api-assets/id/video.mp4?<auth params from the API response>
         ```
         
         

magic_hour/resources/v1/image_background_remover/README.md

@@ -5,6 +5,13 @@ Remove background from image. Each image costs 5 credits.
 
 **API Endpoint**: `POST /v1/image-background-remover`
 
+#### Parameters
+
+| Parameter | Required | Description | Example |
+|-----------|:--------:|-------------|--------|
+| `assets` | ✓ | Provide the assets for background removal | `{"image_file_path": "api-assets/id/1234.png"}` |
+| `name` | ✗ | The name of image | `"Background Remover image"` |
+
 #### Synchronous Client
 
 ```python
@@ -16,6 +23,7 @@ res = client.v1.image_background_remover.create(
     assets={"image_file_path": "api-assets/id/1234.png"},
     name="Background Remover image",
 )
+
 ```
 
 #### Asynchronous Client
@@ -29,4 +37,13 @@ res = await client.v1.image_background_remover.create(
     assets={"image_file_path": "api-assets/id/1234.png"},
     name="Background Remover image",
 )
+
 ```
+
+#### Response
+
+##### Type
+[V1ImageBackgroundRemoverCreateResponse](/magic_hour/types/models/v1_image_background_remover_create_response.py)
+
+##### Example
+`{"credits_charged": 5, "frame_cost": 5, "id": "clx7uu86w0a5qp55yxz315r6r"}`