# FileSpin

> FileSpin is an AI digital asset management (DAM) platform. Its REST API uploads, stores,
> searches, transforms and delivers images, video and documents, with AI addons for
> auto-tagging, background removal and face recognition.

Base URL: `https://app.filespin.io/api/v1`. Authenticate with an API key in the `X-FileSpin-Api-Key` header,
or a JWT from `POST /api/v1/login` sent as `Authorization: Bearer <token>`.

## API specification

- [OpenAPI 3.0 spec (YAML)](https://developers.filespin.io/openapi.yaml): every public operation, schemas and auth in one file
- [OpenAPI 3.0 spec (JSON)](https://developers.filespin.io/openapi.json): the same spec as JSON
- [API overview](https://developers.filespin.io/api/overview): conventions, sections and data format
- [Response codes](https://developers.filespin.io/api/response-codes)
- [Rate limits](https://developers.filespin.io/api/rate-limits)

## API areas

- [Authentication API](https://developers.filespin.io/authentication/overview): Exchange email and password for a JWT; API keys need no login call. (1 operation)
- [Asset API](https://developers.filespin.io/api-reference/assets/asset-api-introduction): Upload, download, delete, replace, and manage asset files and their metadata. Includes content operations, data/metadata management, conversions, and content links. (16 operations)
- [Asset Search API](https://developers.filespin.io/api-reference/asset-search/asset-search-api-introduction): Full-text search with faceted navigation across all assets. Supports keyword search, filters, custom schema fields, and paginated results. (3 operations)
- [Asset Processing API](https://developers.filespin.io/api-reference/asset-processing/asset-processing-api-introduction): Trigger image conversions, video transcodes, and addon processing for assets. (3 operations)
- [Asset Schema API](https://developers.filespin.io/api-reference/asset-schema/asset-schema-api-introduction): Create and manage custom metadata schemas for assets. An asset schema is a JSON Schema definition that describes the custom metadata fields you want to attach to assets — field definitions, validation rules, search configuration, and UI hints. (7 operations)
- [Asset Collection API](https://developers.filespin.io/api-reference/asset-collection/asset-collection-api-introduction): Asset Collections provide a way to group assets and collaborate with other users. Collections can be private or shared within a user group. (8 operations)
- [User API](https://developers.filespin.io/api-reference/user/user-api-introduction): Manage user accounts, settings, preferences, notifications, and group configurations. (9 operations)
- [Jobs API](https://developers.filespin.io/api-reference/jobs/jobs-api-introduction): Track the status of background processing jobs (video transcodes, batch operations, etc.). (2 operations)
- [CDN API](https://developers.filespin.io/api-reference/cdn/cdn-api-introduction): Manage CDN caching for asset delivery. Pre-cache (prefetch) assets for faster delivery, or purge cached assets when content changes. (2 operations)
- [Usage Stats API](https://developers.filespin.io/api-reference/usage-stats/usage-stats-api-introduction): Retrieve API request, storage, video transcode and addon usage statistics. (4 operations)
- [Addons API](https://developers.filespin.io/api-reference/addons/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, and video storyboard. (9 operations)
- [Tools & Integration API](https://developers.filespin.io/api-reference/tools/tools-integration-api-introduction): Webhook management and integration tools for connecting FileSpin with external services. (1 operation)

## AI agents

- [MCP server](https://developers.filespin.io/api-reference/tools/mcp-server): connect Claude and other MCP clients to FileSpin tools

## Optional

- [Guides](https://developers.filespin.io/guides): task-oriented walkthroughs
- [Image transformations](https://developers.filespin.io/image-transformations/): on-demand image URLs
- [Video streaming](https://developers.filespin.io/video-streaming/): transcoding and HLS playback