Skip to content

Frameleaf, explained

A good place to start.

Practical guides for your library and your hardware. Read a topic, or ask Frameleaf to help you find your next step.

API and command-line uploads Backup and restore Command Center Config file Database storage and recovery Email Environment variables External libraries Hardware acceleration Jobs and queues Maintenance mode Recover missing or damaged media Monitoring and logs Move to a new server Physical deduplication Remote access on your own Remote machine learning Reverse proxy Scaling Server commands Sign-in and OAuth Storage template System integrity System settings Upgrading Users Video transcoding Workers and where jobs run Workflows Use the Server API Android iPhone and iPad Your Frameleaf account Delete your account Buddy backup Cloud backup Cloud GPU Frameleaf Cloud Remote access Ask Frameleaf Choose processing for your hardware FAQ Photo credits Supported formats Troubleshooting Export your library Import from a folder or another app Bring an existing library Switch from Immich Import from Google Photos iCloud Photos Sync server setup How iCloud Photos Sync works Import from iCloud Photos Synology TrueNAS Unraid Features overview First steps after installing Install with Frameleaf Manager What is Frameleaf?Manual Docker Compose installation Other ways to install Requirements Audio and music Captions and voice-over Colour Exporting Studio overview Restoration Timeline editing Titles and motion Account settings Set up AI descriptions AI descriptions Albums and shared spaces Casting to a TV Documents and text in photos Duplicates Editing Library Care Library and timeline Memories iPhone and Android apps Notifications How face recognition works People and pets Places and map Preservation packages Locked and private content Choose a smart search model Search syntax Search Sharing Built-in smart albums Tags Trash and large files Uploads and downloads XMP sidecars Apple TV iPhone Duo and wide windows Stage models for offline inference List all activities Create an activity Retrieve activity statistics Delete an activity List backup device metadata across users Delete database backup List database backups Get backup restore verification Record a backup restore test Start database backup restore flow Upload database backup Download database backup List the file trash Delete a file permanently Restore a file from the file trash Get integrity report by type Delete integrity report item Download flagged file Export integrity report by type as CSV Get integrity check runs Get integrity report summary Detect existing install Log into maintenance mode Get maintenance mode status Create a notification Render email template Send test email Restore a copy of an applied physical deduplication plan Verify an applied physical deduplication plan Review a physical deduplication plan Get physical deduplication preview Request physical deduplication preview Retrieve calendar heatmap activity Retrieve whether a user has a PIN Retrieve user preferences Update user preferences Retrieve user sessions `SessionService.delete` only checks `Permission.AuthDeviceDelete` over the caller's own sessions, so an administrator could never revoke a foreign session through it. This is the explicit, audited admin path the account detail's Security tab needs instead.Retrieve user statistics List album source links Resolve album sources Delete an album source link Update an album source link Remove assets through an album source link Add assets through an album source link List all albums Create an album Add assets to albums Retrieve the album icon catalogue Arrange a group of the album directory Retrieve album statistics Retrieve the album directory Delete an album Retrieve an album Update an album Remove assets from an album Add assets to an album Move an album into or out of a collection Count descendant albums Retrieve album map markers Remove user from album Update user role Share album with users Retrieve library analytics List analytics scopes List recent archive operations Archive a selection in the background Count and freeze every matching Timeline asset Retrieve an archive operation Confirm a prepared archive selection Undo an archive operation Search asset files Delete an asset file Retrieve an asset file Download an asset file Delete assets Upload asset Update assets Check bulk upload Copy asset Run an asset job Lock assets Delete asset metadata Upsert asset metadata Get asset statistics Unlock assets Get resumable asset upload limits Create resumable asset upload Commit two verified Live Photo upload resources atomically Cancel an unpublished upload Get durable upload offset Append immutable upload bytes Recover a completed upload result Retrieve an asset Update an asset List develop versions of an asset Save a develop recipe as a new version Upload a develop artifact List exports of an original for editing elsewhere Export an original for editing elsewhere Bring back a file developed elsewhere Suggest a subject or sky mask locally Render a develop preview Revert to the original or an earlier develop version View a rendered develop file Cancel a develop render Render a develop version List saved video versions Export the current video version Prune an unselected video version Download a video version master Restore a saved video version Remove edits from an existing asset Retrieve edits for an existing asset Apply edits to an existing asset List the original video's keyframes Get image enrichment metadata Update image enrichment metadata Get asset metadata Update asset metadata Delete asset metadata by key Retrieve asset metadata by key Retrieve asset OCR data Download original asset Discard a restoration View a restoration file View asset thumbnail Play asset video Get HLS main playlist End HLS streaming session Get HLS media playlist Get HLS segment or init file Play the Studio HDR intermediate Retrieve best photos Retrieve classification contributions for an asset Preview a classification rule List classification rules Create a classification rule Delete a classification rule Retrieve a classification rule Update a classification rule Apply a classification rule Review classification rule matches List classification rule matches Plan a classification rule re-evaluation Retrieve classification rule settings Retrieve cluster group requests Decline a cluster group request Accept a cluster group request Leave a cluster group Regenerate people of users in cluster group Retrieve the requests sent by a cluster group Create a cluster group request Retrieve the users of a cluster group List develop presets Save a develop preset Delete a develop preset Update a develop preset Search documents Retrieve a document Clear a document field decision Decide a document field Correct or dismiss a line of text Restore a line of text Download asset archive Retrieve download information Delete duplicates Retrieve duplicates Retrieve recent duplicate decisions Resolve duplicate groups Retrieve the duplicate review Dismiss a duplicate group Get a video moment frame Find moments like a video frame Search video moments Choose a video cover frame Get video moments Add a video moment Delete a video moment Update a video moment Retrieve faces for asset Create a face Retrieve the face source revision for an asset Delete a face Correct a face Re-assign a face to another person Stop sharing items with people Share items with people List who items are shared with Items shared with you Retrieve queue counts and status Create a manual job List durable job runs Inspect selected job run items Run jobs Retrieve libraries Create a library Retrieve managed upload statistics Delete a library Retrieve a library Update a library Review a library removal Remove a library Cancel a library scan Scan a library Retrieve library statistics Validate library settings List live photo relink candidates Relink live photos Retrieve map markers Reverse geocode coordinates Retrieve map statistics List media health findings Choose media health candidates Move confirmed corrupt media to trash Recover damaged media from a verified copy Start corrupt media scan Dismiss media health findings Locate missing media Relink missing media Start missing media scan Reopen media health findings List Library Care search locations Get Library Care summary Clear a finished media operation View a source reversal preview Get a completed source reversal result Retrieve memories Create a memory Retrieve memory exports Delete a memory export Retrieve a memory export Cancel a memory export Download a memory export Save a memory highlight to the library Remove a memories show-less rule Retrieve memories show-less rules Show less of a person, pet, date or kind of memory Retrieve memories statistics Delete a memory Retrieve a memory Update a memory Remove assets from a memory Add assets to a memory Export a memory Delete notifications Retrieve notifications Update notifications Delete a notification Get a notification Update a notification Retrieve partners Create a partner Get the Locked partner items notice Dismiss the Locked partner items notice Remove a partner Create a partner Update a partner Delete people Get all people Create a person Update people Undo a face correction Merge people Get merge suggestions Undo a merge suggestion verdict Record a merge suggestion verdict Delete person Get a person Update person Get correction history Merge people Reassign faces Get person statistics Get person thumbnail Retrieve pets Create a pet Accept a pet recognition candidate Reject a pet recognition candidate Retrieve the pet observations of an asset Remove a pet observation Delete a pet Retrieve a pet Update a pet Merge pets Retrieve pet observations Add a pet observation photographyGallery photographyApprove photographyChoices photographyLogo photographyAccept photographyCheckout photographyOutput photographyOutputPreview photographyFile photographySession photographySubmit photographyZip photographyArchive photographyCallback photographyStudioPresets photographySaveStudioPreset Read your private shoots Save your shoots using the loaded revision Read your private studio branding Save private studio branding with the workspace revision List your eligible unlocked studio logo images View an eligible owned logo thumbnail without original metadata Preview a watermark using the production font metrics and renderer Read a page of unlocked shoot photos Rate or reject an owned photo in your shoot photographySite photographySaveSite photographyPublicSite photographyPublicLogo photographyPublicPhoto photographyList photographyGet photographyApproval photographyAssembly photographyRetryCapture photographyIntake photographyOrder photographyPayment photographySavePreset photographyApplyPreset photographyPublish photographyInvite photographyRecipient photographyRetry photographyApplyStudioPreset List all plugins Retrieve plugin methods Retrieve workflow templates Retrieve a plugin Remove a preservation package Download a preservation package Get a preservation package item report Download a preservation manifest Preview a preservation export Get restoration items List all queues Retrieve a queue Update a queue Empty a queue Retry failed queue jobs Retrieve queue statistics for an account Ask Search Retrieve assets by city Retrieve asset counts by city Retrieve explore data Search facet counts Search date histogram Search large assets Search assets by metadata Search people Search places Search random assets Smart asset search Smart search statistics Search asset statistics Retrieve search suggestions Get APK links Get app releases Library preparation for this authenticated device Start the managed library rescan Finish after catalog and browsing previews are cached Manager machine-authenticated setup status Manager machine-authenticated rescan Get supported media types Get statistics Get storage Get server version Get version check status Check for updates now Get version history Delete all sessions Retrieve sessions Create a session Delete a session Update a session Lock a session Retrieve all shared links Create a shared link Delete a shared link Retrieve a shared link Update a shared link Remove assets from a shared link Add assets to a shared link List shared space invitations List recipient groups Create a recipient group Delete a recipient group Update a recipient group Accept a shared space invitation What happened in a shared space List albums linked into a shared space Unlink an album from a shared space Link an album into a shared space List comments in a shared space Comment in a shared space Remove a shared space comment Edit a shared space comment Decline a shared space invitation Withdraw a shared space invitation List shared space members What is new in a shared space since your last visit People in a shared space Link a person into a shared space Unlink a person from a shared space Preview a shared space Mark a shared space seen Delete stacks Retrieve stacks Create a stack Delete a stack Retrieve a stack Update a stack Remove an asset from a stack Download a Studio bundle Upload a Studio bundle Discard an uploaded Studio bundle Get an uploaded Studio bundle Download a Studio export kept with its project Open a Studio preview stream Close a Studio preview stream Get a Studio preview stream Answer a Studio preview stream Reconnect a Studio preview stream Request a Studio preview frame Cancel a Studio preview Get a Studio preview View a Studio preview frame List Studio projects Create a Studio project Empty the Studio trash Delete a Studio project Get a Studio project Update a Studio project List Studio review comments Add a Studio review comment Remove a Studio review comment Update a Studio review comment Duplicate a Studio project List the files imported into a Studio project Import a file into a Studio project Read a file imported into a Studio project Acquire or renew the write lease Release the write lease Restore a Studio project revision Queue a Studio clip source reversal Apply a completed Studio clip source reversal List Studio project history Save a Studio project revision Get a Studio project revision Compare two Studio project revisions Restore a Studio project from the trash Get a restored version for Studio Get your Studio workspace layout Save your Studio workspace layout Retrieve tags Create a tag Upsert tags Tag assets Retrieve tag statistics Delete a tag Retrieve a tag Update a tag Untag assets Tag assets List Google Photos imports Start a Google Photos import List the permitted import locations Delete a Google Photos import Get a Google Photos import Stage a Takeout archive Remove a staged Takeout archive Upload part of a Takeout archive Check a staged part of a Takeout archive Pause, resume or cancel a Google Photos import Import the reviewed items List the items of a Google Photos import Choose metadata for an item, or leave it out List possible Live Photos in a Google Photos import Link or separate a possible Live Photo Scan a Google Photos import Get time bucket Get time buckets Get timeline highlights Get the timeline in a flat order Get utility activity Apply a reviewed trash change Empty trash List trash items Restore trash Restore assets Review a trash change Get trash summary Get all users List own backup devices Register or report an own backup device Remove an own backup device without deleting assets List own device reconciliation history Start own device inventory reconciliation Reconcile one complete differing bucket Retrieve calendar heatmap activity Delete user onboarding Retrieve user onboarding Update user onboarding Get my pinned collections Replace my pinned collections Get my preferences Update my preferences Get my preference history Delete user profile image Create user profile image Retrieve a user Retrieve user profile image Retrieve assets by original path Retrieve folder summaries Retrieve unique paths List all workflows Create a workflow List all workflow triggers Delete a workflow Retrieve a workflow Update a workflow Retrieve workflow logs Retry a workflow run Retrieve a workflow