API reference
This reference lists every route Sift answers, grouped by what it’s about. The full schema is the OpenAPI file in the source tree. The routes serve Sift’s own browser client and desktop app, and they change between releases without notice.
POST /api/auth/lock: Lock AppPOST /api/auth/login: LoginPOST /api/auth/logout: LogoutGET /api/auth/me: MePOST /api/auth/password: Change PasswordPOST /api/auth/password/check: Check PasswordPUT /api/auth/pin: Set PinPOST /api/auth/setup: SetupGET /api/auth/status: Setup StatusPOST /api/auth/unlock: Unlock AppPOST /api/auth/unlock-secrets: Unlock SecretsPOST /api/auth/unlock/password: Unlock App With PasswordGET /api/auth/users: List UsersPOST /api/auth/users: Create GuestPOST /api/auth/users/generate: Generate GuestDELETE /api/auth/users/{user_id}: Delete UserPUT /api/auth/users/{user_id}/disabled: Set User DisabledPOST /api/auth/users/{user_id}/password: Reset User PasswordPOST /api/auth/users/{user_id}/username: Rename User
Backup
Section titled “Backup”GET /api/backup/contents: ContentsPOST /api/backup/export: Export NowPOST /api/backup/restore: RestoreGET /api/backup/saved/{name}: Copy OfGET /api/backup/schedule: Read SchedulePUT /api/backup/schedule: Update ScheduleGET /api/backup/unmarked: UnmarkedDELETE /api/backup/unmarked/{name}: Delete Unmarked
Browse
Section titled “Browse”GET /api/assets: List AssetsGET /api/assets/facets: Asset FacetsPOST /api/assets/memberships: Memberships Of AssetsGET /api/assets/random: Random AssetGET /api/assets/{asset_id}: Get AssetPUT /api/assets/{asset_id}: Set Asset RecordGET /api/assets/{asset_id}/history: Get HistoryGET /api/assets/{asset_id}/preview: Get PreviewGET /api/assets/{asset_id}/save-to-device: Save To DeviceGET /api/assets/{asset_id}/sprite: Get SpriteGET /api/assets/{asset_id}/thumb: Get ThumbGET /api/save-log: Save Log
Capture
Section titled “Capture”POST /api/capture/import/clipboard: Import ClipboardPOST /api/capture/import/file: Import UploadPOST /api/capture/import/url: Import Url
Collections
Section titled “Collections”GET /api/collections: List CollectionsPOST /api/collections: Create CollectionGET /api/collections/facets: Collection FacetsGET /api/collections/{collection_id}: Get CollectionPUT /api/collections/{collection_id}: Update CollectionDELETE /api/collections/{collection_id}: Delete CollectionGET /api/collections/{collection_id}/cover: Collection CoverPUT /api/collections/{collection_id}/cover: Set CoverPOST /api/collections/{collection_id}/cover-picture: Upload Collection CoverPUT /api/collections/{collection_id}/favorite: Set Collection FavoriteGET /api/collections/{collection_id}/history: History Of A CollectionGET /api/collections/{collection_id}/items: Collection ItemsPOST /api/collections/{collection_id}/items: Edit ItemsGET /api/collections/{collection_id}/made-by: Maker Of A CollectionPUT /api/collections/{collection_id}/pin: Set Collection PinnedPUT /api/collections/{collection_id}/rating: Set Collection RatingGET /api/collections/{collection_id}/tags: Tags Of CollectionPOST /api/collections/{collection_id}/tags: Tag CollectionPUT /api/collections/{collection_id}/vault: Set Vault
Compress
Section titled “Compress”POST /api/assets/{asset_id}/compress/sample: SamplePOST /api/assets/{asset_id}/edit: Start EditGET /api/assets/{asset_id}/edit/frame: Edit FramePOST /api/assets/{asset_id}/edit/preflight: Edit PreflightGET /api/assets/{asset_id}/made-from: Made FromGET /api/assets/{asset_id}/produced: ProducedPOST /api/compress: StartPOST /api/compress/preflight: PreflightGET /api/compress/samples/{job_id}: Read Sample
GET /api/dedup/carry: Carry TotalsPOST /api/dedup/carry/all: Carry EverywhereGET /api/dedup/groups: List GroupsPOST /api/dedup/groups/confirm: Confirm GroupsPOST /api/dedup/groups/dismiss: Dismiss GroupsGET /api/dedup/groups/{method}/{first}: One GroupGET /api/reclaim: Reclaim SpacePOST /api/reclaim/release-many: Release ManyPOST /api/reclaim/{asset_id}/release: Release Copy
Delete
Section titled “Delete”POST /api/assets/delete: Delete SeveralPOST /api/assets/delete/check: Check DeleteDELETE /api/assets/{asset_id}: Delete AssetDELETE /api/folders/{folder_id}: Delete Folder
Desktop
Section titled “Desktop”GET /api/desktop: DescribeGET /api/desktop/firewall: Read FirewallPOST /api/desktop/firewall: Open FirewallGET /api/desktop/libraries: Read RememberedPOST /api/desktop/libraries/open: Open RememberedGET /api/desktop/log: Read App LogPUT /api/desktop/sharing: Change SharingPUT /api/desktop/start-with-windows: Start With WindowsGET /api/desktop/storage: Read StoragePOST /api/desktop/storage/move: Move StoragePOST /api/desktop/update: Install Update
Download
Section titled “Download”GET /api/creator-art: Creators With A PictureGET /api/creator-art/{username}: Creator ArtGET /api/download-routes: Read RoutesPUT /api/download-routes/{scope}: Set RouteDELETE /api/download-routes/{scope}: Clear RouteGET /api/download-tools: Download ToolsPOST /api/download-tools/latest: Check LatestGET /api/downloads: List DownloadsPOST /api/downloads: Submit DownloadPOST /api/downloads/bulk: Queue BulkPOST /api/downloads/bulk-preview: Preview BulkGET /api/downloads/facets: Download FacetsGET /api/downloads/glance: Downloads At A GlancePOST /api/downloads/links: Submit LinksPOST /api/downloads/seen: Mark Downloads SeenPOST /api/downloads/{download_id}/anyway: Download AnywayPOST /api/downloads/{download_id}/cancel: Cancel DownloadGET /api/downloads/{download_id}/files: Files Of DownloadPOST /api/downloads/{download_id}/first: Promote DownloadPOST /api/downloads/{download_id}/pause: Pause DownloadPOST /api/downloads/{download_id}/remove: Remove DownloadPOST /api/downloads/{download_id}/restore: Restore DownloadPOST /api/downloads/{download_id}/resume: Resume DownloadPOST /api/downloads/{download_id}/retry: Retry DownloadGET /api/site-connections: List ConnectionsPOST /api/site-connections: Save ConnectionPOST /api/site-connections/preview: Preview ConnectionDELETE /api/site-connections/{connection_id}: Delete ConnectionPOST /api/site-connections/{connection_id}/check: Check ConnectionGET /api/site-options: Read Site OptionsPOST /api/site-options/preview: Preview NamePUT /api/site-options/{scope}: Set Site OptionsDELETE /api/site-options/{scope}: Clear Site OptionsGET /api/supported-sites: Supported SitesGET /api/tunnels: List TunnelsPOST /api/tunnels: Import TunnelPATCH /api/tunnels/{tunnel_id}: Rename TunnelDELETE /api/tunnels/{tunnel_id}: Delete TunnelPOST /api/tunnels/{tunnel_id}/config: Replace Tunnel ConfigPOST /api/tunnels/{tunnel_id}/start: Start TunnelPOST /api/tunnels/{tunnel_id}/stop: Stop Tunnel
GET /api/assets/{asset_id}/faces: Faces Of AssetPOST /api/faces/accept: Accept FacesGET /api/faces/disagreements: Disagreeing PeopleGET /api/faces/disagreements/{person_id}: Disagreements Of PersonPOST /api/faces/disagreements/{person_id}: Answer DisagreementsGET /api/faces/fingerprints/offers: Fingerprint OffersGET /api/faces/fingerprints/waiting: Waiting FingerprintsDELETE /api/faces/fingerprints/waiting/{entry_id}: Remove Waiting FingerprintsPOST /api/faces/fingerprints/{entry_id}/person: Make Person From FingerprintsPOST /api/faces/forget: Forget FacesGET /api/faces/groups: Face GroupsGET /api/faces/groups/{pile_id}: Face GroupPOST /api/faces/groups/{pile_id}/ignore: Ignore GroupPOST /api/faces/groups/{pile_id}/restore: Restore GroupGET /api/faces/groups/{pile_id}/tracks: Pile TracksGET /api/faces/identified/people: Identified PeopleGET /api/faces/identified/people/{person_id}: Identified For PersonGET /api/faces/known: Known PeoplePOST /api/faces/look-alikes/{person_id}/confirm: Confirm Look AlikesPOST /api/faces/look-alikes/{person_id}/reject: Reject Look AlikesPOST /api/faces/may-be/{person_id}/confirm: Confirm GroupsPOST /api/faces/may-be/{person_id}/reject: Refuse GroupsPOST /api/faces/move: Move FacesPOST /api/faces/name: Name FacesPOST /api/faces/packs/export: Export PackPOST /api/faces/packs/import: Import PackPOST /api/faces/people/{person_id}/confirm-matches: Confirm MatchesPOST /api/faces/people/{person_id}/reject-matches: Reject MatchesPOST /api/faces/references/folder: Import Reference FolderPOST /api/faces/references/folder/path: Import Reference Folder By PathGET /api/faces/references/folder/{job_id}/left-out: Folder Left OutGET /api/faces/references/strength: Reference StrengthsPOST /api/faces/regroup: Regroup FacesPOST /api/faces/remove: Remove FacesPOST /api/faces/scan: Scan LibraryPOST /api/faces/set-aside: Set Aside FacesGET /api/faces/settings: Face Settings StateGET /api/faces/starters: Starters OfferPOST /api/faces/starters: Use StartersGET /api/faces/to-check: To CheckPOST /api/faces/weights/fetch: Fetch WeightsGET /api/faces/work-left: Work LeftPOST /api/faces/{track_id}/confirm: Confirm FaceGET /api/faces/{track_id}/cover: Face CoverGET /api/faces/{track_id}/crop: Face CropPOST /api/faces/{track_id}/reject: Reject FaceGET /api/people/{person_id}/recognition: Recognition Strength
Importing
Section titled “Importing”POST /api/assets/run: Run NowGET /api/importing/build: Build SheetPOST /api/importing/build: Start BuildPOST /api/importing/build/retry: Retry BuildGET /api/importing/folders: Folder AnswersPUT /api/importing/folders/{root_id}: Set Folder AnswersGET /api/importing/run-now: Run Now Passes
Insights
Section titled “Insights”GET /api/insights: Insights PageDELETE /api/insights/history: Clear HistoryGET /api/insights/path: Read PathGET /api/insights/recaps: List RecapsGET /api/insights/recaps/{recap_id}: Open RecapPOST /api/insights/recaps/{recap_id}/dismiss: Dismiss RecapGET /api/insights/recaps/{recap_id}/keep: Keep SheetPUT /api/insights/recaps/{recap_id}/left-out: Leave OutGET /api/insights/recaps/{recap_id}/session: Recap SessionPOST /api/insights/recaps/{recap_id}/video: Recap VideoPOST /api/insights/visits: Report Visits
GET /api/jobs: List JobsPOST /api/jobs/cancel-all: Cancel EverythingPOST /api/jobs/cancel-work: Cancel WorkPOST /api/jobs/clear-canceled: Clear Canceled JobsPOST /api/jobs/clear-failed: Clear Failed JobsPOST /api/jobs/pause: Pause WorkGET /api/jobs/rebuild-previews: Count Rebuildable PreviewsPOST /api/jobs/rebuild-previews: Rebuild PreviewsGET /api/jobs/rebuild-thumbnails: Count RebuildablePOST /api/jobs/rebuild-thumbnails: Rebuild ThumbnailsPOST /api/jobs/resume: Resume WorkPOST /api/jobs/retry-canceled: Retry Canceled JobsPOST /api/jobs/retry-failed: Retry Failed JobsPOST /api/jobs/turbo-mode: Press Turbo ModePOST /api/jobs/{job_id}/cancel: Cancel JobPOST /api/jobs/{job_id}/retry: Retry JobGET /api/jobs/{job_id}/steps: List Steps
Ledger
Section titled “Ledger”GET /api/ledger: LedgerPOST /api/ledger/{event_id}/undo-all: Undo All
Libraries
Section titled “Libraries”GET /api/libraries: List LibrariesPOST /api/libraries: Create LibraryPOST /api/libraries/delete: Delete LibraryGET /api/libraries/duplicate: Duplicate PlanPOST /api/libraries/duplicate: Duplicate LibraryPOST /api/libraries/forget: Forget LibraryPOST /api/libraries/import: Import LibraryPOST /api/libraries/open: Open LibraryPUT /api/libraries/opens-at-start: Choose Opening
Library
Section titled “Library”GET /api/library/browse: BrowseGET /api/library/folders: List FoldersPOST /api/library/folders: Make FolderGET /api/library/folders/facts: Folder FactsPOST /api/library/folders/placed: Place FolderGET /api/library/folders/{folder_id}: Get FolderPATCH /api/library/folders/{folder_id}: Change FolderGET /api/library/folders/{folder_id}/properties: Folder PropertiesGET /api/library/grants: List GrantsPOST /api/library/grants: Add GrantGET /api/library/quarantine: QuarantinedDELETE /api/library/quarantine/{name}: Delete QuarantinedGET /api/library/roots: List RootsPOST /api/library/roots: Add RootPATCH /api/library/roots/{root_id}: Change RootDELETE /api/library/roots/{root_id}: Remove RootPOST /api/library/roots/{root_id}/moved: Root MovedPOST /api/library/roots/{root_id}/rejections/allow: Allow RejectionPOST /api/library/roots/{root_id}/rescan: Rescan Root
GET /api/live: Live State
GET /api/logs: RecentGET /api/logs/archive: Archive
GET /api/loops: List LoopsPOST /api/loops: Create LoopPOST /api/loops/forget: Forget LoopsGET /api/loops/{loop_id}: Get LoopPUT /api/loops/{loop_id}: Rename LoopGET /api/loops/{loop_id}/tags: Loop TagsPOST /api/loops/{loop_id}/tags: Set Loop TagGET /api/loops/{loop_id}/thumb: Loop Thumb
GET /api/assets/{asset_id}/same-music: Same MusicGET /api/music/lookup: Lookup StatePOST /api/music/lookup/again: Ask AgainPOST /api/music/lookup/check: Check LookupPOST /api/music/lookup/files: Look Up FilesPUT /api/music/lookup/key: Set Lookup KeyDELETE /api/music/lookup/key: Remove Lookup Key
Organize
Section titled “Organize”POST /api/assets/move: Move ManyGET /api/assets/{asset_id}/organize: OptionsPOST /api/assets/{asset_id}/rename: RenamePOST /api/moves/{move_id}/undo: UndoPOST /api/organize/rename: Rename BatchPOST /api/organize/rename/preview: Preview Batch
GET /health: Health
People
Section titled “People”POST /api/assets/people: Assign PeoplePOST /api/assets/sites: File Under SitesGET /api/assets/{asset_id}/filings: Filings Of AssetDELETE /api/assets/{asset_id}/filings/{username_id}: Remove FilingGET /api/assets/{asset_id}/people: People Of AssetGET /api/people: List PeoplePOST /api/people: Create PersonGET /api/people/facets: People FacetsPOST /api/people/merge: Merge SeveralGET /api/people/resolve: Resolve TermPOST /api/people/weigh-merge: Weigh SeveralGET /api/people/{person_id}: Read PersonPUT /api/people/{person_id}: Update PersonDELETE /api/people/{person_id}: Delete PersonGET /api/people/{person_id}/aliases: Aliases Of PersonPOST /api/people/{person_id}/aliases: Add AliasDELETE /api/people/{person_id}/aliases/{alias_id}: Remove AliasGET /api/people/{person_id}/cover: Person CoverPUT /api/people/{person_id}/cover: Set Person CoverPOST /api/people/{person_id}/cover-picture: Upload Person CoverPUT /api/people/{person_id}/favorite: Set Person FavoriteGET /api/people/{person_id}/history: History Of A PersonGET /api/people/{person_id}/links: Links Of PersonPOST /api/people/{person_id}/links: Add LinkDELETE /api/people/{person_id}/links/{link_id}: Remove LinkGET /api/people/{person_id}/notes: Notes Of PersonPUT /api/people/{person_id}/pin: Set Person PinnedPUT /api/people/{person_id}/rating: Set Person RatingGET /api/people/{person_id}/tags: Tags Of PersonPOST /api/people/{person_id}/tags: Tag PersonPUT /api/people/{person_id}/vault: Set Person VaultGET /api/sites: List SitesPOST /api/sites: Create SiteGET /api/sites/facets: Site FacetsGET /api/sites/icons/for: Site Icon For LinkGET /api/sites/icons/{slug}: Site IconPOST /api/sites/merge: Merge Several SitesPOST /api/sites/weigh-merge: Weigh Several SitesGET /api/sites/{site_id}: Read SitePUT /api/sites/{site_id}: Update SiteDELETE /api/sites/{site_id}: Delete SiteGET /api/sites/{site_id}/cover: Site CoverPUT /api/sites/{site_id}/cover: Set Site CoverPOST /api/sites/{site_id}/cover-picture: Upload Site CoverPUT /api/sites/{site_id}/details: Set Site DetailsPUT /api/sites/{site_id}/favorite: Set Site FavoriteGET /api/sites/{site_id}/history: History Of A SitePUT /api/sites/{site_id}/pin: Set Site PinnedPUT /api/sites/{site_id}/rating: Set Site RatingGET /api/sites/{site_id}/tags: Tags Of SitePOST /api/sites/{site_id}/tags: Tag SitePUT /api/sites/{site_id}/vault: Set Site VaultGET /api/usernames: List UsernamesPUT /api/usernames/{username_id}: Update UsernamePOST /api/usernames/{username_id}/person: Merge Username Into PersonDELETE /api/usernames/{username_id}/person: Detach Username From Person
Performance
Section titled “Performance”GET /api/performance/accelerator: Read AcceleratorPOST /api/performance/accelerator: Install AcceleratorDELETE /api/performance/accelerator: Remove AcceleratorPOST /api/performance/accelerator/test: Test AcceleratorGET /api/performance/benchmark: First BenchmarkGET /api/performance/hardware: HardwarePOST /api/performance/restart: Restart ServerGET /api/performance/runs/{run_id}/report: Run ReportGET /api/performance/self-test: ResultPOST /api/performance/self-test: Start
Photo sets
Section titled “Photo sets”GET /api/photo-sets: List Photo SetsPOST /api/photo-sets: Create Photo SetGET /api/photo-sets/facets: Photo Set FacetsGET /api/photo-sets/{photo_set_id}: Get Photo SetPUT /api/photo-sets/{photo_set_id}: Rename Photo SetDELETE /api/photo-sets/{photo_set_id}: Delete Photo SetGET /api/photo-sets/{photo_set_id}/cover: Photo Set CoverPUT /api/photo-sets/{photo_set_id}/cover: Set Photo Set CoverPOST /api/photo-sets/{photo_set_id}/cover-picture: Upload Photo Set CoverPUT /api/photo-sets/{photo_set_id}/favorite: Set Photo Set FavoriteGET /api/photo-sets/{photo_set_id}/history: History Of A Photo SetPOST /api/photo-sets/{photo_set_id}/items: Edit Photo Set ItemsGET /api/photo-sets/{photo_set_id}/made-by: Maker Of A Photo SetPUT /api/photo-sets/{photo_set_id}/notes: Set Photo Set NotesPUT /api/photo-sets/{photo_set_id}/pin: Set Photo Set PinnedPUT /api/photo-sets/{photo_set_id}/rating: Set Photo Set RatingGET /api/photo-sets/{photo_set_id}/tags: Photo Set TagsPOST /api/photo-sets/{photo_set_id}/tags: Set Photo Set TagPUT /api/photo-sets/{photo_set_id}/vault: Set Photo Set Vault
Player
Section titled “Player”GET /api/assets/{asset_id}/hls/index.m3u8: Hls PlaylistGET /api/assets/{asset_id}/hls/master.m3u8: Hls MasterGET /api/assets/{asset_id}/hls/{segment}: Hls SegmentGET /api/assets/{asset_id}/local-file: Local FileGET /api/assets/{asset_id}/outgoing: OutgoingPOST /api/assets/{asset_id}/playback: Plan PlaybackGET /api/assets/{asset_id}/rendition: RenditionGET /api/assets/{asset_id}/replays: Replay CurveGET /api/assets/{asset_id}/stream: StreamPOST /api/assets/{asset_id}/view: Record View
Records
Section titled “Records”GET /api/records/fields: Read Fields
Related
Section titled “Related”GET /api/related/{kind}/{entity_id}: Related Counts
Remote
Section titled “Remote”PUT /api/remote/quiet/{screen}: Keep QuietDELETE /api/remote/quiet/{screen}: Speak UpGET /api/remote/screens: List ScreensPOST /api/remote/screens/{screen}: Report ScreenDELETE /api/remote/screens/{screen}: Withdraw ScreenPOST /api/remote/screens/{screen}/commands: Send CommandPUT /api/remote/screens/{screen}/controllers/{controller}: Hold ScreenDELETE /api/remote/screens/{screen}/controllers/{controller}: Let Go Of Screen
Search
Section titled “Search”POST /api/search/history: Remember SearchDELETE /api/search/history: Clear HistoryGET /api/search/named: Named ByGET /api/search/names-now: Names NowPOST /api/search/opened: Search OpenedGET /api/search/parse: Parse QueryGET /api/search/saved: Saved SearchesPOST /api/search/saved: Save SearchPATCH /api/search/saved/{saved_id}: Rename Saved SearchDELETE /api/search/saved/{saved_id}: Delete Saved SearchGET /api/search/suggest: Suggest
Semantic
Section titled “Semantic”GET /api/assets/{asset_id}/similar: Find SimilarGET /api/semantic/available: Read AvailableGET /api/semantic/coverage: Read CoverageDELETE /api/semantic/index: Remove IndexPOST /api/semantic/models/fetch: Fetch ModelsGET /api/semantic/status: Read Status
Settings
Section titled “Settings”GET /api/settings: Read SettingsPUT /api/settings: Update SettingsGET /api/settings/interface: Read InterfacePUT /api/settings/interface: Update Interface
Sharing
Section titled “Sharing”GET /api/sharing: Grants On ObjectPUT /api/sharing: ShareGET /api/sharing/hidden-by: Vault SourcesGET /api/sharing/reach: Reach ReportGET /api/sharing/reach/through: Reach Through FilesPOST /api/sharing/revoke: RevokeGET /api/sharing/sources: Grant SourcesGET /api/sharing/users: Shareable Users
Shoots
Section titled “Shoots”GET /api/shoots: List ShootsGET /api/shoots/{proposal_id}: One ShootPOST /api/shoots/{proposal_id}/make: Make The SetPOST /api/shoots/{proposal_id}/name-the-rest: Name The RestPOST /api/shoots/{proposal_id}/refuse: Not A Set
PUT /api/artists/{artist_id}: Rename ArtistGET /api/songs: List SongsPOST /api/songs: Create SongGET /api/songs/facets: Song FacetsPOST /api/songs/merge: Merge SongsPOST /api/songs/weigh-merge: Weigh Merging SongsGET /api/songs/{song_id}: Get SongPUT /api/songs/{song_id}: Rename SongDELETE /api/songs/{song_id}: Delete SongPUT /api/songs/{song_id}/artists: Set Song ArtistsGET /api/songs/{song_id}/cover: Song CoverPUT /api/songs/{song_id}/cover: Set Song CoverPOST /api/songs/{song_id}/cover-picture: Upload Song CoverPUT /api/songs/{song_id}/favorite: Set Song FavoritePOST /api/songs/{song_id}/files: Edit Song FilesGET /api/songs/{song_id}/history: History Of A SongGET /api/songs/{song_id}/made-by: Maker Of A SongPUT /api/songs/{song_id}/notes: Set Song NotesPUT /api/songs/{song_id}/pin: Set Song PinnedPUT /api/songs/{song_id}/rating: Set Song RatingPUT /api/songs/{song_id}/vault: Set Song Vault
Stash-boxes
Section titled “Stash-boxes”GET /api/stash-boxes: List BoxesPOST /api/stash-boxes: Add BoxGET /api/stash-boxes/creator-sites: Studio QuestionsPOST /api/stash-boxes/creator-sites/{site_id}/site: Studio Is A SitePOST /api/stash-boxes/creator-sites/{site_id}/username: Studio Is A UsernameGET /api/stash-boxes/disagreements: DisagreementsPOST /api/stash-boxes/disagreements/settle: Settle DisagreementGET /api/stash-boxes/disagreements/{subject}/{local_id}: Disagreements OfPOST /api/stash-boxes/enrich: Enrich EntitiesGET /api/stash-boxes/enrichment/{subject}/{local_id}: Enrichment StatePUT /api/stash-boxes/enrichment/{subject}/{local_id}/keep-local: Keep LocalGET /api/stash-boxes/linked: Linked LedgerGET /api/stash-boxes/links/{subject}/{local_id}: Links OfPUT /api/stash-boxes/links/{subject}/{local_id}/{box_id}: Link SubjectDELETE /api/stash-boxes/links/{subject}/{local_id}/{box_id}: Forget LinkPOST /api/stash-boxes/links/{subject}/{local_id}/{box_id}/refresh: Refresh LinkPOST /api/stash-boxes/links/{subject}/{local_id}/{box_id}/take: Take FieldsGET /api/stash-boxes/look-up: Look UpGET /api/stash-boxes/matches: Waiting MatchesPOST /api/stash-boxes/matches/apply: Apply MatchesPOST /api/stash-boxes/matches/refuse: Refuse MatchesGET /api/stash-boxes/recognise/{asset_id}: RecogniseGET /api/stash-boxes/record/{subject}/{local_id}: Record HeldPOST /api/stash-boxes/scan: Start ScanGET /api/stash-boxes/search/{subject}: Search BoxesGET /api/stash-boxes/undecided: UndecidedPUT /api/stash-boxes/{box_id}: Edit BoxDELETE /api/stash-boxes/{box_id}: Forget BoxDELETE /api/stash-boxes/{box_id}/answers: Forget AnswersPOST /api/stash-boxes/{box_id}/check: Check BoxPUT /api/stash-boxes/{box_id}/key: Replace KeyGET /api/stash-boxes/{box_id}/picture: PicturePOST /api/stash-boxes/{box_id}/picture/keep: Keep Picture
Stash_migration
Section titled “Stash_migration”GET /api/stash-migration: Last ReadPOST /api/stash-migration/new-library: New Library From StashPOST /api/stash-migration/read: Read StashPOST /api/stash-migration/run: Run StashGET /api/stash-migration/waiting: Waiting
Suggestions
Section titled “Suggestions”GET /api/suggestions: List SuggestionsGET /api/suggestions/filed: FiledPOST /api/suggestions/filed/{folder_id}/people/{person_id}/undo: Take Back FolderGET /api/suggestions/filenames: Filed From FilenamesPOST /api/suggestions/filenames/{username_id}/undo: Take Back UsernamePOST /api/suggestions/folder/{folder_id}: Say Who A Folder IsPOST /api/suggestions/{claim_id}/confirm: Confirm SuggestionPOST /api/suggestions/{claim_id}/reject: Reject Suggestion
GET /api/swap/device: Swap DevicePOST /api/swap/device/reset: Reset Swap DevicePOST /api/swap/join: Join SwapGET /api/swap/keep-out/{subject}/{local_id}: Kept From SwapsPUT /api/swap/keep-out/{subject}/{local_id}: Keep From SwapsGET /api/swap/people/{person_id}/held-faces: Held FacesPOST /api/swap/people/{person_id}/held-faces: Add Held FacesGET /api/swap/receipts/{session_id}: Swap ReceiptPOST /api/swap/receipts/{session_id}/undo: Undo SwapGET /api/swap/sessions/{session_id}: Swap SessionPOST /api/swap/sessions/{session_id}/code: Answer CodePOST /api/swap/sessions/{session_id}/end: End SwapGET /api/swap/sessions/{session_id}/groups/{key}/files: Group FilesPOST /api/swap/sessions/{session_id}/retry: Retry SwapPOST /api/swap/sessions/{session_id}/take: Take OfferPOST /api/swap/sessions/{session_id}/weigh: Weigh AnswerPOST /api/swap/start: Start SwapPOST /api/swap/token/read: Read TokenGET /api/swap/tunnels: Swap TunnelsGET /api/swap/tunnels/{tunnel_id}/probe: Read ProbePOST /api/swap/tunnels/{tunnel_id}/probe: Host ProbeDELETE /api/swap/tunnels/{tunnel_id}/probe: Stop ProbePOST /api/swap/tunnels/{tunnel_id}/probe/send: Send ProbePOST /api/swap/weigh: Weigh Picks
POST /api/assets/favorite: Set Favorite ManyPOST /api/assets/pin: Set Asset Pinned ManyPOST /api/assets/rating: Set Rating ManyPOST /api/assets/tags: Assign TagsPUT /api/assets/{asset_id}/favorite: Set FavoritePUT /api/assets/{asset_id}/o-count: Set O CountPUT /api/assets/{asset_id}/pin: Set Asset PinnedPUT /api/assets/{asset_id}/rating: Set RatingGET /api/assets/{asset_id}/tags: Tags Of AssetGET /api/tags: List TagsPOST /api/tags: Create TagGET /api/tags/facets: Tag FacetsGET /api/tags/{tag_id}: Read TagPUT /api/tags/{tag_id}: Update TagDELETE /api/tags/{tag_id}: Delete TagGET /api/tags/{tag_id}/cover: Tag CoverPUT /api/tags/{tag_id}/cover: Set Tag CoverPOST /api/tags/{tag_id}/cover-picture: Upload Tag CoverPUT /api/tags/{tag_id}/favorite: Set Tag FavoriteGET /api/tags/{tag_id}/history: History Of A TagPUT /api/tags/{tag_id}/pin: Set Tag PinnedPUT /api/tags/{tag_id}/rating: Set Tag RatingPUT /api/tags/{tag_id}/vault: Set Tag Vault
GET /api/tasks: Read TasksPOST /api/tasks/{task_id}/run: Run Task
Theater
Section titled “Theater”GET /api/theater/arrangements: ArrangementsPOST /api/theater/arrangements: Save ArrangementPATCH /api/theater/arrangements/{arrangement_id}: Update ArrangementDELETE /api/theater/arrangements/{arrangement_id}: Delete ArrangementPOST /api/theater/sessions/{session}: Report SessionPOST /api/theater/watching: Theater Open
GET /api/tidy: SurveyPOST /api/tidy/database/optimize: Optimize DatabasePOST /api/tidy/survey: Start SurveyPOST /api/tidy/{name}: Run
Update
Section titled “Update”GET /api/update/check: Check For UpdatePOST /api/update/dismiss: Dismiss UpdateGET /api/update/version: Running Version Report
POST /api/assets/vault: Set Assets VaultPUT /api/assets/{asset_id}/vault: Set Asset VaultPUT /api/folders/{folder_id}/vault: Set Folder VaultGET /api/vault: Vault StatePOST /api/vault/lock: LockPOST /api/vault/unlock: Unlock
Watermarks
Section titled “Watermarks”POST /api/watermarks/models/fetch: Fetch ModelsDELETE /api/watermarks/reads: Forget ReadsGET /api/watermarks/status: Read Status
Workbench
Section titled “Workbench”GET /api/workbench: BoardPOST /api/workbench/decisions/{decision_id}/undo: Undo