Saved Extensions

Saved extensions let you create reusable configurations for different ImageKit extensions and apply them across multiple files, either from the dashboard or via APIs. For example, instead of repeatedly selecting the same set of options for background removal or repeatedly creating a long list of sub-tasks within AI tasks, you can create a reusable configuration of these extensions, save it, and reference it by its ID in APIs and the UI.

Key benefits:

• Reusability: Define complex configurations once, use everywhere with just their IDs.
• Consistency: Ensure the same processing logic across all files to eliminate manual errors.
• Team collaboration: Share standardized configurations across your organization.
• Simplified API calls: Reference by ID instead of repeating full JSON configuration.

Saved extensions work with all ImageKit extensions:

The primary benefit of saved extensions is for AI tasks that inherently have complex JSON configurations containing multiple sub-tasks, vocabularies, and conditional logic. Instead of maintaining and adding the entire JSON of an AI task every time, you can simply reference the saved extension ID in the APIs and from the dashboard.

Go to Settings → Media Library → Saved Extensions and click Add New.

Fill in the form:

• Name: Descriptive name for the extension (e.g., "Product Image Classifier")
• Description: Explain what this extension does
• Configuration: The complete extension JSON. Sample configurations are given below.

Click Create to save.

{
  "name": "remove-bg",
  "options": {
    "add_shadow": false,
    "semitransparency": true,
    "bg_color": "81d4fa", //if used, bg_image_url must be empty
    "bg_image_url": "<background_image_url>" //if used, bg_color must be empty
  }
}

{
  "name": "google-auto-tagging" //or "aws-auto-tagging",
  "options": {
    "minConfidence": 70, //number
    "maxTags": 5 //number
  }
}

{
  "name": "ai-auto-description"
}

All saved extensions are listed at Settings → Media Library → Saved Extensions with their names, descriptions, and IDs.

Click any extension to view its full configuration.

Click the three-dot menu on any saved extension to Edit or Delete it.

Use the Saved Extensions API for programmatic CRUD operations:

• Create saved extension
• List saved extensions
• Get saved extension details
• Update saved extension
• Delete saved extension

The API returns a unique id for each saved extension, which you use in upload and update operations.

When uploading files, expand Settings and select saved extensions from the list.

All selected files will be processed with the chosen saved extensions.

Select files in Media Library → Right-click → Apply Saved extensions → Choose from the list → Apply

Reference the saved extension ID in the extensions parameter:

curl -X POST 'https://upload.imagekit.io/api/v2/files/upload' \
  -u private_key: \
  -F 'file=@image.jpg' \
  -F 'fileName=image.jpg' \
  -F 'extensions=[{
    "name": "saved-extension",
    "id": "ext_abc123def456"
  }]'

Use the Update File Details API:

curl -X PATCH 'https://api.imagekit.io/v1/files/:fileId/details' \
  -H 'Content-Type: application/json' \
  -u private_key: \
  -d '{
    "extensions": [{
      "name": "saved-extension",
      "id": "ext_abc123def456"
    }]
  }'