Deepimage

Learn how to use Deepimage with Composio

Overview

SLUG: DEEPIMAGE

Description

AI Image Enhancer to Generate & Upscale

Authentication Details

generic_api_key
stringRequired

Connecting to Deepimage

Create an auth config

Use the dashboard to create an auth config for the Deepimage toolkit. This allows you to connect multiple Deepimage accounts to Composio for agents to use.

1

Select App

Navigate to Deepimage.

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Deepimage Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using API Key

1from composio import Composio
2
3# Replace these with your actual values
4deepimage_auth_config_id = "ac_YOUR_DEEPIMAGE_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000" # UUID from database/app
6
7composio = Composio()
8
9def authenticate_toolkit(user_id: str, auth_config_id: str):
10 # Replace this with a method to retrieve an API key from the user.
11 # Or supply your own.
12 user_api_key = input("[!] Enter API key")
13
14 connection_request = composio.connected_accounts.initiate(
15 user_id=user_id,
16 auth_config_id=auth_config_id,
17 config={"auth_scheme": "API_KEY", "val": {"generic_api_key": user_api_key}}
18 )
19
20 # API Key authentication is immediate - no redirect needed
21 print(f"Successfully connected Deepimage for user {user_id}")
22 print(f"Connection status: {connection_request.status}")
23
24 return connection_request.id
25
26
27connection_id = authenticate_toolkit(user_id, deepimage_auth_config_id)
28
29# You can verify the connection using:
30connected_account = composio.connected_accounts.get(connection_id)
31print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Deepimage toolkit’s playground

For code examples, see the Tool calling guide and Provider examples.

Tool List

Tool Name: Delete Job

Description

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

Action Parameters

hash
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Account Information

Description

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.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Job Result

Description

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

Action Parameters

hash
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Process Image Async

Description

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.

Action Parameters

background
object
dpi
integer
enhancements
array
fit
string
height
integer
min_length
integer
output_format
string
padding
integer
preset
string
print_size
string
quality
integer
target
string
url
stringRequired
width
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Process Image Synchronously

Description

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.

Action Parameters

background
object
color_parameters
object
deblur_parameters
object
denoise_parameters
object
dpi
integer
enhancements
array
height
integer
light_parameters
object
max_file_size
string
output_format
string
preset
string
print_size
string
quality
integer
target
string
url
stringRequired
white_balance_parameters
object
width
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired
successfull
booleanRequired