Endpoints
Scopes:
gallery:read grants listing, downloads, stats. gallery:write allows uploads, metadata updates, folder creation, and translations. gallery:delete is required to schedule deletions. All routes resolve workspace context from the API key/session; do not send manual workspace headers.Key concepts
- Files are stored per workspace. Status reflects the processing state (
completed,processing,deleting, etc.). - Listing resolves localized alt/description metadata using
localeandfallbackLocale. PassincludeMeta=1to embed translation maps and supported languages. - Uploads accept raw multipart files or base64 JSON payloads. The API picks the storage provider automatically based on MIME type and returns a 202 response while background processing finishes. For large videos (>100MB), use the resumable upload endpoint which supports the TUS protocol.
- Deleting a file is asynchronous: the API marks the record as
deletingand emitsgallery.file.deletedwebhooks once storage cleanup is complete. - Folder operations are flat: responses return
parentIdandpathso clients can construct trees client-side. - Stats aggregate file counts and storage usage to help monitor quotas.