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 or JWT.
API Sections
| Section | Description |
|---|---|
| Asset API | Upload, download, delete, and manage asset content, metadata, conversions, and content links |
| Asset Search API | Full-text search with faceted navigation, pagination, and advanced query options |
| Asset Processing API | Trigger image conversions, video transcodes, and addon processing |
| Asset Schema API | Define and manage custom metadata schemas for assets |
| Asset Collection API | Group assets into collections for organization and sharing |
| User API | Manage user accounts, settings, and groups |
| Jobs API | Track background processing jobs |
| CDN API | Prefetch and purge CDN-cached content |
| Usage Stats API | Retrieve API usage analytics and storage metrics |
| Addons & Addon API | AI/ML addons — face recognition, background removal, and more |
| Tools & Integration | Webhooks and integration utilities |
See also: Response Codes · Rate Limits
OpenAPI Specification
The complete public API is available as a single OpenAPI 3.0 file. Import it into Postman, Insomnia or an iPaaS connector builder, generate a client SDK, or hand it to an AI coding agent:
The file is regenerated from the same specs as this reference on every docs release, so it always matches these pages. AI agents can start from /llms.txt; API discovery tools can use the RFC 9727 catalog at /.well-known/api-catalog.