Skip to main content

API Overview

FileSpin exposes all its features via a comprehensive REST API. Use the API to manage assets, users, collections, addons, and more from both backend and frontend applications.

All API endpoints use JSON for request and response bodies, and require authentication via API Key, JWT, or OAuth2.

API Sections

SectionDescription
Asset APIUpload, download, delete, and manage asset content, metadata, conversions, and content links
Asset Search APIFull-text search with faceted navigation, pagination, and advanced query options
Asset Processing APITrigger image conversions, video transcodes, and addon processing
Asset Schema APIDefine and manage custom metadata schemas for assets
Asset Collection APIGroup assets into collections for organization and sharing
Asset Shares APIShare assets and manage share templates
User APIManage user accounts, settings, and groups
Jobs APITrack background processing jobs
CDN APIPrefetch and purge CDN-cached content
Usage Stats APIRetrieve API usage analytics and storage metrics
Addons & Addon APIAI/ML addons — face recognition, background removal, and more
Tools & IntegrationWebhooks and integration utilities

See also: Response Codes · Rate Limits