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.
FileSpin uses JSON Schema 2020-12 with a FileSpin envelope. Each schema has filespin_properties for UI rendering, searchability, and keyword indexing.
Default Schema (ID 0): Contains a single filespin_search_txt searchable text field. Cannot be modified.
Real-World Use Cases
- eCommerce — Track SKU, product name, category, seasonal tags, usage rights, and approval status for product images
- Events & Conferences — Capture speaker name, session ID, sponsor affiliation, and usage rights for event photography
- Attractions & Experiences — Tag photos with guest ID, ride, location, and timestamp for guest galleries
- Real Estate — Organize property images by listing ID, room type, and status
For the full workflow (presets, designing, assigning, searching), see Organizing Assets with Custom Metadata Schemas.
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 |