Lib.rs

› Authentication
#user-id #assets #album #oauth #create-user #notifications #server-api #asset-id #delete-stack

immich_api_rs

Immich API

by OpenAPI Generator team and contributors. Owned by Nereuxofficial.

1 stable release

1.137.3 Aug 11, 2025

#574 in Authentication

Unlicense

1MB
18K SLoC

Rust API client for immich_api_rs

Immich API

Overview

This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.

  • API version: 1.137.3
  • Package version: 1.137.3
  • Generator version: 7.14.0
  • Build package: org.openapitools.codegen.languages.RustClientCodegen

Installation

Put the package under your project folder in a directory named immich_api_rs and add the following to Cargo.toml under [dependencies]:

immich_api_rs = { path = "./immich_api_rs" }

Documentation for API Endpoints

All URIs are relative to /api

Class Method HTTP request Description
ApiKeysApi create_api_key POST /api-keys
ApiKeysApi delete_api_key DELETE /api-keys/{id}
ApiKeysApi get_api_key GET /api-keys/{id}
ApiKeysApi get_api_keys GET /api-keys
ApiKeysApi update_api_key PUT /api-keys/{id}
ActivitiesApi create_activity POST /activities
ActivitiesApi delete_activity DELETE /activities/{id}
ActivitiesApi get_activities GET /activities
ActivitiesApi get_activity_statistics GET /activities/statistics
AlbumsApi add_assets_to_album PUT /albums/{id}/assets
AlbumsApi add_users_to_album PUT /albums/{id}/users
AlbumsApi create_album POST /albums
AlbumsApi delete_album DELETE /albums/{id}
AlbumsApi get_album_info GET /albums/{id}
AlbumsApi get_album_statistics GET /albums/statistics
AlbumsApi get_all_albums GET /albums
AlbumsApi remove_asset_from_album DELETE /albums/{id}/assets
AlbumsApi remove_user_from_album DELETE /albums/{id}/user/{userId}
AlbumsApi update_album_info PATCH /albums/{id}
AlbumsApi update_album_user PUT /albums/{id}/user/{userId}
AssetsApi check_bulk_upload POST /assets/bulk-upload-check checkBulkUpload
AssetsApi check_existing_assets POST /assets/exist checkExistingAssets
AssetsApi delete_assets DELETE /assets
AssetsApi download_asset GET /assets/{id}/original
AssetsApi get_all_user_assets_by_device_id GET /assets/device/{deviceId} getAllUserAssetsByDeviceId
AssetsApi get_asset_info GET /assets/{id}
AssetsApi get_asset_statistics GET /assets/statistics
AssetsApi get_random GET /assets/random
AssetsApi play_asset_video GET /assets/{id}/video/playback
AssetsApi replace_asset PUT /assets/{id}/original replaceAsset
AssetsApi run_asset_jobs POST /assets/jobs
AssetsApi update_asset PUT /assets/{id}
AssetsApi update_assets PUT /assets
AssetsApi upload_asset POST /assets
AssetsApi view_asset GET /assets/{id}/thumbnail
AuthAdminApi unlink_all_o_auth_accounts_admin POST /admin/auth/unlink-all
AuthenticationApi change_password POST /auth/change-password
AuthenticationApi change_pin_code PUT /auth/pin-code
AuthenticationApi get_auth_status GET /auth/status
AuthenticationApi lock_auth_session POST /auth/session/lock
AuthenticationApi login POST /auth/login
AuthenticationApi logout POST /auth/logout
AuthenticationApi reset_pin_code DELETE /auth/pin-code
AuthenticationApi setup_pin_code POST /auth/pin-code
AuthenticationApi sign_up_admin POST /auth/admin-sign-up
AuthenticationApi unlock_auth_session POST /auth/session/unlock
AuthenticationApi validate_access_token POST /auth/validateToken
DeprecatedApi get_random GET /assets/random
DownloadApi download_archive POST /download/archive
DownloadApi get_download_info POST /download/info
DuplicatesApi delete_duplicate DELETE /duplicates/{id}
DuplicatesApi delete_duplicates DELETE /duplicates
DuplicatesApi get_asset_duplicates GET /duplicates
FacesApi create_face POST /faces
FacesApi delete_face DELETE /faces/{id}
FacesApi get_faces GET /faces
FacesApi reassign_faces_by_id PUT /faces/{id}
JobsApi create_job POST /jobs
JobsApi get_all_jobs_status GET /jobs
JobsApi send_job_command PUT /jobs/{id}
LibrariesApi create_library POST /libraries
LibrariesApi delete_library DELETE /libraries/{id}
LibrariesApi get_all_libraries GET /libraries
LibrariesApi get_library GET /libraries/{id}
LibrariesApi get_library_statistics GET /libraries/{id}/statistics
LibrariesApi scan_library POST /libraries/{id}/scan
LibrariesApi update_library PUT /libraries/{id}
LibrariesApi validate POST /libraries/{id}/validate
MapApi get_map_markers GET /map/markers
MapApi reverse_geocode GET /map/reverse-geocode
MemoriesApi add_memory_assets PUT /memories/{id}/assets
MemoriesApi create_memory POST /memories
MemoriesApi delete_memory DELETE /memories/{id}
MemoriesApi get_memory GET /memories/{id}
MemoriesApi memories_statistics GET /memories/statistics
MemoriesApi remove_memory_assets DELETE /memories/{id}/assets
MemoriesApi search_memories GET /memories
MemoriesApi update_memory PUT /memories/{id}
NotificationsApi delete_notification DELETE /notifications/{id}
NotificationsApi delete_notifications DELETE /notifications
NotificationsApi get_notification GET /notifications/{id}
NotificationsApi get_notifications GET /notifications
NotificationsApi update_notification PUT /notifications/{id}
NotificationsApi update_notifications PUT /notifications
NotificationsAdminApi create_notification POST /admin/notifications
NotificationsAdminApi get_notification_template_admin POST /admin/notifications/templates/{name}
NotificationsAdminApi send_test_email_admin POST /admin/notifications/test-email
OAuthApi finish_o_auth POST /oauth/callback
OAuthApi link_o_auth_account POST /oauth/link
OAuthApi redirect_o_auth_to_mobile GET /oauth/mobile-redirect
OAuthApi start_o_auth POST /oauth/authorize
OAuthApi unlink_o_auth_account POST /oauth/unlink
PartnersApi create_partner POST /partners/{id}
PartnersApi get_partners GET /partners
PartnersApi remove_partner DELETE /partners/{id}
PartnersApi update_partner PUT /partners/{id}
PeopleApi create_person POST /people
PeopleApi delete_people DELETE /people
PeopleApi delete_person DELETE /people/{id}
PeopleApi get_all_people GET /people
PeopleApi get_person GET /people/{id}
PeopleApi get_person_statistics GET /people/{id}/statistics
PeopleApi get_person_thumbnail GET /people/{id}/thumbnail
PeopleApi merge_person POST /people/{id}/merge
PeopleApi reassign_faces PUT /people/{id}/reassign
PeopleApi update_people PUT /people
PeopleApi update_person PUT /people/{id}
SearchApi get_assets_by_city GET /search/cities
SearchApi get_explore_data GET /search/explore
SearchApi get_search_suggestions GET /search/suggestions
SearchApi search_asset_statistics POST /search/statistics
SearchApi search_assets POST /search/metadata
SearchApi search_large_assets POST /search/large-assets
SearchApi search_person GET /search/person
SearchApi search_places GET /search/places
SearchApi search_random POST /search/random
SearchApi search_smart POST /search/smart
ServerApi delete_server_license DELETE /server/license
ServerApi get_about_info GET /server/about
ServerApi get_apk_links GET /server/apk-links
ServerApi get_server_config GET /server/config
ServerApi get_server_features GET /server/features
ServerApi get_server_license GET /server/license
ServerApi get_server_statistics GET /server/statistics
ServerApi get_server_version GET /server/version
ServerApi get_storage GET /server/storage
ServerApi get_supported_media_types GET /server/media-types
ServerApi get_theme GET /server/theme
ServerApi get_version_check GET /server/version-check
ServerApi get_version_history GET /server/version-history
ServerApi ping_server GET /server/ping
ServerApi set_server_license PUT /server/license
SessionsApi create_session POST /sessions
SessionsApi delete_all_sessions DELETE /sessions
SessionsApi delete_session DELETE /sessions/{id}
SessionsApi get_sessions GET /sessions
SessionsApi lock_session POST /sessions/{id}/lock
SessionsApi update_session PUT /sessions/{id}
SharedLinksApi add_shared_link_assets PUT /shared-links/{id}/assets
SharedLinksApi create_shared_link POST /shared-links
SharedLinksApi get_all_shared_links GET /shared-links
SharedLinksApi get_my_shared_link GET /shared-links/me
SharedLinksApi get_shared_link_by_id GET /shared-links/{id}
SharedLinksApi remove_shared_link DELETE /shared-links/{id}
SharedLinksApi remove_shared_link_assets DELETE /shared-links/{id}/assets
SharedLinksApi update_shared_link PATCH /shared-links/{id}
StacksApi create_stack POST /stacks
StacksApi delete_stack DELETE /stacks/{id}
StacksApi delete_stacks DELETE /stacks
StacksApi get_stack GET /stacks/{id}
StacksApi remove_asset_from_stack DELETE /stacks/{id}/assets/{assetId}
StacksApi search_stacks GET /stacks
StacksApi update_stack PUT /stacks/{id}
SyncApi delete_sync_ack DELETE /sync/ack
SyncApi get_delta_sync POST /sync/delta-sync
SyncApi get_full_sync_for_user POST /sync/full-sync
SyncApi get_sync_ack GET /sync/ack
SyncApi get_sync_stream POST /sync/stream
SyncApi send_sync_ack POST /sync/ack
SystemConfigApi get_config GET /system-config
SystemConfigApi get_config_defaults GET /system-config/defaults
SystemConfigApi get_storage_template_options GET /system-config/storage-template-options
SystemConfigApi update_config PUT /system-config
SystemMetadataApi get_admin_onboarding GET /system-metadata/admin-onboarding
SystemMetadataApi get_reverse_geocoding_state GET /system-metadata/reverse-geocoding-state
SystemMetadataApi get_version_check_state GET /system-metadata/version-check-state
SystemMetadataApi update_admin_onboarding POST /system-metadata/admin-onboarding
TagsApi bulk_tag_assets PUT /tags/assets
TagsApi create_tag POST /tags
TagsApi delete_tag DELETE /tags/{id}
TagsApi get_all_tags GET /tags
TagsApi get_tag_by_id GET /tags/{id}
TagsApi tag_assets PUT /tags/{id}/assets
TagsApi untag_assets DELETE /tags/{id}/assets
TagsApi update_tag PUT /tags/{id}
TagsApi upsert_tags PUT /tags
TimelineApi get_time_bucket GET /timeline/bucket
TimelineApi get_time_buckets GET /timeline/buckets
TrashApi empty_trash POST /trash/empty
TrashApi restore_assets POST /trash/restore/assets
TrashApi restore_trash POST /trash/restore
UsersApi create_profile_image POST /users/profile-image
UsersApi delete_profile_image DELETE /users/profile-image
UsersApi delete_user_license DELETE /users/me/license
UsersApi delete_user_onboarding DELETE /users/me/onboarding
UsersApi get_my_preferences GET /users/me/preferences
UsersApi get_my_user GET /users/me
UsersApi get_profile_image GET /users/{id}/profile-image
UsersApi get_user GET /users/{id}
UsersApi get_user_license GET /users/me/license
UsersApi get_user_onboarding GET /users/me/onboarding
UsersApi search_users GET /users
UsersApi set_user_license PUT /users/me/license
UsersApi set_user_onboarding PUT /users/me/onboarding
UsersApi update_my_preferences PUT /users/me/preferences
UsersApi update_my_user PUT /users/me
UsersAdminApi create_user_admin POST /admin/users
UsersAdminApi delete_user_admin DELETE /admin/users/{id}
UsersAdminApi get_user_admin GET /admin/users/{id}
UsersAdminApi get_user_preferences_admin GET /admin/users/{id}/preferences
UsersAdminApi get_user_statistics_admin GET /admin/users/{id}/statistics
UsersAdminApi restore_user_admin POST /admin/users/{id}/restore
UsersAdminApi search_users_admin GET /admin/users
UsersAdminApi update_user_admin PUT /admin/users/{id}
UsersAdminApi update_user_preferences_admin PUT /admin/users/{id}/preferences
ViewApi get_assets_by_original_path GET /view/folder
ViewApi get_unique_original_paths GET /view/folder/unique-paths

Documentation For Models

To get access to the crate's generated documentation, use:

cargo doc --open

Author

Dependencies

~9–25MB
~298K SLoC