Usage

All storage integrations — AWS S3, Dropbox, OneDrive, Google Drive — can be used directly within the Deep Image web application, specifically in the AI Enhancer PRO tool. This allows you to process individual images or entire folders, with the option to select a target storage where results will be saved. These integrations are also fully supported via the API, enabling automated workflows and seamless integration with your own applications or services.

API

Why use storage with the API?

While the web app offers a convenient interface, the true power of storages is unlocked when using them via the Deep Image API. Thanks to a unified storage:// syntax, all supported storage types share the same interface, regardless of the provider. This makes your workflow more flexible and easier to automate.

Example usage

To process a specific image from a storage and save the result to another storage, simply use the following format:

POST /rest_api/process

{
  "url": "storage://aws-deep-image/2025/may/my-photo.png",
  "target": "storage://onedrive-deep-image/processed"
}

In this example:

• The image is loaded from the AWS S3 bucket named aws-deep-image.

• The result will be saved to a folder in OneDrive storage named onedrive-deep-image.

You can also use only one of the parameters depending on the task. For example:

• For image generation tasks (where there is no input image), you can specify only "target".

• For enhancement or transformation of an existing file, use only "url" if you don’t need to save the result back to storage (e.g., when downloading it directly from the url in the response).

Benefits of API-Based Storage Integration

• Consistency: One unified path format (storage://...) across different platforms.

• Automation: Easily plug into pipelines for bulk processing or integration with other services.

• Security: No need to expose image URLs publicly.

• Scalability: Perfect for large-scale tasks with thousands of images.

Note on Google Drive Usage

Unlike other storage integrations, Google Drive does not support specifying folder or subfolder paths via the API using the unified storage:// syntax. Due to Google Drive API limitations and security policies, it is not possible to provide full folder or subfolder paths for accessing files directly via the API.

Because of these constraints, we recommend avoiding using Google Drive as a source or target storage through the API. Instead, for Google Drive workflows, please use the Deep-Image web application, which provides a tailored interface for Google Drive with proper handling of folder selection and permissions.

For more details and limitations related to Google Drive integration, see: Google Drive in Folder Processing - Additional Notes

Web Application

Folder Processing

The Folder Processing feature in Deep-Image allows you to enhance large batches of images automatically, without the need to upload files manually. It supports external cloud storage integrations and organizes both successful and failed results efficiently.

How it Works

1. Connect Your Storage Deep-Image supports seamless integration with the following cloud storage platforms:

   1. AWS S3

   2. Google Drive

   3. Dropbox

   4. OneDrive

2. Choose Source and Target Folders

   1. Source folder – contains the original images to be processed.

   2. Target folder – stores the results after processing.

3. Target Folder Structure By default, processed images are stored in subfolders within the selected target directory:

   • results – contains successfully processed images

   • invalid (optional) – contains files that failed validation or encountered processing errors

The source and target folders can belong to different storage types (e.g., source from Dropbox, target to S3).

Saving failed files to the invalid folder is optional and can be toggled depending on your workflow.

Image validation

Image validation takes place during the processing phase. Images may fail validation if:

• They are corrupted

• They have unsupported formats

• They do not meet required criteria (e.g., resolution)

When enabled, failed files are moved to the invalid folder for further review or reprocessing. You can access validation details via Gallery → Folder Details, where the reasons for failure are listed.

Additional Info

• You can stop processing anytime from the Gallery page.

• To resume processing, select the same source and target folders; already processed files will be skipped.

• Limits & credits:

  • Credits are only consumed for successfully processed images.

  • Files that fail validation do not consume credits, even if saved in the invalid folder.

File Picker

The File Picker is a separate tool that lets you:

• Browse your connected cloud storage.

• Select one or multiple individual files.

• Trigger instant on-demand processing without folder setup.

Google Drive in Folder Processing - Additional Notes

Using Google Drive as Source Folder

• To use a Google Drive folder as the image source, you must create a shareable link to the folder.

• The folder needs to have 'read for everyone' permissions to allow Deep-Image to access the images.

• Alternatively, for more secure access, share the folder specifically with the service account email: [email protected].

• This is required because Deep-Image accesses Google Drive via a service account and needs explicit permissions.

Using Google Drive as Target Folder

• When selecting a target folder in Google Drive, users can only select folders within the app-specific folder namespace.

• This limitation is due to Google Drive API's security model, which restricts apps from writing outside their dedicated folder area unless explicitly authorized.

• Therefore, target folders in Google Drive are limited to the app's folder or subfolders inside it.