- Category: images & design
- Auth: API_KEY
- Composio-managed OAuth available? N/A
- Tools: 26
- Triggers: 0
- Slug:
IMAGEKIT_IO - Version: 20261101_00
Tools
Bulk Job Status
Bulk Job Status
IMAGEKIT_IO_BULK_JOB_STATUSRetrieve 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.Input Parameters
Output
Bulk Move Files
Bulk Move Files
IMAGEKIT_IO_BULK_MOVE_FILESMove up to 100 ImageKit files to a specified folder. Files are processed individually, with successes and per-file errors returned; file versions are not included in the move request.Input Parameters
Output
Copy Folder
Copy Folder
IMAGEKIT_IO_COPY_FOLDERInitiate 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.Input Parameters
Output
Create Custom Metadata Field
Create Custom Metadata Field
IMAGEKIT_IO_CREATE_CUSTOM_METADATA_FIELDCreate 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.Input Parameters
Output
Create Folder
Create Folder
IMAGEKIT_IO_CREATE_FOLDERCreates 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.Input Parameters
Output
Delete Custom Metadata Field
Delete Custom Metadata Field
IMAGEKIT_IO_DELETE_CUSTOM_METADATA_FIELDPermanently 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.Input Parameters
Output
Delete File
Delete File
IMAGEKIT_IO_DELETE_FILEPermanently 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.Input Parameters
fileId is returned by the upload and list assets APIs.Output
Delete File Version
Delete File Version
IMAGEKIT_IO_DELETE_FILE_VERSIONPermanently 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.Input Parameters
Output
Delete Folder
Delete Folder
IMAGEKIT_IO_DELETE_FOLDERPermanently 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.Input Parameters
Output
Delete Multiple Files
Delete Multiple Files
IMAGEKIT_IO_DELETE_MULTIPLE_FILESPermanently 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.Input Parameters
Output
Get Upload Authentication Parameters
Get Upload Authentication Parameters
Get File Details
Get File Details
Get File Metadata
Get File Metadata
Get File Version Details
Get File Version Details
Get Usage
Get Usage
IMAGEKIT_IO_GET_USAGERetrieve 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.Input Parameters
Output
List and Search Media Assets
List and Search Media Assets
IMAGEKIT_IO_LIST_AND_SEARCH_ASSETSList 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 [“banner”]’) - Sort results by name, date, size, or dimensions Returns a list of asset objects with metadata including URLs, dimensions, tags, and timestamps.Input Parameters
Output
List Custom Metadata Fields
List Custom Metadata Fields
IMAGEKIT_IO_LIST_CUSTOM_METADATA_FIELDSList 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 auditingInput Parameters
Output
List File Versions
List File Versions
IMAGEKIT_IO_LIST_FILE_VERSIONSRetrieves 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.Input Parameters
Output
Move Folder
Move Folder
IMAGEKIT_IO_MOVE_FOLDERMove 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’.Input Parameters
Output
Purge ImageKit Cache
Purge ImageKit Cache
IMAGEKIT_IO_PURGE_CACHEPurge 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).Input Parameters
Output
Check purge cache status
Check purge cache status
IMAGEKIT_IO_PURGE_STATUSTool 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?”Input Parameters
Output
Rename File
Rename File
IMAGEKIT_IO_RENAME_FILERenames 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.Input Parameters
Output
Restore File Version
Restore File Version
IMAGEKIT_IO_RESTORE_FILE_VERSIONRestores 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.Input Parameters
Output
Update Custom Metadata Field
Update Custom Metadata Field
IMAGEKIT_IO_UPDATE_CUSTOM_METADATA_FIELDUpdates 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.Input Parameters
Output
Update File Details
Update File Details
IMAGEKIT_IO_UPDATE_FILE_DETAILSUpdate an ImageKit file’s tags, custom coordinates, custom metadata, remove AI tags, apply extensions, or change publication status. When publication options are supplied, other requested updates are omitted from the request.