NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
DeepImage connects to a Nagent workspace with an API key. Once it is connected, agents can call 5 DeepImage actions, such as "Get Account Information", "Get Job Result" and "Delete Job". Nothing is enabled on connect: each action is allowed one at a time, and an action with side effects runs or waits for a person according to the agent's level.
Every operation an agent can call against DeepImage, with input parameters and output schema.
DEEPIMAGE_DELETE_JOBTool to delete completed job result and remove images from the server. Use when cleaning up processed jobs that are no longer needed.
Input parameters
Unique identifier for the processing job whose results should be removed
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DEEPIMAGE_GET_ACCOUNT_INFOTool 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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DEEPIMAGE_GET_JOB_RESULTTool to retrieve processing job result by hash. Use to check job status and get result URL when processing is complete.
Input parameters
The unique job identifier returned from a processing request
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DEEPIMAGE_PROCESS_IMAGE_ASYNCTool 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
DPI setting for the output image (default: 300)
Fitting method - can be a string ('canvas', 'crop', 'bounds', 'cover') or a FitOptions object
Image URL, Base64-encoded image, or storage URL format to process
Pixel width or percentage (e.g., 1000 or '200%')
Pixel height or percentage (e.g., 800 or '150%')
Preset configurations like 'real_estate', 'ecommerce', etc.
Target storage location for the output image
Margin in pixels or percentages
Compression quality level from 0 to 100 (default: 85)
Background removal or replacement options.
Minimum width or height in pixels
Paper size specification like 'A4', 'letter', etc.
List of enhancement types to apply to the image
Output image format
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DEEPIMAGE_PROCESS_IMAGE_SYNCTool 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
Print-specific DPI parameter.
Image URL, Base64 encoded image, or storage URL.
Target width in pixels or percentage (e.g., "200%" or 800).
Target height in pixels or percentage (e.g., "200%" or 600).
Predefined processing templates (e.g., 'real_estate', 'ecommerce').
Storage destination URL.
Compression level 0-100, default: 85.
Configuration for background removal.
Print-specific size parameter.
Enhancement types: denoise, deblur, clean, face_enhance, light, color, white_balance, exposure_correction.
Size constraints with units (kb, mb, gb).
Output format: jpeg, jpg, png, webp.
Enhancement-specific configuration for color.
Enhancement-specific configuration for lighting.
Enhancement-specific configuration for deblurring.
Enhancement-specific configuration for denoising.
Enhancement-specific configuration for white balance.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
Agents can call 5 DeepImage actions on Nagent, including "Get Account Information", "Get Job Result" and "Delete Job". Get Account Information: Retrieve authenticated user's profile information including credits, username, email, API key, language preference, webhook settings, and billing address. Each action is listed on this page with its input parameters and its output.
DeepImage connects with an API key, under your workspace's own connection. Nothing is enabled on connect: each action is allowed one at a time and can be scoped to the agents that need it.
It returns data, error and successful.