ImageKit

These are the ImageKit actions available to the apps you build with Snow. Connecting an account does not make Snow run these on its own.

• Copy Folder

  Initiate an asynchronous bulk copy of a folder and all its contents to a new location. Use this tool when you need to: - Duplicate an entire folder structure including all nested files and subfolders - Create a backup of a folder at a different location - Copy a folder with or without file version history This is an asynchronous operation that returns immediately with a job ID. The actual copy happens in the background. Use IMAGEKIT_IO_BULK_JOB_STATUS with the returned jobId to check when the operation completes. Note: If a folder with the same name exists at the destination, permissions from the existing destination folder will be preserved.

• Create Folder

  Creates a new folder in ImageKit.io media library. Use this to organize assets into structured folder hierarchies. The folder will be created at the specified parent path. If the parent folder doesn't exist, the API will return an error.

• Delete File

  Permanently deletes a file from ImageKit by its unique file ID. WARNING: This action is irreversible. The file and all its versions will be permanently removed. Note: Cached versions of the file may still be served until the cache expires. Use the purge cache endpoint if immediate removal from CDN is required. Use this tool when you need to: - Remove unwanted or obsolete files from the media library - Clean up test uploads - Delete files that should no longer be accessible The file ID can be obtained from the 'List and Search Assets' or 'Upload File' actions.

• Get File Details

  Tool to retrieve details of a specific file. Use after uploading or listing assets to get full metadata.

• Get Upload Authentication Parameters

  Tool to generate authentication parameters for client-side file uploads. Use when preparing client-side uploads.

• Get Usage

  Retrieve ImageKit account usage metrics for a specified date range. Returns bandwidth consumption and media library storage usage. The response includes data from startDate up to (but not including) endDate. Maximum allowed date range is 90 days.

• List and Search Media Assets

  List and search media assets (files, folders, file-versions) in your ImageKit media library. Use this tool to: - Browse all assets with optional pagination (limit/skip) - Filter by type (file, folder, file-version, or all) - Filter by name, tags, or file type (image/non-image) - Search with advanced Lucene-style queries (e.g., 'size > 1000000 AND tags IN

• Move Folder

  Move a folder from one location to another in your ImageKit media library. This operation is asynchronous - it returns a jobId immediately, and the actual move happens in the background. The folder will be moved to become a subfolder of the destination path. Use IMAGEKIT_IO_BULK_JOB_STATUS with the returned jobId to check if the move has completed. Example: Moving '/photos/summer' to '/archive' will result in '/archive/summer'.

• Rename File

  Renames an existing file in the ImageKit media library. Use this action when you need to change a file's name. Important: Old URLs will stop working after rename (unless CDN cache is active). This operation renames all file versions. Set purgeCache=True to clear CDN cached content for the old URL. Returns 404 if file not found, 409 if a file with the new name already exists in the same folder.

• Update File Details

  Update file details in ImageKit media library. Use this tool to modify tags, custom coordinates, custom metadata, AI tags, apply extensions (like background removal), or change publication status. Note: When updating publication status via 'publish', no other parameters can be included in the request.

• Bulk Job Status

  Retrieve the status of a bulk folder operation. Use this tool to monitor the progress of asynchronous Copy Folder or Move Folder operations by providing the jobId returned from those operations.

• Bulk Move Files

  Tool to move multiple files in bulk. Use when you need to relocate up to 100 ImageKit files to a specified folder in one API call.

• Bulk Remove Tags

  Tool to remove tags from multiple files in bulk. Use when you need to strip specified tags from up to 50 existing files in one API call.

• Check purge cache status

  Tool to check the status of a cache purge request. Use after initiating a purge to retrieve its current state. Example: "What's the status of purge request id abc123?"

• Create Custom Metadata Field

  Create a new custom metadata field in ImageKit DAM. Use this tool to define custom metadata fields that can be attached to assets (images, videos, etc.) in your ImageKit media library. Once created, you can assign values to these fields on individual assets for better organization and searchability. Supported field types: - Text/Textarea: For string values with optional length constraints - Number: For numeric values with optional min/max constraints - Date: For ISO8601 date strings with optional date range constraints - Boolean: For true/false values - SingleSelect/MultiSelect: For predefined options (requires selectOptions) Note: Field names must be unique across all fields (including deleted ones). Field types cannot be changed after creation.

• Delete Custom Metadata Field

  Permanently deletes a custom metadata field from ImageKit. This action is irreversible. Note: Even after deletion, you cannot create a new field with the same name. Use 'List Custom Metadata Fields' first to get the field ID if needed. Rate limit: 5 requests/second for custom metadata field operations.

• Delete File Version

  Permanently deletes a specific non-current file version from ImageKit.io. Use this when you need to remove an older version of a file while keeping the current version intact. Note: This action is irreversible. To delete all versions of a file, use the Delete File action instead.

• Delete Folder

  Permanently delete a folder and all its contents from ImageKit Media Library. WARNING: This is a destructive operation that cannot be undone. All files and subfolders within the specified folder will be permanently removed. Use this when you need to: - Remove an entire folder structure - Clean up unused folders - Delete test/temporary folders The operation is idempotent - deleting a non-existent folder will not raise an error.

• Delete Multiple Files

  Permanently delete multiple files from ImageKit media library in a single batch operation. Use this tool when you need to: - Remove up to 100 files at once by their unique file IDs - Clean up unused assets from your media library - Bulk delete files after migration or reorganization Important notes: - Deletion is permanent and includes all file versions - Cached CDN responses are NOT automatically purged (use Purge Cache action if needed) - File IDs can be obtained from 'List and Search Assets' or upload responses Returns the list of successfully deleted file IDs. On partial success (some files deleted, some failed), also returns an errors array with per-file failure details.

• Get File Metadata

  Tool to retrieve metadata of an uploaded file. Use after confirming a successful upload to get EXIF, pHash, dimensions, and other image metadata.

• Get File Version Details

  Tool to retrieve details of a specific file version. Use after listing or uploading assets when you need to inspect version metadata.

• List Custom Metadata Fields

  List all custom metadata fields defined in the ImageKit Media Library. Use this tool to: - Retrieve all metadata field definitions (name, label, type, constraints) - Get field IDs required for updating or deleting fields - View field configurations (required, default values, select options) - Include soft-deleted fields when needed for auditing

• List File Versions

  Retrieves all versions of a specific file in ImageKit. Returns a list of file version objects including metadata like version ID, creation date, and publication status. Use this to view file history, compare versions, or find a specific version to restore. Requires a valid fileId which can be obtained from the List Assets API or Upload API response.

• Purge ImageKit Cache

  Purge CDN and ImageKit internal caches for a specific URL or URL pattern. Use this action when you need to: - Invalidate cached content after updating an image - Force CDN to fetch the latest version of a file - Clear cache for a directory using wildcard (*) Note: Cache purging is asynchronous. Use the returned requestId with IMAGEKIT_IO_PURGE_STATUS to check completion. Monthly purge limits apply based on your pricing plan (typically 1000 URLs/month).

• Restore File Version

  Restores a non-current file version to become the current version in ImageKit. Use this to revert a file to a previous state. First use the List File Versions API to find the versionId of the version you want to restore.

• Update Custom Metadata Field

  Updates an existing custom metadata field's label or schema constraints in ImageKit DAM. Use this to: - Change the display label of a metadata field - Update validation constraints (min/max values, min/max length) - Set or modify the default value - Change whether the field is required Note: The field type and name cannot be changed after creation. At least one of 'label' or 'schema' must be provided in the request.