Accept a cluster group request

Join the cluster group the request was created for.

Immich operation: POST /cluster-groups/requests/{id}/accept · tag: Cluster groups

Add assets to an album

Add multiple assets to a specific album by its ID.

Immich operation: PUT /albums/{id}/assets · tag: Albums

Add assets to albums

Send a list of asset IDs and album IDs to add each asset to each album.

Immich operation: PUT /albums/assets · tag: Albums

Add assets to a memory

Add a list of asset IDs to a specific memory.

Immich operation: PUT /memories/{id}/assets · tag: Memories

Add assets to a shared link

Add assets to a specific shared link by its ID. This endpoint is only relevant for shared link of type individual.

Immich operation: PUT /shared-links/{id}/assets · tag: Shared links

Share album with users

Share an album with multiple users. Each user can be given a specific role in the album.

Immich operation: PUT /albums/{id}/users · tag: Albums

Tag assets

Add multiple tags to multiple assets in a single request.

Immich operation: PUT /tags/assets · tag: Tags

Change password

Change the password of the current user.

Immich operation: POST /auth/change-password · tag: Authentication

Change pin code

Change the pin code for the current user.

Immich operation: PUT /auth/pin-code · tag: Authentication

Check bulk upload

Determine which assets have already been uploaded to the server based on their SHA1 checksums.

Immich operation: POST /assets/bulk-upload-check · tag: Assets

Regenerate people of users in cluster group

Forcefully re-run facial recognition for all faces of users in this group.

Immich operation: POST /cluster-groups/{id}/regenerate-people · tag: Cluster groups

Copy asset

Copy asset information like albums, tags, etc. from one asset to another.

Immich operation: PUT /assets/copy · tag: Assets

Create an activity

Create a like or a comment for an album, or an asset in an album.

Immich operation: POST /activities · tag: Activities

Create an album

Create a new album. The album can also be created with initial users and assets.

Immich operation: POST /albums · tag: Albums

Create an API key

Creates a new API key. It will be limited to the permissions specified.

Immich operation: POST /api-keys · tag: API keys

Create a cluster group request

Ask another user to join the cluster group of the current user.

Immich operation: PUT /cluster-groups/{id}/requests · tag: Cluster groups

Create a face

Create a new face that has not been discovered by facial recognition. The content of the bounding box is considered a face.

Immich operation: POST /faces · tag: Faces

Create a manual job

Run a specific job. Most jobs are queued automatically, but this endpoint allows for manual creation of a handful of jobs, including various cleanup tasks, as well as creating a new database backup.

Immich operation: POST /jobs · tag: Jobs

Create a library

Create a new external library.

Immich operation: POST /libraries · tag: Libraries

Create a memory

Create a new memory by providing a name, description, and a list of asset IDs to include in the memory.

Immich operation: POST /memories · tag: Memories

Create a notification

Create a new notification for a specific user.

Immich operation: POST /admin/notifications · tag: Notifications (admin)

Create a partner

Create a new partner to share assets with.

Immich operation: POST /partners · tag: Partners

Create a partner

Create a new partner to share assets with.

Immich operation: POST /partners/{id} · tag: Partners

DEPRECATED — prefer the replacement operation if one exists.

Create a person

Create a new person that can have multiple faces assigned to them.

Immich operation: POST /people · tag: People

Create user profile image

Upload and set a new profile image for the current user.

Immich operation: POST /users/profile-image · tag: Users

Create a session

Create a session as a child to the current session. This endpoint is used for casting.

Immich operation: POST /sessions · tag: Sessions

Create a shared link

Create a new shared link.

Immich operation: POST /shared-links · tag: Shared links

Create a stack

Create a new stack by providing a name and a list of asset IDs to include in the stack. If any of the provided asset IDs are primary assets of an existing stack, the existing stack will be merged into the newly created stack.

Immich operation: POST /stacks · tag: Stacks

Create a tag

Create a new tag by providing a name and optional color.

Immich operation: POST /tags · tag: Tags

Create a user

Create a new user.

Immich operation: POST /admin/users · tag: Users (admin)

Create a workflow

Create a new workflow, the workflow can also be created with empty filters and actions.

Immich operation: POST /workflows · tag: Workflows

Delete an activity

Removes a like or comment from a given album or asset in an album.

Immich operation: DELETE /activities/{id} · tag: Activities

Delete an album

Delete a specific album by its ID. Note the album is initially trashed and then immediately scheduled for deletion, but relies on a background job to complete the process.

Immich operation: DELETE /albums/{id} · tag: Albums

Delete all sessions

Delete all sessions for the user. This will not delete the current session.

Immich operation: DELETE /sessions · tag: Sessions

Delete an API key

Deletes an API key identified by its ID. The current user must own this API key.

Immich operation: DELETE /api-keys/{id} · tag: API keys

Delete an asset file

Delete a file and remove it from the database.

Immich operation: DELETE /asset-files/{id} · tag: Asset files

Delete asset metadata by key

Delete a specific metadata key-value pair associated with the specified asset.

Immich operation: DELETE /assets/{id}/metadata/{key} · tag: Assets

Delete assets

Deletes multiple assets at the same time.

Immich operation: DELETE /assets · tag: Assets

Delete asset metadata

Delete metadata key-value pairs for multiple assets.

Immich operation: DELETE /assets/metadata · tag: Assets

Decline a cluster group request

Delete a pending request to join a cluster group.

Immich operation: DELETE /cluster-groups/requests/{id} · tag: Cluster groups

Delete database backup

Delete a backup by its filename

Immich operation: DELETE /admin/database-backups · tag: Database Backups (admin)

Dismiss a duplicate group

Dismiss a duplicate group by its ID, unlinking all assets in the group without deleting them.

Immich operation: DELETE /duplicates/{id} · tag: Duplicates

Delete duplicates

Delete multiple duplicate assets specified by their IDs.

Immich operation: DELETE /duplicates · tag: Duplicates

Delete a face

Delete a face identified by the id. Optionally can be force deleted.

Immich operation: DELETE /faces/{id} · tag: Faces

Delete integrity report item

Delete a given report item and perform corresponding deletion (e.g. trash asset, delete file)

Immich operation: DELETE /admin/integrity/report/{id} · tag: Maintenance (admin)

Delete a library

Delete an external library by its ID.

Immich operation: DELETE /libraries/{id} · tag: Libraries

Delete a memory

Delete a specific memory by its ID.

Immich operation: DELETE /memories/{id} · tag: Memories

Delete a notification

Delete a specific notification.

Immich operation: DELETE /notifications/{id} · tag: Notifications

Delete notifications

Delete a list of notifications at once.

Immich operation: DELETE /notifications · tag: Notifications

Delete people

Bulk delete a list of people at once.

Immich operation: DELETE /people · tag: People

Delete person

Delete an individual person.

Immich operation: DELETE /people/{id} · tag: People

Delete user profile image

Delete the profile image of the current user.

Immich operation: DELETE /users/profile-image · tag: Users

Delete server product key

Delete the currently set server product key.

Immich operation: DELETE /server/license · tag: Server

Delete a session

Delete a specific session by id.

Immich operation: DELETE /sessions/{id} · tag: Sessions

Delete a stack

Delete a specific stack by its ID.

Immich operation: DELETE /stacks/{id} · tag: Stacks

Delete stacks

Delete multiple stacks by providing a list of stack IDs.

Immich operation: DELETE /stacks · tag: Stacks

Delete acknowledgements

Delete specific synchronization acknowledgments.

Immich operation: DELETE /sync/ack · tag: Sync

Delete a tag

Delete a specific tag by its ID.

Immich operation: DELETE /tags/{id} · tag: Tags

Delete a user

Delete a user.

Immich operation: DELETE /admin/users/{id} · tag: Users (admin)

Delete user product key

Delete the registered product key for the current user.

Immich operation: DELETE /users/me/license · tag: Users

Delete user onboarding

Delete the onboarding status of the current user.

Immich operation: DELETE /users/me/onboarding · tag: Users

Delete a workflow

Delete a workflow by its ID.

Immich operation: DELETE /workflows/{id} · tag: Workflows

Detect existing install

Collect integrity checks and other heuristics about local data.

Immich operation: GET /admin/maintenance/detect-install · tag: Maintenance (admin)

Download asset archive

Download a ZIP archive containing the specified assets. The assets must have been previously requested via the "getDownloadInfo" endpoint.

Immich operation: POST /download/archive · tag: Download

Download original asset

Downloads the original file of the specified asset.

Immich operation: GET /assets/{id}/original · tag: Assets

Download an asset file

Serve the contents of a specific asset file.

Immich operation: GET /asset-files/{id}/download · tag: Asset files

Download database backup

Downloads the database backup file

Immich operation: GET /admin/database-backups/{filename} · tag: Database Backups (admin)

Apply edits to an existing asset

Apply a series of edit actions (crop, rotate, mirror) to the specified asset.

Immich operation: PUT /assets/{id}/edits · tag: Assets

Empty a queue

Removes all jobs from the specified queue.

Immich operation: DELETE /queues/{name}/jobs · tag: Queues

Empty trash

Permanently delete all items in the trash.

Immich operation: POST /trash/empty · tag: Trash

End HLS streaming session

Releases server resources for the streaming session.

Immich operation: DELETE /assets/{id}/video/stream/{sessionId} · tag: Assets

Finish OAuth

Complete the OAuth authorization process by exchanging the authorization code for a session token.

Immich operation: POST /oauth/callback · tag: Authentication

Get server information

Retrieve a list of information about the server.

Immich operation: GET /server/about · tag: Server

List all activities

Returns a list of activities for the selected asset or album. The activities are returned in sorted order, with the oldest activities appearing first.

Immich operation: GET /activities · tag: Activities

Retrieve activity statistics

Returns the number of likes and comments for a given album or asset in an album.

Immich operation: GET /activities/statistics · tag: Activities

Get the admin configuration

Retrieve admin configuration.

Immich operation: GET /admin/config · tag: Config (admin)

Get the system configuration defaults

Retrieve the default value of every system configuration property.

Immich operation: GET /admin/config/defaults · tag: Config (admin)

Retrieve admin onboarding

Retrieve the current admin onboarding status.

Immich operation: GET /system-metadata/admin-onboarding · tag: System metadata

Retrieve an album

Retrieve information about a specific album by its ID.

Immich operation: GET /albums/{id} · tag: Albums

Retrieve album map markers

Retrieve map marker information for a specific album by its ID.

Immich operation: GET /albums/{id}/map-markers · tag: Albums

Retrieve album statistics

Returns statistics about the albums available to the authenticated user.

Immich operation: GET /albums/statistics · tag: Albums

List all albums

Retrieve a list of albums available to the authenticated user.

Immich operation: GET /albums · tag: Albums

Retrieve libraries

Retrieve a list of external libraries.

Immich operation: GET /libraries · tag: Libraries

Get all people

Retrieve a list of all people.

Immich operation: GET /people · tag: People

Retrieve all shared links

Retrieve a list of all shared links.

Immich operation: GET /shared-links · tag: Shared links

Retrieve tags

Retrieve a list of all tags.

Immich operation: GET /tags · tag: Tags

Retrieve an API key

Retrieve an API key by its ID. The current user must own this API key.

Immich operation: GET /api-keys/{id} · tag: API keys

List all API keys

Retrieve all API keys of the current user.

Immich operation: GET /api-keys · tag: API keys

Get APK links

Retrieve links to the APKs for the current server version.

Immich operation: GET /server/apk-links · tag: Server

Retrieve duplicates

Retrieve a list of duplicate assets available to the authenticated user.

Immich operation: GET /duplicates · tag: Duplicates

Retrieve edits for an existing asset

Retrieve a series of edit actions (crop, rotate, mirror) associated with the specified asset.

Immich operation: GET /assets/{id}/edits · tag: Assets

Retrieve an asset file

Returns metadata about a specific asset file.

Immich operation: GET /asset-files/{id} · tag: Asset files

Retrieve an asset

Retrieve detailed information about a specific asset.

Immich operation: GET /assets/{id} · tag: Assets

Get asset metadata

Retrieve all metadata key-value pairs associated with the specified asset.

Immich operation: GET /assets/{id}/metadata · tag: Assets

Retrieve asset metadata by key

Retrieve the value of a specific metadata key associated with the specified asset.

Immich operation: GET /assets/{id}/metadata/{key} · tag: Assets

Retrieve asset OCR data

Retrieve all OCR (Optical Character Recognition) data associated with the specified asset.

Immich operation: GET /assets/{id}/ocr · tag: Assets

Get asset statistics

Retrieve various statistics about the assets owned by the authenticated user.

Immich operation: GET /assets/statistics · tag: Assets

Retrieve assets by city

Retrieve a list of assets with each asset belonging to a different city. This endpoint is used on the places pages to show a single thumbnail for each city the user has assets in.

Immich operation: GET /search/cities · tag: Search

Retrieve assets by original path

Retrieve assets that are children of a specific folder.

Immich operation: GET /view/folder · tag: Views

Retrieve auth status

Get information about the current session, including whether the user has a password, and if the session can access locked assets.

Immich operation: GET /auth/status · tag: Authentication

Retrieve cluster group requests

Retrieve the pending requests for the current user to join a cluster group.

Immich operation: GET /cluster-groups/requests · tag: Cluster groups

Retrieve the requests sent by a cluster group

Retrieve the pending requests for other users to join the cluster group.

Immich operation: GET /cluster-groups/{id}/requests · tag: Cluster groups

Retrieve the users of a cluster group

Retrieve the users that are a member of the cluster group.

Immich operation: GET /cluster-groups/{id}/users · tag: Cluster groups

Get system configuration

Retrieve the current system configuration.

Immich operation: GET /system-config · tag: System config

DEPRECATED — prefer the replacement operation if one exists.

Get system configuration defaults

Retrieve the default values for the system configuration.

Immich operation: GET /system-config/defaults · tag: System config

DEPRECATED — prefer the replacement operation if one exists.

Retrieve download information

Retrieve information about how to request a download for the specified assets or album. The response includes groups of assets that can be downloaded together.

Immich operation: POST /download/info · tag: Download

Retrieve explore data

Retrieve data for the explore section, such as popular people and places.

Immich operation: GET /search/explore · tag: Search

Retrieve faces for asset

Retrieve all faces belonging to an asset.

Immich operation: GET /faces · tag: Faces

Get integrity report by type

Get all flagged items by integrity report type

Immich operation: GET /admin/integrity/report · tag: Maintenance (admin)

Export integrity report by type as CSV

Get all integrity report entries for a given type as a CSV

Immich operation: GET /admin/integrity/report/{type}/csv · tag: Maintenance (admin)

Download flagged file

Download the untracked/broken file if one exists

Immich operation: GET /admin/integrity/report/{id}/file · tag: Maintenance (admin)

Get integrity report summary

Get a count of the items flagged in each integrity report

Immich operation: GET /admin/integrity/summary · tag: Maintenance (admin)

Retrieve a library

Retrieve an external library by its ID.

Immich operation: GET /libraries/{id} · tag: Libraries

Retrieve library statistics

Retrieve statistics for a specific external library, including number of videos, images, and storage usage.

Immich operation: GET /libraries/{id}/statistics · tag: Libraries

Get HLS main playlist

Returns an HLS main playlist with all available variants for the asset.

Immich operation: GET /assets/{id}/video/stream/main.m3u8 · tag: Assets

Get maintenance mode status

Fetch information about the currently running maintenance action.

Immich operation: GET /admin/maintenance/status · tag: Maintenance (admin)

Retrieve map markers

Retrieve a list of latitude and longitude coordinates for every asset with location data.

Immich operation: GET /map/markers · tag: Map

Get HLS media playlist

Returns an HLS media playlist for one variant of the streaming session.

Immich operation: GET /assets/{id}/video/stream/{sessionId}/{variantIndex}/playlist.m3u8 · tag: Assets

Retrieve a memory

Retrieve a specific memory by its ID.

Immich operation: GET /memories/{id} · tag: Memories

Retrieve the current API key

Retrieve the API key that is used to access this endpoint.

Immich operation: GET /api-keys/me · tag: API keys

Retrieve calendar heatmap activity

Retrieve activity counts for a specified period, in a calendar heatmap format.

Immich operation: GET /users/me/calendar-heatmap · tag: Users

Get my preferences

Retrieve the preferences for the current user.

Immich operation: GET /users/me/preferences · tag: Users

Retrieve current shared link

Retrieve the current shared link associated with authentication method.

Immich operation: GET /shared-links/me · tag: Shared links

Get current user

Retrieve information about the user making the API request.

Immich operation: GET /users/me · tag: Users

Get a notification

Retrieve a specific notification identified by id.

Immich operation: GET /notifications/{id} · tag: Notifications

Render email template

Retrieve a preview of the provided email template.

Immich operation: POST /admin/notifications/templates/{name} · tag: Notifications (admin)

Retrieve notifications

Retrieve a list of notifications.

Immich operation: GET /notifications · tag: Notifications

Retrieve partners

Retrieve a list of partners with whom assets are shared.

Immich operation: GET /partners · tag: Partners

Get a person

Retrieve a person by id.

Immich operation: GET /people/{id} · tag: People

Get person statistics

Retrieve statistics about a specific person.

Immich operation: GET /people/{id}/statistics · tag: People

Get person thumbnail

Retrieve the thumbnail file for a person.

Immich operation: GET /people/{id}/thumbnail · tag: People

Retrieve a plugin

Retrieve information about a specific plugin by its ID.

Immich operation: GET /plugins/{id} · tag: Plugins

Retrieve user profile image

Retrieve the profile image file for a user.

Immich operation: GET /users/{id}/profile-image · tag: Users

Get the public configuration

Retrieve the system configuration properties that are visible to everyone.

Immich operation: GET /public/config · tag: Config (public)

Get the public configuration defaults

Retrieve the default value of the configuration properties that are visible to everyone.

Immich operation: GET /public/config/defaults · tag: Config (public)

Retrieve a queue

Retrieves a specific queue by its name.

Immich operation: GET /queues/{name} · tag: Queues

Retrieve queue jobs

Retrieves a list of queue jobs from the specified queue.

Immich operation: GET /queues/{name}/jobs · tag: Queues

List all queues

Retrieves a list of queues.

Immich operation: GET /queues · tag: Queues

Retrieve queue counts and status

Retrieve the counts of the current queue, as well as the current status.

Immich operation: GET /jobs · tag: Jobs

DEPRECATED — prefer the replacement operation if one exists.

Retrieve reverse geocoding state

Retrieve the current state of the reverse geocoding import.

Immich operation: GET /system-metadata/reverse-geocoding-state · tag: System metadata

Retrieve search suggestions

Retrieve search suggestions based on partial input. This endpoint is used for typeahead search features.

Immich operation: GET /search/suggestions · tag: Search

Get HLS segment or init file

Streams an HLS init segment (init.mp4) or media segment (seg_N.m4s).

Immich operation: GET /assets/{id}/video/stream/{sessionId}/{variantIndex}/{filename} · tag: Assets

Get config

Retrieve the current server configuration.

Immich operation: GET /server/config · tag: Server

DEPRECATED — prefer the replacement operation if one exists.

Get features

Retrieve available features supported by this server.

Immich operation: GET /server/features · tag: Server

DEPRECATED — prefer the replacement operation if one exists.

Get product key

Retrieve information about whether the server currently has a product key registered.

Immich operation: GET /server/license · tag: Server

Get statistics

Retrieve statistics about the entire Immich instance such as asset counts.

Immich operation: GET /server/statistics · tag: Server

Get server version

Retrieve the current server version in semantic versioning (semver) format.

Immich operation: GET /server/version · tag: Server

Retrieve sessions

Retrieve a list of sessions for the user.

Immich operation: GET /sessions · tag: Sessions

Retrieve a shared link

Retrieve a specific shared link by its ID.

Immich operation: GET /shared-links/{id} · tag: Shared links

Retrieve a stack

Retrieve a specific stack by its ID.

Immich operation: GET /stacks/{id} · tag: Stacks

Get storage

Retrieve the current storage utilization information of the server.

Immich operation: GET /server/storage · tag: Server

Get storage template options

Retrieve exemplary storage template options.

Immich operation: GET /system-config/storage-template-options · tag: System config

Get supported media types

Retrieve all media types supported by the server.

Immich operation: GET /server/media-types · tag: Server

Retrieve acknowledgements

Retrieve the synchronization acknowledgments for the current session.

Immich operation: GET /sync/ack · tag: Sync

Stream sync changes

Retrieve a JSON lines streamed response of changes for synchronization. This endpoint is used by the mobile app to efficiently stay up to date with changes.

Immich operation: POST /sync/stream · tag: Sync

Retrieve a tag

Retrieve a specific tag by its ID.

Immich operation: GET /tags/{id} · tag: Tags

Get time bucket

Retrieve a string of all asset ids in a given time bucket.

Immich operation: GET /timeline/bucket · tag: Timeline

Get time buckets

Retrieve a list of all minimal time buckets.

Immich operation: GET /timeline/buckets · tag: Timeline

Retrieve unique paths

Retrieve a list of unique folder paths from asset original paths.

Immich operation: GET /view/folder/unique-paths · tag: Views

Retrieve a user

Retrieve a specific user by their ID.

Immich operation: GET /users/{id} · tag: Users

Retrieve a user

Retrieve a specific user by their ID.

Immich operation: GET /admin/users/{id} · tag: Users (admin)

Retrieve calendar heatmap activity

Retrieve activity counts for a specified period, in a calendar heatmap format.

Immich operation: GET /admin/users/{id}/calendar-heatmap · tag: Users (admin)

Get the configuration with user visibility

Retrieve the system configuration properties that are visible to logged in users.

Immich operation: GET /config · tag: Config (user)

Get the default configuration with user visibility

Retrieve the default value of the configuration properties that are visible to logged in users.

Immich operation: GET /config/defaults · tag: Config (user)

Retrieve user product key

Retrieve information about whether the current user has a registered product key.

Immich operation: GET /users/me/license · tag: Users

Retrieve user onboarding

Retrieve the onboarding status of the current user.

Immich operation: GET /users/me/onboarding · tag: Users

Retrieve user preferences

Retrieve the preferences of a specific user.

Immich operation: GET /admin/users/{id}/preferences · tag: Users (admin)

Retrieve user sessions

Retrieve all sessions for a specific user.

Immich operation: GET /admin/users/{id}/sessions · tag: Users (admin)

Retrieve user statistics

Retrieve asset statistics for a specific user.

Immich operation: GET /admin/users/{id}/statistics · tag: Users (admin)

Get version check status

Retrieve information about the last time the version check ran.

Immich operation: GET /server/version-check · tag: Server

Retrieve version check state

Retrieve the current state of the version check process.

Immich operation: GET /system-metadata/version-check-state · tag: System metadata

Get version history

Retrieve a list of past versions the server has been on.

Immich operation: GET /server/version-history · tag: Server

Retrieve a workflow

Retrieve information about a specific workflow by its ID.

Immich operation: GET /workflows/{id} · tag: Workflows

Retrieve a workflow

Retrieve a workflow details without ids, default values, etc.

Immich operation: GET /workflows/{id}/share · tag: Workflows

Retrieve workflow logs

Retrieve logs of a workflows runs by ID

Immich operation: GET /workflows/{id}/logs · tag: Workflows

List all workflow triggers

Retrieve a list of all available workflow triggers.

Immich operation: GET /workflows/triggers · tag: Workflows

Leave a cluster group

Move the current user into a new cluster group of their own.

Immich operation: POST /cluster-groups/{id}/leave · tag: Cluster groups

Link OAuth account

Link an OAuth account to the authenticated user.

Immich operation: POST /oauth/link · tag: Authentication

List database backups

Get the list of the successful and failed backups

Immich operation: GET /admin/database-backups · tag: Database Backups (admin)

Lock auth session

Remove elevated access to locked assets from the current session.

Immich operation: POST /auth/session/lock · tag: Authentication

Lock a session

Lock a specific session by id.

Immich operation: POST /sessions/{id}/lock · tag: Sessions

Login

Login with username and password and receive a session token.

Immich operation: POST /auth/login · tag: Authentication

Logout

Logout the current user and invalidate the session token.

Immich operation: POST /auth/logout · tag: Authentication

Backchannel OAuth logout

Logout the OAuth account and invalidate the session specified by the sid claim or all sessions if the sid claim is not present.

Immich operation: POST /oauth/backchannel-logout · tag: Authentication

Log into maintenance mode

Login with maintenance token or cookie to receive current information and perform further actions.

Immich operation: POST /admin/maintenance/login · tag: Maintenance (admin)

Retrieve memories statistics

Retrieve statistics about memories, such as total count and other relevant metrics.

Immich operation: GET /memories/statistics · tag: Memories

Merge people

Merge an ordered list of people together into a single person. The final name and birth date are always the first defined value, following the order. Also automatically merges people for other users in the cluster group, skipping people that would result in overriding a previously set name or birth date.

Immich operation: POST /people/merge · tag: People

Merge people

Merge a list of people into the person specified in the path parameter.

Immich operation: POST /people/{id}/merge · tag: People

DEPRECATED — prefer the replacement operation if one exists.

Ping

Pong

Immich operation: GET /server/ping · tag: Server

Play asset video

Streams the video file for the specified asset. This endpoint also supports byte range requests.

Immich operation: GET /assets/{id}/video/playback · tag: Assets

Reassign faces

Bulk reassign a list of faces to a different person.

Immich operation: PUT /people/{id}/reassign · tag: People

Re-assign a face to another person

Re-assign the face provided in the body to the person identified by the id in the path parameter.

Immich operation: PUT /faces/{id} · tag: Faces

Redirect OAuth to mobile

Requests to this URL are automatically forwarded to the mobile app, and is used in some cases for OAuth redirecting.

Immich operation: GET /oauth/mobile-redirect · tag: Authentication

Remove edits from an existing asset

Removes all edit actions (crop, rotate, mirror) associated with the specified asset.

Immich operation: DELETE /assets/{id}/edits · tag: Assets

Remove assets from an album

Remove multiple assets from a specific album by its ID.

Immich operation: DELETE /albums/{id}/assets · tag: Albums

Remove an asset from a stack

Remove a specific asset from a stack by providing the stack ID and asset ID.

Immich operation: DELETE /stacks/{id}/assets/{assetId} · tag: Stacks

Remove assets from a memory

Remove a list of asset IDs from a specific memory.

Immich operation: DELETE /memories/{id}/assets · tag: Memories

Remove a partner

Stop sharing assets with a partner.

Immich operation: DELETE /partners/{id} · tag: Partners

Delete a shared link

Delete a specific shared link by its ID.

Immich operation: DELETE /shared-links/{id} · tag: Shared links

Remove assets from a shared link

Remove assets from a specific shared link by its ID. This endpoint is only relevant for shared link of type individual.

Immich operation: DELETE /shared-links/{id}/assets · tag: Shared links

Remove user from album

Remove a user from an album. Use an ID of "me" to leave a shared album.

Immich operation: DELETE /albums/{id}/user/{userId} · tag: Albums

Reset pin code

Reset the pin code for the current user by providing the account password

Immich operation: DELETE /auth/pin-code · tag: Authentication

Resolve duplicate groups

Resolve duplicate groups by synchronizing metadata across assets and deleting/trashing duplicates.

Immich operation: POST /duplicates/resolve · tag: Duplicates

Restore assets

Restore specific assets from the trash.

Immich operation: POST /trash/restore/assets · tag: Trash

Restore trash

Restore all items in the trash.

Immich operation: POST /trash/restore · tag: Trash

Restore a deleted user

Restore a previously deleted user.

Immich operation: POST /admin/users/{id}/restore · tag: Users (admin)

Reverse geocode coordinates

Retrieve location information (e.g., city, country) for given latitude and longitude coordinates.

Immich operation: GET /map/reverse-geocode · tag: Map

Rotate an API key

Generates a new secret for an API key, immediately invalidating the previous one. The current user must own this API key.

Immich operation: POST /api-keys/{id}/rotate · tag: API keys

Run an asset job

Run a specific job on a set of assets.

Immich operation: POST /assets/jobs · tag: Assets

Run jobs

Queue all assets for a specific job type. Defaults to only queueing assets that have not yet been processed, but the force command can be used to re-process all assets.

Immich operation: PUT /jobs/{name} · tag: Jobs

DEPRECATED — prefer the replacement operation if one exists.

Scan a library

Queue a scan for the external library to find and import new assets.

Immich operation: POST /libraries/{id}/scan · tag: Libraries

Search asset files

Returns all matching asset files.

Immich operation: GET /asset-files · tag: Asset files

Search asset statistics

Retrieve statistical data about assets based on search criteria, such as the total matching count.

Immich operation: POST /search/statistics · tag: Search

Search assets by metadata

Search for assets based on various metadata criteria.

Immich operation: POST /search/metadata · tag: Search

Search large assets

Search for assets that are considered large based on specified criteria.

Immich operation: POST /search/large-assets · tag: Search

DEPRECATED — prefer the replacement operation if one exists.

Retrieve memories

Retrieve a list of memories. Memories are sorted descending by creation date by default, although they can also be sorted in ascending order, or randomly.

Immich operation: GET /memories · tag: Memories

Search people

Search for people by name.

Immich operation: GET /search/person · tag: Search

Search places

Search for places by name.

Immich operation: GET /search/places · tag: Search

Retrieve plugin methods

Retrieve a list of plugin methods

Immich operation: GET /plugins/methods · tag: Plugins

Retrieve workflow templates

Retrieve workflow templates provided by installed plugins

Immich operation: GET /plugins/templates · tag: Plugins

List all plugins

Retrieve a list of plugins available to the authenticated user.

Immich operation: GET /plugins · tag: Plugins

Search random assets

Retrieve a random selection of assets based on the provided criteria.

Immich operation: POST /search/random · tag: Search

Smart asset search

Perform a smart search for assets by using machine learning vectors to determine relevance.

Immich operation: POST /search/smart · tag: Search

Retrieve stacks

Retrieve a list of stacks.

Immich operation: GET /stacks · tag: Stacks

Get all users

Retrieve a list of all users on the server.

Immich operation: GET /users · tag: Users

Search users

Search for users.

Immich operation: GET /admin/users · tag: Users (admin)

List all workflows

Retrieve a list of workflows available to the authenticated user.

Immich operation: GET /workflows · tag: Workflows

Acknowledge changes

Send a list of synchronization acknowledgements to confirm that the latest changes have been received.

Immich operation: POST /sync/ack · tag: Sync

Send test email

Send a test email using the provided SMTP configuration.

Immich operation: POST /admin/notifications/test-email · tag: Notifications (admin)

Set maintenance mode

Put Immich into or take it out of maintenance mode

Immich operation: POST /admin/maintenance · tag: Maintenance (admin)

Set server product key

Validate and set the server product key if successful.

Immich operation: PUT /server/license · tag: Server

Set user product key

Register a product key for the current user.

Immich operation: PUT /users/me/license · tag: Users

Update user onboarding

Update the onboarding status of the current user.

Immich operation: PUT /users/me/onboarding · tag: Users

Setup pin code

Setup a new pin code for the current user.

Immich operation: POST /auth/pin-code · tag: Authentication

Shared link login

Login to a password protected shared link

Immich operation: POST /shared-links/login · tag: Shared links

Register admin

Create the first admin user in the system.

Immich operation: POST /auth/admin-sign-up · tag: Authentication

Start database backup restore flow

Put Immich into maintenance mode to restore a backup (Immich must not be configured)

Immich operation: POST /admin/database-backups/start-restore · tag: Database Backups (admin)

Start OAuth

Initiate the OAuth authorization process.

Immich operation: POST /oauth/authorize · tag: Authentication

Tag assets

Add a tag to all the specified assets.

Immich operation: PUT /tags/{id}/assets · tag: Tags

Unlink all OAuth accounts

Unlinks all OAuth accounts associated with user accounts in the system.

Immich operation: POST /admin/auth/unlink-all · tag: Authentication (admin)

Unlink OAuth account

Unlink the OAuth account from the authenticated user.

Immich operation: POST /oauth/unlink · tag: Authentication

Unlock auth session

Temporarily grant the session elevated access to locked assets by providing the correct PIN code.

Immich operation: POST /auth/session/unlock · tag: Authentication

Untag assets

Remove a tag from all the specified assets.

Immich operation: DELETE /tags/{id}/assets · tag: Tags

Update the system configuration

Update the system configuration with a new system configuration.

Immich operation: PUT /admin/config · tag: Config (admin)

Update admin onboarding

Update the admin onboarding status.

Immich operation: POST /system-metadata/admin-onboarding · tag: System metadata

Update an album

Update the information of a specific album by its ID. This endpoint can be used to update the album name, description, sort order, etc. However, it is not used to add or remove assets or users from the album.

Immich operation: PATCH /albums/{id} · tag: Albums

Update user role

Change the role for a specific user in a specific album.

Immich operation: PUT /albums/{id}/user/{userId} · tag: Albums

Update an API key

Updates the name and permissions of an API key by its ID. The current user must own this API key.

Immich operation: PUT /api-keys/{id} · tag: API keys

DEPRECATED — prefer the replacement operation if one exists.

Update an asset

Update information of a specific asset.

Immich operation: PUT /assets/{id} · tag: Assets

DEPRECATED — prefer the replacement operation if one exists.

Update asset metadata

Update or add metadata key-value pairs for the specified asset.

Immich operation: PUT /assets/{id}/metadata · tag: Assets

Update assets

Updates multiple assets at the same time.

Immich operation: PUT /assets · tag: Assets

DEPRECATED — prefer the replacement operation if one exists.

Upsert asset metadata

Upsert metadata key-value pairs for multiple assets.

Immich operation: PUT /assets/metadata · tag: Assets

Update system configuration

Update the system configuration with a new system configuration.

Immich operation: PUT /system-config · tag: System config

DEPRECATED — prefer the replacement operation if one exists.

Update a library

Update an existing external library.

Immich operation: PUT /libraries/{id} · tag: Libraries

DEPRECATED — prefer the replacement operation if one exists.

Update a memory

Update an existing memory by its ID.

Immich operation: PUT /memories/{id} · tag: Memories

DEPRECATED — prefer the replacement operation if one exists.

Update my preferences

Update the preferences of the current user.

Immich operation: PUT /users/me/preferences · tag: Users

DEPRECATED — prefer the replacement operation if one exists.

Update current user

Update the current user making the API request.

Immich operation: PUT /users/me · tag: Users

DEPRECATED — prefer the replacement operation if one exists.

Update a notification

Update a specific notification to set its read status.

Immich operation: PUT /notifications/{id} · tag: Notifications

Update notifications

Update a list of notifications. Allows to bulk-set the read status of notifications.

Immich operation: PUT /notifications · tag: Notifications

Update a partner

Specify whether a partner's assets should appear in the user's timeline.

Immich operation: PUT /partners/{id} · tag: Partners

Update people

Bulk update multiple people at once.

Immich operation: PUT /people · tag: People

Update person

Update an individual person.

Immich operation: PUT /people/{id} · tag: People

DEPRECATED — prefer the replacement operation if one exists.

Update a queue

Change the paused status of a specific queue.

Immich operation: PUT /queues/{name} · tag: Queues

Update a session

Update a specific session identified by id.

Immich operation: PUT /sessions/{id} · tag: Sessions

DEPRECATED — prefer the replacement operation if one exists.

Update a shared link

Update an existing shared link by its ID.

Immich operation: PATCH /shared-links/{id} · tag: Shared links

Update a stack

Update an existing stack by its ID.

Immich operation: PUT /stacks/{id} · tag: Stacks

DEPRECATED — prefer the replacement operation if one exists.

Update a tag

Update an existing tag identified by its ID.

Immich operation: PUT /tags/{id} · tag: Tags

DEPRECATED — prefer the replacement operation if one exists.

Update a user

Update an existing user.

Immich operation: PUT /admin/users/{id} · tag: Users (admin)

DEPRECATED — prefer the replacement operation if one exists.

Update user preferences

Update the preferences of a specific user.

Immich operation: PUT /admin/users/{id}/preferences · tag: Users (admin)

DEPRECATED — prefer the replacement operation if one exists.

Update a workflow

Update the information of a specific workflow by its ID. This endpoint can be used to update the workflow name, description, trigger type, filters and actions order, etc.

Immich operation: PUT /workflows/{id} · tag: Workflows

DEPRECATED — prefer the replacement operation if one exists.

Upload asset

Uploads a new asset to the server.

Immich operation: POST /assets · tag: Assets

Upload database backup

Uploads .sql/.sql.gz file to restore backup from

Immich operation: POST /admin/database-backups/upload · tag: Database Backups (admin)

Upsert tags

Create or update multiple tags in a single request.

Immich operation: PUT /tags · tag: Tags

Validate library settings

Validate the settings of an external library.

Immich operation: POST /libraries/{id}/validate · tag: Libraries

Validate access token

Validate the current authorization method is still valid.

Immich operation: POST /auth/validateToken · tag: Authentication

View asset thumbnail

Retrieve the thumbnail image for the specified asset. Viewing the fullsize thumbnail might redirect to downloadAsset, which requires a different permission.

Immich operation: GET /assets/{id}/thumbnail · tag: Assets