Addons API - Introduction
FileSpin provides many addons that can be added and used within a user account. These addons provide special and custom processing such as image auto-tags, image background removal, face recognition, video storyboard, and more.
Available Addons
| Name | ID | Description |
|---|---|---|
| On-demand image sizing with CDN delivery | ON_DEMAND_IMAGE | On-demand image sizing with CDN delivery |
| Image auto-tags | IMAGE_ANALYSIS | ML-based tagging of images for search and discovery |
| Video Storyboard | STORYBOARD | Extract image frames from video as storyboard images |
| Remove Image Background | REMOVE_BACKGROUND | Removes background from an image and replace with transparency |
| Face Recognition and Search | FACE_RECOGNITION | ML-based analysis and indexing of faces in images for search and discovery |
| Export for Print | PRINT_EXPORT | Produces a print-ready file (CMYK, 300 DPI) as TIFF, CMYK JPEG, print PDF, or PDF/X-1a |
Some addons such as FACE_RECOGNITION may not be available by default. Please contact support@filespin.io to enable addons.
Event Hooks Support
Event hooks provide a mechanism to initiate addon processing based on events. For example, FACE_RECOGNITION can be processed:
- on image upload
- on asset metadata update
Following addons support event hooks:
- FACE_RECOGNITION
- PRINT_EXPORT
For additional details on how to setup event hooks for these addons, see Update Addons Settings.
Authentication
- API Key: ApiKeyAuth
- HTTP: Bearer Auth
API key for programmatic access
Security Scheme Type: | apiKey |
|---|---|
Header parameter name: | X-FileSpin-Api-Key |
JWT token obtained from POST /api/v1/login
Security Scheme Type: | http |
|---|---|
HTTP Authorization Scheme: | bearer |
Bearer format: | JWT |