# DeepImage

AI Image Enhancer to Generate & Upscale

- **Category:** artificial intelligence
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 5
- **Triggers:** 0
- **Slug:** `DEEPIMAGE`
- **Version:** 20260211_00

## Tools

### Delete Job

**Slug:** `DEEPIMAGE_DELETE_JOB`

Tool to delete completed job result and remove images from the server. Use when cleaning up processed jobs that are no longer needed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `hash` | string | Yes | Unique identifier for the processing job whose results should be removed |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Account Information

**Slug:** `DEEPIMAGE_GET_ACCOUNT_INFO`

Tool to retrieve authenticated user's profile information including credits, username, email, API key, language preference, webhook settings, and billing address. Use when you need to check account details or credit balance.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Job Result

**Slug:** `DEEPIMAGE_GET_JOB_RESULT`

Tool to retrieve processing job result by hash. Use to check job status and get result URL when processing is complete.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `hash` | string | Yes | The unique job identifier returned from a processing request |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Process Image Async

**Slug:** `DEEPIMAGE_PROCESS_IMAGE_ASYNC`

Tool to schedule an image enhancement job and wait for the result. Performs selected enhancement options on an image and returns the result URL if processing completes within 25 seconds; otherwise returns a job hash for later retrieval. Use when you need to enhance images with options like denoising, deblurring, lighting improvements, or background removal.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dpi` | integer | No | DPI setting for the output image (default: 300) |
| `fit` | string | No | Fitting method - can be a string ('canvas', 'crop', 'bounds', 'cover') or a FitOptions object |
| `url` | string | Yes | Image URL, Base64-encoded image, or storage URL format to process |
| `width` | string | No | Pixel width or percentage (e.g., 1000 or '200%') |
| `height` | string | No | Pixel height or percentage (e.g., 800 or '150%') |
| `preset` | string | No | Preset configurations like 'real_estate', 'ecommerce', etc. |
| `target` | string | No | Target storage location for the output image |
| `padding` | string | No | Margin in pixels or percentages |
| `quality` | integer | No | Compression quality level from 0 to 100 (default: 85) |
| `background` | object | No | Background removal or replacement options. |
| `min_length` | integer | No | Minimum width or height in pixels |
| `print_size` | string | No | Paper size specification like 'A4', 'letter', etc. |
| `enhancements` | array | No | List of enhancement types to apply to the image |
| `output_format` | string ("jpeg" | "jpg" | "png" | "webp") | No | Output image format |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Process Image Synchronously

**Slug:** `DEEPIMAGE_PROCESS_IMAGE_SYNC`

Tool to process an image synchronously with Deep Image AI. Returns result URL immediately if processing completes in less than 25 seconds, otherwise returns job hash for async polling. Use for image enhancement, resizing, background removal, and other image processing tasks.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dpi` | integer | No | Print-specific DPI parameter. |
| `url` | string | Yes | Image URL, Base64 encoded image, or storage URL. |
| `width` | string | No | Target width in pixels or percentage (e.g., "200%" or 800). |
| `height` | string | No | Target height in pixels or percentage (e.g., "200%" or 600). |
| `preset` | string | No | Predefined processing templates (e.g., 'real_estate', 'ecommerce'). |
| `target` | string | No | Storage destination URL. |
| `quality` | integer | No | Compression level 0-100, default: 85. |
| `background` | object | No | Configuration for background removal. |
| `print_size` | string | No | Print-specific size parameter. |
| `enhancements` | array | No | Enhancement types: denoise, deblur, clean, face_enhance, light, color, white_balance, exposure_correction. |
| `max_file_size` | string | No | Size constraints with units (kb, mb, gb). |
| `output_format` | string | No | Output format: jpeg, jpg, png, webp. |
| `color_parameters` | object | No | Enhancement-specific configuration for color. |
| `light_parameters` | object | No | Enhancement-specific configuration for lighting. |
| `deblur_parameters` | object | No | Enhancement-specific configuration for deblurring. |
| `denoise_parameters` | object | No | Enhancement-specific configuration for denoising. |
| `white_balance_parameters` | object | No | Enhancement-specific configuration for white balance. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |