# generated.immich.openapi-client
Immich API
The `generated.immich.openapi_client` package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 1.131.3
- Package version: 1.0.0
- Generator version: 7.13.0-SNAPSHOT
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
## Requirements.
Python 3.8+
## Installation & Usage
This python library package is generated without supporting files like setup.py or requirements files
To be able to use it, you will need these dependencies in your own package that uses this library:
* urllib3 >= 1.25.3, < 3.0.0
* python-dateutil >= 2.8.2
* pydantic >= 2
* typing-extensions >= 4.7.1
## Getting Started
In your own code, to use this library to connect and interact with generated.immich.openapi-client,
you can run the following:
```python
import generated.immich.openapi_client
from generated.immich.openapi_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://github.com/api
# See configuration.py for a list of all supported configuration parameters.
configuration = generated.immich.openapi_client.Configuration(
host = "https://github.com/api"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: cookie
configuration.api_key['cookie'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookie'] = 'Bearer'
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Configure Bearer authorization (JWT): bearer
configuration = generated.immich.openapi_client.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)
# Enter a context with an instance of the API client
with generated.immich.openapi_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = generated.immich.openapi_client.APIKeysApi(api_client)
api_key_create_dto = generated.immich.openapi_client.APIKeyCreateDto() # APIKeyCreateDto |
try:
api_response = api_instance.create_api_key(api_key_create_dto)
print("The response of APIKeysApi->create_api_key:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling APIKeysApi->create_api_key: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *https://github.com/api*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*APIKeysApi* | [**create_api_key**](generated/immich/openapi_client/docs/APIKeysApi.md#create_api_key) | **POST** /api-keys |
*APIKeysApi* | [**delete_api_key**](generated/immich/openapi_client/docs/APIKeysApi.md#delete_api_key) | **DELETE** /api-keys/{id} |
*APIKeysApi* | [**get_api_key**](generated/immich/openapi_client/docs/APIKeysApi.md#get_api_key) | **GET** /api-keys/{id} |
*APIKeysApi* | [**get_api_keys**](generated/immich/openapi_client/docs/APIKeysApi.md#get_api_keys) | **GET** /api-keys |
*APIKeysApi* | [**update_api_key**](generated/immich/openapi_client/docs/APIKeysApi.md#update_api_key) | **PUT** /api-keys/{id} |
*ActivitiesApi* | [**create_activity**](generated/immich/openapi_client/docs/ActivitiesApi.md#create_activity) | **POST** /activities |
*ActivitiesApi* | [**delete_activity**](generated/immich/openapi_client/docs/ActivitiesApi.md#delete_activity) | **DELETE** /activities/{id} |
*ActivitiesApi* | [**get_activities**](generated/immich/openapi_client/docs/ActivitiesApi.md#get_activities) | **GET** /activities |
*ActivitiesApi* | [**get_activity_statistics**](generated/immich/openapi_client/docs/ActivitiesApi.md#get_activity_statistics) | **GET** /activities/statistics |
*AlbumsApi* | [**add_assets_to_album**](generated/immich/openapi_client/docs/AlbumsApi.md#add_assets_to_album) | **PUT** /albums/{id}/assets |
*AlbumsApi* | [**add_users_to_album**](generated/immich/openapi_client/docs/AlbumsApi.md#add_users_to_album) | **PUT** /albums/{id}/users |
*AlbumsApi* | [**create_album**](generated/immich/openapi_client/docs/AlbumsApi.md#create_album) | **POST** /albums |
*AlbumsApi* | [**delete_album**](generated/immich/openapi_client/docs/AlbumsApi.md#delete_album) | **DELETE** /albums/{id} |
*AlbumsApi* | [**get_album_info**](generated/immich/openapi_client/docs/AlbumsApi.md#get_album_info) | **GET** /albums/{id} |
*AlbumsApi* | [**get_album_statistics**](generated/immich/openapi_client/docs/AlbumsApi.md#get_album_statistics) | **GET** /albums/statistics |
*AlbumsApi* | [**get_all_albums**](generated/immich/openapi_client/docs/AlbumsApi.md#get_all_albums) | **GET** /albums |
*AlbumsApi* | [**remove_asset_from_album**](generated/immich/openapi_client/docs/AlbumsApi.md#remove_asset_from_album) | **DELETE** /albums/{id}/assets |
*AlbumsApi* | [**remove_user_from_album**](generated/immich/openapi_client/docs/AlbumsApi.md#remove_user_from_album) | **DELETE** /albums/{id}/user/{userId} |
*AlbumsApi* | [**update_album_info**](generated/immich/openapi_client/docs/AlbumsApi.md#update_album_info) | **PATCH** /albums/{id} |
*AlbumsApi* | [**update_album_user**](generated/immich/openapi_client/docs/AlbumsApi.md#update_album_user) | **PUT** /albums/{id}/user/{userId} |
*AssetsApi* | [**check_bulk_upload**](generated/immich/openapi_client/docs/AssetsApi.md#check_bulk_upload) | **POST** /assets/bulk-upload-check | checkBulkUpload
*AssetsApi* | [**check_existing_assets**](generated/immich/openapi_client/docs/AssetsApi.md#check_existing_assets) | **POST** /assets/exist | checkExistingAssets
*AssetsApi* | [**delete_assets**](generated/immich/openapi_client/docs/AssetsApi.md#delete_assets) | **DELETE** /assets |
*AssetsApi* | [**download_asset**](generated/immich/openapi_client/docs/AssetsApi.md#download_asset) | **GET** /assets/{id}/original |
*AssetsApi* | [**get_all_user_assets_by_device_id**](generated/immich/openapi_client/docs/AssetsApi.md#get_all_user_assets_by_device_id) | **GET** /assets/device/{deviceId} | getAllUserAssetsByDeviceId
*AssetsApi* | [**get_asset_info**](generated/immich/openapi_client/docs/AssetsApi.md#get_asset_info) | **GET** /assets/{id} |
*AssetsApi* | [**get_asset_statistics**](generated/immich/openapi_client/docs/AssetsApi.md#get_asset_statistics) | **GET** /assets/statistics |
*AssetsApi* | [**get_memory_lane**](generated/immich/openapi_client/docs/AssetsApi.md#get_memory_lane) | **GET** /assets/memory-lane |
*AssetsApi* | [**get_random**](generated/immich/openapi_client/docs/AssetsApi.md#get_random) | **GET** /assets/random |
*AssetsApi* | [**play_asset_video**](generated/immich/openapi_client/docs/AssetsApi.md#play_asset_video) | **GET** /assets/{id}/video/playback |
*AssetsApi* | [**replace_asset**](generated/immich/openapi_client/docs/AssetsApi.md#replace_asset) | **PUT** /assets/{id}/original | replaceAsset
*AssetsApi* | [**run_asset_jobs**](generated/immich/openapi_client/docs/AssetsApi.md#run_asset_jobs) | **POST** /assets/jobs |
*AssetsApi* | [**update_asset**](generated/immich/openapi_client/docs/AssetsApi.md#update_asset) | **PUT** /assets/{id} |
*AssetsApi* | [**update_assets**](generated/immich/openapi_client/docs/AssetsApi.md#update_assets) | **PUT** /assets |
*AssetsApi* | [**upload_asset**](generated/immich/openapi_client/docs/AssetsApi.md#upload_asset) | **POST** /assets |
*AssetsApi* | [**view_asset**](generated/immich/openapi_client/docs/AssetsApi.md#view_asset) | **GET** /assets/{id}/thumbnail |
*AuthenticationApi* | [**change_password**](generated/immich/openapi_client/docs/AuthenticationApi.md#change_password) | **POST** /auth/change-password |
*AuthenticationApi* | [**login**](generated/immich/openapi_client/docs/AuthenticationApi.md#login) | **POST** /auth/login |
*AuthenticationApi* | [**logout**](generated/immich/openapi_client/docs/AuthenticationApi.md#logout) | **POST** /auth/logout |
*AuthenticationApi* | [**sign_up_admin**](generated/immich/openapi_client/docs/AuthenticationApi.md#sign_up_admin) | **POST** /auth/admin-sign-up |
*AuthenticationApi* | [**validate_access_token**](generated/immich/openapi_client/docs/AuthenticationApi.md#validate_access_token) | **POST** /auth/validateToken |
*DeprecatedApi* | [**get_random**](generated/immich/openapi_client/docs/DeprecatedApi.md#get_random) | **GET** /assets/random |
*DownloadApi* | [**download_archive**](generated/immich/openapi_client/docs/DownloadApi.md#download_archive) | **POST** /download/archive |
*DownloadApi* | [**get_download_info**](generated/immich/openapi_client/docs/DownloadApi.md#get_download_info) | **POST** /download/info |
*DuplicatesApi* | [**get_asset_duplicates**](generated/immich/openapi_client/docs/DuplicatesApi.md#get_asset_duplicates) | **GET** /duplicates |
*FacesApi* | [**create_face**](generated/immich/openapi_client/docs/FacesApi.md#create_face) | **POST** /faces |
*FacesApi* | [**delete_face**](generated/immich/openapi_client/docs/FacesApi.md#delete_face) | **DELETE** /faces/{id} |
*FacesApi* | [**get_faces**](generated/immich/openapi_client/docs/FacesApi.md#get_faces) | **GET** /faces |
*FacesApi* | [**reassign_faces_by_id**](generated/immich/openapi_client/docs/FacesApi.md#reassign_faces_by_id) | **PUT** /faces/{id} |
*FileReportsApi* | [**fix_audit_files**](generated/immich/openapi_client/docs/FileReportsApi.md#fix_audit_files) | **POST** /reports/fix |
*FileReportsApi* | [**get_audit_files**](generated/immich/openapi_client/docs/FileReportsApi.md#get_audit_files) | **GET** /reports |
*FileReportsApi* | [**get_file_checksums**](generated/immich/openapi_client/docs/FileReportsApi.md#get_file_checksums) | **POST** /reports/checksum |
*JobsApi* | [**create_job**](generated/immich/openapi_client/docs/JobsApi.md#create_job) | **POST** /jobs |
*JobsApi* | [**get_all_jobs_status**](generated/immich/openapi_client/docs/JobsApi.md#get_all_jobs_status) | **GET** /jobs |
*JobsApi* | [**send_job_command**](generated/immich/openapi_client/docs/JobsApi.md#send_job_command) | **PUT** /jobs/{id} |
*LibrariesApi* | [**create_library**](generated/immich/openapi_client/docs/LibrariesApi.md#create_library) | **POST** /libraries |
*LibrariesApi* | [**delete_library**](generated/immich/openapi_client/docs/LibrariesApi.md#delete_library) | **DELETE** /libraries/{id} |
*LibrariesApi* | [**get_all_libraries**](generated/immich/openapi_client/docs/LibrariesApi.md#get_all_libraries) | **GET** /libraries |
*LibrariesApi* | [**get_library**](generated/immich/openapi_client/docs/LibrariesApi.md#get_library) | **GET** /libraries/{id} |
*LibrariesApi* | [**get_library_statistics**](generated/immich/openapi_client/docs/LibrariesApi.md#get_library_statistics) | **GET** /libraries/{id}/statistics |
*LibrariesApi* | [**scan_library**](generated/immich/openapi_client/docs/LibrariesApi.md#scan_library) | **POST** /libraries/{id}/scan |
*LibrariesApi* | [**update_library**](generated/immich/openapi_client/docs/LibrariesApi.md#update_library) | **PUT** /libraries/{id} |
*LibrariesApi* | [**validate**](generated/immich/openapi_client/docs/LibrariesApi.md#validate) | **POST** /libraries/{id}/validate |
*MapApi* | [**get_map_markers**](generated/immich/openapi_client/docs/MapApi.md#get_map_markers) | **GET** /map/markers |
*MapApi* | [**reverse_geocode**](generated/immich/openapi_client/docs/MapApi.md#reverse_geocode) | **GET** /map/reverse-geocode |
*MemoriesApi* | [**add_memory_assets**](generated/immich/openapi_client/docs/MemoriesApi.md#add_memory_assets) | **PUT** /memories/{id}/assets |
*MemoriesApi* | [**create_memory**](generated/immich/openapi_client/docs/MemoriesApi.md#create_memory) | **POST** /memories |
*MemoriesApi* | [**delete_memory**](generated/immich/openapi_client/docs/MemoriesApi.md#delete_memory) | **DELETE** /memories/{id} |
*MemoriesApi* | [**get_memory**](generated/immich/openapi_client/docs/MemoriesApi.md#get_memory) | **GET** /memories/{id} |
*MemoriesApi* | [**remove_memory_assets**](generated/immich/openapi_client/docs/MemoriesApi.md#remove_memory_assets) | **DELETE** /memories/{id}/assets |
*MemoriesApi* | [**search_memories**](generated/immich/openapi_client/docs/MemoriesApi.md#search_memories) | **GET** /memories |
*MemoriesApi* | [**update_memory**](generated/immich/openapi_client/docs/MemoriesApi.md#update_memory) | **PUT** /memories/{id} |
*NotificationsApi* | [**get_notification_template**](generated/immich/openapi_client/docs/NotificationsApi.md#get_notification_template) | **POST** /notifications/templates/{name} |
*NotificationsApi* | [**send_test_email**](generated/immich/openapi_client/docs/NotificationsApi.md#send_test_email) | **POST** /notifications/test-email |
*OAuthApi* | [**finish_o_auth**](generated/immich/openapi_client/docs/OAuthApi.md#finish_o_auth) | **POST** /oauth/callback |
*OAuthApi* | [**link_o_auth_account**](generated/immich/openapi_client/docs/OAuthApi.md#link_o_auth_account) | **POST** /oauth/link |
*OAuthApi* | [**redirect_o_auth_to_mobile**](generated/immich/openapi_client/docs/OAuthApi.md#redirect_o_auth_to_mobile) | **GET** /oauth/mobile-redirect |
*OAuthApi* | [**start_o_auth**](generated/immich/openapi_client/docs/OAuthApi.md#start_o_auth) | **POST** /oauth/authorize |
*OAuthApi* | [**unlink_o_auth_account**](generated/immich/openapi_client/docs/OAuthApi.md#unlink_o_auth_account) | **POST** /oauth/unlink |
*PartnersApi* | [**create_partner**](generated/immich/openapi_client/docs/PartnersApi.md#create_partner) | **POST** /partners/{id} |
*PartnersApi* | [**get_partners**](generated/immich/openapi_client/docs/PartnersApi.md#get_partners) | **GET** /partners |
*PartnersApi* | [**remove_partner**](generated/immich/openapi_client/docs/PartnersApi.md#remove_partner) | **DELETE** /partners/{id} |
*PartnersApi* | [**update_partner**](generated/immich/openapi_client/docs/PartnersApi.md#update_partner) | **PUT** /partners/{id} |
*PeopleApi* | [**create_person**](generated/immich/openapi_client/docs/PeopleApi.md#create_person) | **POST** /people |
*PeopleApi* | [**get_all_people**](generated/immich/openapi_client/docs/PeopleApi.md#get_all_people) | **GET** /people |
*PeopleApi* | [**get_person**](generated/immich/openapi_client/docs/PeopleApi.md#get_person) | **GET** /people/{id} |
*PeopleApi* | [**get_person_statistics**](generated/immich/openapi_client/docs/PeopleApi.md#get_person_statistics) | **GET** /people/{id}/statistics |
*PeopleApi* | [**get_person_thumbnail**](generated/immich/openapi_client/docs/PeopleApi.md#get_person_thumbnail) | **GET** /people/{id}/thumbnail |
*PeopleApi* | [**merge_person**](generated/immich/openapi_client/docs/PeopleApi.md#merge_person) | **POST** /people/{id}/merge |
*PeopleApi* | [**reassign_faces**](generated/immich/openapi_client/docs/PeopleApi.md#reassign_faces) | **PUT** /people/{id}/reassign |
*PeopleApi* | [**update_people**](generated/immich/openapi_client/docs/PeopleApi.md#update_people) | **PUT** /people |
*PeopleApi* | [**update_person**](generated/immich/openapi_client/docs/PeopleApi.md#update_person) | **PUT** /people/{id} |
*SearchApi* | [**get_assets_by_city**](generated/immich/openapi_client/docs/SearchApi.md#get_assets_by_city) | **GET** /search/cities |
*SearchApi* | [**get_explore_data**](generated/immich/openapi_client/docs/SearchApi.md#get_explore_data) | **GET** /search/explore |
*SearchApi* | [**get_search_suggestions**](generated/immich/openapi_client/docs/SearchApi.md#get_search_suggestions) | **GET** /search/suggestions |
*SearchApi* | [**search_assets**](generated/immich/openapi_client/docs/SearchApi.md#search_assets) | **POST** /search/metadata |
*SearchApi* | [**search_person**](generated/immich/openapi_client/docs/SearchApi.md#search_person) | **GET** /search/person |
*SearchApi* | [**search_places**](generated/immich/openapi_client/docs/SearchApi.md#search_places) | **GET** /search/places |
*SearchApi* | [**search_random**](generated/immich/openapi_client/docs/SearchApi.md#search_random) | **POST** /search/random |
*SearchApi* | [**search_smart**](generated/immich/openapi_client/docs/SearchApi.md#search_smart) | **POST** /search/smart |
*ServerApi* | [**delete_server_license**](generated/immich/openapi_client/docs/ServerApi.md#delete_server_license) | **DELETE** /server/license |
*ServerApi* | [**get_about_info**](generated/immich/openapi_client/docs/ServerApi.md#get_about_info) | **GET** /server/about |
*ServerApi* | [**get_server_config**](generated/immich/openapi_client/docs/ServerApi.md#get_server_config) | **GET** /server/config |
*ServerApi* | [**get_server_features**](generated/immich/openapi_client/docs/ServerApi.md#get_server_features) | **GET** /server/features |
*ServerApi* | [**get_server_license**](generated/immich/openapi_client/docs/ServerApi.md#get_server_license) | **GET** /server/license |
*ServerApi* | [**get_server_statistics**](generated/immich/openapi_client/docs/ServerApi.md#get_server_statistics) | **GET** /server/statistics |
*ServerApi* | [**get_server_version**](generated/immich/openapi_client/docs/ServerApi.md#get_server_version) | **GET** /server/version |
*ServerApi* | [**get_storage**](generated/immich/openapi_client/docs/ServerApi.md#get_storage) | **GET** /server/storage |
*ServerApi* | [**get_supported_media_types**](generated/immich/openapi_client/docs/ServerApi.md#get_supported_media_types) | **GET** /server/media-types |
*ServerApi* | [**get_theme**](generated/immich/openapi_client/docs/ServerApi.md#get_theme) | **GET** /server/theme |
*ServerApi* | [**get_version_history**](generated/immich/openapi_client/docs/ServerApi.md#get_version_history) | **GET** /server/version-history |
*ServerApi* | [**ping_server**](generated/immich/openapi_client/docs/ServerApi.md#ping_server) | **GET** /server/ping |
*ServerApi* | [**set_server_license**](generated/immich/openapi_client/docs/ServerApi.md#set_server_license) | **PUT** /server/license |
*SessionsApi* | [**delete_all_sessions**](generated/immich/openapi_client/docs/SessionsApi.md#delete_all_sessions) | **DELETE** /sessions |
*SessionsApi* | [**delete_session**](generated/immich/openapi_client/docs/SessionsApi.md#delete_session) | **DELETE** /sessions/{id} |
*SessionsApi* | [**get_sessions**](generated/immich/openapi_client/docs/SessionsApi.md#get_sessions) | **GET** /sessions |
*SharedLinksApi* | [**add_shared_link_assets**](generated/immich/openapi_client/docs/SharedLinksApi.md#add_shared_link_assets) | **PUT** /shared-links/{id}/assets |
*SharedLinksApi* | [**create_shared_link**](generated/immich/openapi_client/docs/SharedLinksApi.md#create_shared_link) | **POST** /shared-links |
*SharedLinksApi* | [**get_all_shared_links**](generated/immich/openapi_client/docs/SharedLinksApi.md#get_all_shared_links) | **GET** /shared-links |
*SharedLinksApi* | [**get_my_shared_link**](generated/immich/openapi_client/docs/SharedLinksApi.md#get_my_shared_link) | **GET** /shared-links/me |
*SharedLinksApi* | [**get_shared_link_by_id**](generated/immich/openapi_client/docs/SharedLinksApi.md#get_shared_link_by_id) | **GET** /shared-links/{id} |
*SharedLinksApi* | [**remove_shared_link**](generated/immich/openapi_client/docs/SharedLinksApi.md#remove_shared_link) | **DELETE** /shared-links/{id} |
*SharedLinksApi* | [**remove_shared_link_assets**](generated/immich/openapi_client/docs/SharedLinksApi.md#remove_shared_link_assets) | **DELETE** /shared-links/{id}/assets |
*SharedLinksApi* | [**update_shared_link**](generated/immich/openapi_client/docs/SharedLinksApi.md#update_shared_link) | **PATCH** /shared-links/{id} |
*StacksApi* | [**create_stack**](generated/immich/openapi_client/docs/StacksApi.md#create_stack) | **POST** /stacks |
*StacksApi* | [**delete_stack**](generated/immich/openapi_client/docs/StacksApi.md#delete_stack) | **DELETE** /stacks/{id} |
*StacksApi* | [**delete_stacks**](generated/immich/openapi_client/docs/StacksApi.md#delete_stacks) | **DELETE** /stacks |
*StacksApi* | [**get_stack**](generated/immich/openapi_client/docs/StacksApi.md#get_stack) | **GET** /stacks/{id} |
*StacksApi* | [**search_stacks**](generated/immich/openapi_client/docs/StacksApi.md#search_stacks) | **GET** /stacks |
*StacksApi* | [**update_stack**](generated/immich/openapi_client/docs/StacksApi.md#update_stack) | **PUT** /stacks/{id} |
*SyncApi* | [**delete_sync_ack**](generated/immich/openapi_client/docs/SyncApi.md#delete_sync_ack) | **DELETE** /sync/ack |
*SyncApi* | [**get_delta_sync**](generated/immich/openapi_client/docs/SyncApi.md#get_delta_sync) | **POST** /sync/delta-sync |
*SyncApi* | [**get_full_sync_for_user**](generated/immich/openapi_client/docs/SyncApi.md#get_full_sync_for_user) | **POST** /sync/full-sync |
*SyncApi* | [**get_sync_ack**](generated/immich/openapi_client/docs/SyncApi.md#get_sync_ack) | **GET** /sync/ack |
*SyncApi* | [**get_sync_stream**](generated/immich/openapi_client/docs/SyncApi.md#get_sync_stream) | **POST** /sync/stream |
*SyncApi* | [**send_sync_ack**](generated/immich/openapi_client/docs/SyncApi.md#send_sync_ack) | **POST** /sync/ack |
*SystemConfigApi* | [**get_config**](generated/immich/openapi_client/docs/SystemConfigApi.md#get_config) | **GET** /system-config |
*SystemConfigApi* | [**get_config_defaults**](generated/immich/openapi_client/docs/SystemConfigApi.md#get_config_defaults) | **GET** /system-config/defaults |
*SystemConfigApi* | [**get_storage_template_options**](generated/immich/openapi_client/docs/SystemConfigApi.md#get_storage_template_options) | **GET** /system-config/storage-template-options |
*SystemConfigApi* | [**update_config**](generated/immich/openapi_client/docs/SystemConfigApi.md#update_config) | **PUT** /system-config |
*SystemMetadataApi* | [**get_admin_onboarding**](generated/immich/openapi_client/docs/SystemMetadataApi.md#get_admin_onboarding) | **GET** /system-metadata/admin-onboarding |
*SystemMetadataApi* | [**get_reverse_geocoding_state**](generated/immich/openapi_client/docs/SystemMetadataApi.md#get_reverse_geocoding_state) | **GET** /system-metadata/reverse-geocoding-state |
*SystemMetadataApi* | [**update_admin_onboarding**](generated/immich/openapi_client/docs/SystemMetadataApi.md#update_admin_onboarding) | **POST** /system-metadata/admin-onboarding |
*TagsApi* | [**bulk_tag_assets**](generated/immich/openapi_client/docs/TagsApi.md#bulk_tag_assets) | **PUT** /tags/assets |
*TagsApi* | [**create_tag**](generated/immich/openapi_client/docs/TagsApi.md#create_tag) | **POST** /tags |
*TagsApi* | [**delete_tag**](generated/immich/openapi_client/docs/TagsApi.md#delete_tag) | **DELETE** /tags/{id} |
*TagsApi* | [**get_all_tags**](generated/immich/openapi_client/docs/TagsApi.md#get_all_tags) | **GET** /tags |
*TagsApi* | [**get_tag_by_id**](generated/immich/openapi_client/docs/TagsApi.md#get_tag_by_id) | **GET** /tags/{id} |
*TagsApi* | [**tag_assets**](generated/immich/openapi_client/docs/TagsApi.md#tag_assets) | **PUT** /tags/{id}/assets |
*TagsApi* | [**untag_assets**](generated/immich/openapi_client/docs/TagsApi.md#untag_assets) | **DELETE** /tags/{id}/assets |
*TagsApi* | [**update_tag**](generated/immich/openapi_client/docs/TagsApi.md#update_tag) | **PUT** /tags/{id} |
*TagsApi* | [**upsert_tags**](generated/immich/openapi_client/docs/TagsApi.md#upsert_tags) | **PUT** /tags |
*TimelineApi* | [**get_time_bucket**](generated/immich/openapi_client/docs/TimelineApi.md#get_time_bucket) | **GET** /timeline/bucket |
*TimelineApi* | [**get_time_buckets**](generated/immich/openapi_client/docs/TimelineApi.md#get_time_buckets) | **GET** /timeline/buckets |
*TrashApi* | [**empty_trash**](generated/immich/openapi_client/docs/TrashApi.md#empty_trash) | **POST** /trash/empty |
*TrashApi* | [**restore_assets**](generated/immich/openapi_client/docs/TrashApi.md#restore_assets) | **POST** /trash/restore/assets |
*TrashApi* | [**restore_trash**](generated/immich/openapi_client/docs/TrashApi.md#restore_trash) | **POST** /trash/restore |
*UsersApi* | [**create_profile_image**](generated/immich/openapi_client/docs/UsersApi.md#create_profile_image) | **POST** /users/profile-image |
*UsersApi* | [**delete_profile_image**](generated/immich/openapi_client/docs/UsersApi.md#delete_profile_image) | **DELETE** /users/profile-image |
*UsersApi* | [**delete_user_license**](generated/immich/openapi_client/docs/UsersApi.md#delete_user_license) | **DELETE** /users/me/license |
*UsersApi* | [**get_my_preferences**](generated/immich/openapi_client/docs/UsersApi.md#get_my_preferences) | **GET** /users/me/preferences |
*UsersApi* | [**get_my_user**](generated/immich/openapi_client/docs/UsersApi.md#get_my_user) | **GET** /users/me |
*UsersApi* | [**get_profile_image**](generated/immich/openapi_client/docs/UsersApi.md#get_profile_image) | **GET** /users/{id}/profile-image |
*UsersApi* | [**get_user**](generated/immich/openapi_client/docs/UsersApi.md#get_user) | **GET** /users/{id} |
*UsersApi* | [**get_user_license**](generated/immich/openapi_client/docs/UsersApi.md#get_user_license) | **GET** /users/me/license |
*UsersApi* | [**search_users**](generated/immich/openapi_client/docs/UsersApi.md#search_users) | **GET** /users |
*UsersApi* | [**set_user_license**](generated/immich/openapi_client/docs/UsersApi.md#set_user_license) | **PUT** /users/me/license |
*UsersApi* | [**update_my_preferences**](generated/immich/openapi_client/docs/UsersApi.md#update_my_preferences) | **PUT** /users/me/preferences |
*UsersApi* | [**update_my_user**](generated/immich/openapi_client/docs/UsersApi.md#update_my_user) | **PUT** /users/me |
*UsersAdminApi* | [**create_user_admin**](generated/immich/openapi_client/docs/UsersAdminApi.md#create_user_admin) | **POST** /admin/users |
*UsersAdminApi* | [**delete_user_admin**](generated/immich/openapi_client/docs/UsersAdminApi.md#delete_user_admin) | **DELETE** /admin/users/{id} |
*UsersAdminApi* | [**get_user_admin**](generated/immich/openapi_client/docs/UsersAdminApi.md#get_user_admin) | **GET** /admin/users/{id} |
*UsersAdminApi* | [**get_user_preferences_admin**](generated/immich/openapi_client/docs/UsersAdminApi.md#get_user_preferences_admin) | **GET** /admin/users/{id}/preferences |
*UsersAdminApi* | [**restore_user_admin**](generated/immich/openapi_client/docs/UsersAdminApi.md#restore_user_admin) | **POST** /admin/users/{id}/restore |
*UsersAdminApi* | [**search_users_admin**](generated/immich/openapi_client/docs/UsersAdminApi.md#search_users_admin) | **GET** /admin/users |
*UsersAdminApi* | [**update_user_admin**](generated/immich/openapi_client/docs/UsersAdminApi.md#update_user_admin) | **PUT** /admin/users/{id} |
*UsersAdminApi* | [**update_user_preferences_admin**](generated/immich/openapi_client/docs/UsersAdminApi.md#update_user_preferences_admin) | **PUT** /admin/users/{id}/preferences |
*ViewApi* | [**get_assets_by_original_path**](generated/immich/openapi_client/docs/ViewApi.md#get_assets_by_original_path) | **GET** /view/folder |
*ViewApi* | [**get_unique_original_paths**](generated/immich/openapi_client/docs/ViewApi.md#get_unique_original_paths) | **GET** /view/folder/unique-paths |
## Documentation For Models
- [APIKeyCreateDto](generated/immich/openapi_client/docs/APIKeyCreateDto.md)
- [APIKeyCreateResponseDto](generated/immich/openapi_client/docs/APIKeyCreateResponseDto.md)
- [APIKeyResponseDto](generated/immich/openapi_client/docs/APIKeyResponseDto.md)
- [APIKeyUpdateDto](generated/immich/openapi_client/docs/APIKeyUpdateDto.md)
- [ActivityCreateDto](generated/immich/openapi_client/docs/ActivityCreateDto.md)
- [ActivityResponseDto](generated/immich/openapi_client/docs/ActivityResponseDto.md)
- [ActivityStatisticsResponseDto](generated/immich/openapi_client/docs/ActivityStatisticsResponseDto.md)
- [AddUsersDto](generated/immich/openapi_client/docs/AddUsersDto.md)
- [AdminOnboardingUpdateDto](generated/immich/openapi_client/docs/AdminOnboardingUpdateDto.md)
- [AlbumResponseDto](generated/immich/openapi_client/docs/AlbumResponseDto.md)
- [AlbumStatisticsResponseDto](generated/immich/openapi_client/docs/AlbumStatisticsResponseDto.md)
- [AlbumUserAddDto](generated/immich/openapi_client/docs/AlbumUserAddDto.md)
- [AlbumUserCreateDto](generated/immich/openapi_client/docs/AlbumUserCreateDto.md)
- [AlbumUserResponseDto](generated/immich/openapi_client/docs/AlbumUserResponseDto.md)
- [AlbumUserRole](generated/immich/openapi_client/docs/AlbumUserRole.md)
- [AllJobStatusResponseDto](generated/immich/openapi_client/docs/AllJobStatusResponseDto.md)
- [AssetBulkDeleteDto](generated/immich/openapi_client/docs/AssetBulkDeleteDto.md)
- [AssetBulkUpdateDto](generated/immich/openapi_client/docs/AssetBulkUpdateDto.md)
- [AssetBulkUploadCheckDto](generated/immich/openapi_client/docs/AssetBulkUploadCheckDto.md)
- [AssetBulkUploadCheckItem](generated/immich/openapi_client/docs/AssetBulkUploadCheckItem.md)
- [AssetBulkUploadCheckResponseDto](generated/immich/openapi_client/docs/AssetBulkUploadCheckResponseDto.md)
- [AssetBulkUploadCheckResult](generated/immich/openapi_client/docs/AssetBulkUploadCheckResult.md)
- [AssetDeltaSyncDto](generated/immich/openapi_client/docs/AssetDeltaSyncDto.md)
- [AssetDeltaSyncResponseDto](generated/immich/openapi_client/docs/AssetDeltaSyncResponseDto.md)
- [AssetFaceCreateDto](generated/immich/openapi_client/docs/AssetFaceCreateDto.md)
- [AssetFaceDeleteDto](generated/immich/openapi_client/docs/AssetFaceDeleteDto.md)
- [AssetFaceResponseDto](generated/immich/openapi_client/docs/AssetFaceResponseDto.md)
- [AssetFaceUpdateDto](generated/immich/openapi_client/docs/AssetFaceUpdateDto.md)
- [AssetFaceUpdateItem](generated/immich/openapi_client/docs/AssetFaceUpdateItem.md)
- [AssetFaceWithoutPersonResponseDto](generated/immich/openapi_client/docs/AssetFaceWithoutPersonResponseDto.md)
- [AssetFullSyncDto](generated/immich/openapi_client/docs/AssetFullSyncDto.md)
- [AssetIdsDto](generated/immich/openapi_client/docs/AssetIdsDto.md)
- [AssetIdsResponseDto](generated/immich/openapi_client/docs/AssetIdsResponseDto.md)
- [AssetJobName](generated/immich/openapi_client/docs/AssetJobName.md)
- [AssetJobsDto](generated/immich/openapi_client/docs/AssetJobsDto.md)
- [AssetMediaResponseDto](generated/immich/openapi_client/docs/AssetMediaResponseDto.md)
- [AssetMediaSize](generated/immich/openapi_client/docs/AssetMediaSize.md)
- [AssetMediaStatus](generated/immich/openapi_client/docs/AssetMediaStatus.md)
- [AssetOrder](generated/immich/openapi_client/docs/AssetOrder.md)
- [AssetResponseDto](generated/immich/openapi_client/docs/AssetResponseDto.md)
- [AssetStackResponseDto](generated/immich/openapi_client/docs/AssetStackResponseDto.md)
- [AssetStatsResponseDto](generated/immich/openapi_client/docs/AssetStatsResponseDto.md)
- [AssetTypeEnum](generated/immich/openapi_client/docs/AssetTypeEnum.md)
- [AudioCodec](generated/immich/openapi_client/docs/AudioCodec.md)
- [AvatarResponse](generated/immich/openapi_client/docs/AvatarResponse.md)
- [AvatarUpdate](generated/immich/openapi_client/docs/AvatarUpdate.md)
- [BulkIdResponseDto](generated/immich/openapi_client/docs/BulkIdResponseDto.md)
- [BulkIdsDto](generated/immich/openapi_client/docs/BulkIdsDto.md)
- [CLIPConfig](generated/immich/openapi_client/docs/CLIPConfig.md)
- [CQMode](generated/immich/openapi_client/docs/CQMode.md)
- [ChangePasswordDto](generated/immich/openapi_client/docs/ChangePasswordDto.md)
- [CheckExistingAssetsDto](generated/immich/openapi_client/docs/CheckExistingAssetsDto.md)
- [CheckExistingAssetsResponseDto](generated/immich/openapi_client/docs/CheckExistingAssetsResponseDto.md)
- [Colorspace](generated/immich/openapi_client/docs/Colorspace.md)
- [CreateAlbumDto](generated/immich/openapi_client/docs/CreateAlbumDto.md)
- [CreateLibraryDto](generated/immich/openapi_client/docs/CreateLibraryDto.md)
- [CreateProfileImageResponseDto](generated/immich/openapi_client/docs/CreateProfileImageResponseDto.md)
- [DatabaseBackupConfig](generated/immich/openapi_client/docs/DatabaseBackupConfig.md)
- [DownloadArchiveInfo](generated/immich/openapi_client/docs/DownloadArchiveInfo.md)
- [DownloadInfoDto](generated/immich/openapi_client/docs/DownloadInfoDto.md)
- [DownloadResponse](generated/immich/openapi_client/docs/DownloadResponse.md)
- [DownloadResponseDto](generated/immich/openapi_client/docs/DownloadResponseDto.md)
- [DownloadUpdate](generated/immich/openapi_client/docs/DownloadUpdate.md)
- [DuplicateDetectionConfig](generated/immich/openapi_client/docs/DuplicateDetectionConfig.md)
- [DuplicateResponseDto](generated/immich/openapi_client/docs/DuplicateResponseDto.md)
- [EmailNotificationsResponse](generated/immich/openapi_client/docs/EmailNotificationsResponse.md)
- [EmailNotificationsUpdate](generated/immich/openapi_client/docs/EmailNotificationsUpdate.md)
- [ExifResponseDto](generated/immich/openapi_client/docs/ExifResponseDto.md)
- [FaceDto](generated/immich/openapi_client/docs/FaceDto.md)
- [FacialRecognitionConfig](generated/immich/openapi_client/docs/FacialRecognitionConfig.md)
- [FileChecksumDto](generated/immich/openapi_client/docs/FileChecksumDto.md)
- [FileChecksumResponseDto](generated/immich/openapi_client/docs/FileChecksumResponseDto.md)
- [FileReportDto](generated/immich/openapi_client/docs/FileReportDto.md)
- [FileReportFixDto](generated/immich/openapi_client/docs/FileReportFixDto.md)
- [FileReportItemDto](generated/immich/openapi_client/docs/FileReportItemDto.md)
- [FoldersResponse](generated/immich/openapi_client/docs/FoldersResponse.md)
- [FoldersUpdate](generated/immich/openapi_client/docs/FoldersUpdate.md)
- [ImageFormat](generated/immich/openapi_client/docs/ImageFormat.md)
- [JobCommand](generated/immich/openapi_client/docs/JobCommand.md)
- [JobCommandDto](generated/immich/openapi_client/docs/JobCommandDto.md)
- [JobCountsDto](generated/immich/openapi_client/docs/JobCountsDto.md)
- [JobCreateDto](generated/immich/openapi_client/docs/JobCreateDto.md)
- [JobName](generated/immich/openapi_client/docs/JobName.md)
- [JobSettingsDto](generated/immich/openapi_client/docs/JobSettingsDto.md)
- [JobStatusDto](generated/immich/openapi_client/docs/JobStatusDto.md)
- [LibraryResponseDto](generated/immich/openapi_client/docs/LibraryResponseDto.md)
- [LibraryStatsResponseDto](generated/immich/openapi_client/docs/LibraryStatsResponseDto.md)
- [LicenseKeyDto](generated/immich/openapi_client/docs/LicenseKeyDto.md)
- [LicenseResponseDto](generated/immich/openapi_client/docs/LicenseResponseDto.md)
- [LogLevel](generated/immich/openapi_client/docs/LogLevel.md)
- [LoginCredentialDto](generated/immich/openapi_client/docs/LoginCredentialDto.md)
- [LoginResponseDto](generated/immich/openapi_client/docs/LoginResponseDto.md)
- [LogoutResponseDto](generated/immich/openapi_client/docs/LogoutResponseDto.md)
- [ManualJobName](generated/immich/openapi_client/docs/ManualJobName.md)
- [MapMarkerResponseDto](generated/immich/openapi_client/docs/MapMarkerResponseDto.md)
- [MapReverseGeocodeResponseDto](generated/immich/openapi_client/docs/MapReverseGeocodeResponseDto.md)
- [MemoriesResponse](generated/immich/openapi_client/docs/MemoriesResponse.md)
- [MemoriesUpdate](generated/immich/openapi_client/docs/MemoriesUpdate.md)
- [MemoryCreateDto](generated/immich/openapi_client/docs/MemoryCreateDto.md)
- [MemoryLaneResponseDto](generated/immich/openapi_client/docs/MemoryLaneResponseDto.md)
- [MemoryResponseDto](generated/immich/openapi_client/docs/MemoryResponseDto.md)
- [MemoryType](generated/immich/openapi_client/docs/MemoryType.md)
- [MemoryUpdateDto](generated/immich/openapi_client/docs/MemoryUpdateDto.md)
- [MergePersonDto](generated/immich/openapi_client/docs/MergePersonDto.md)
- [MetadataSearchDto](generated/immich/openapi_client/docs/MetadataSearchDto.md)
- [OAuthAuthorizeResponseDto](generated/immich/openapi_client/docs/OAuthAuthorizeResponseDto.md)
- [OAuthCallbackDto](generated/immich/openapi_client/docs/OAuthCallbackDto.md)
- [OAuthConfigDto](generated/immich/openapi_client/docs/OAuthConfigDto.md)
- [OnThisDayDto](generated/immich/openapi_client/docs/OnThisDayDto.md)
- [PartnerDirection](generated/immich/openapi_client/docs/PartnerDirection.md)
- [PartnerResponseDto](generated/immich/openapi_client/docs/PartnerResponseDto.md)
- [PathEntityType](generated/immich/openapi_client/docs/PathEntityType.md)
- [PathType](generated/immich/openapi_client/docs/PathType.md)
- [PeopleResponse](generated/immich/openapi_client/docs/PeopleResponse.md)
- [PeopleResponseDto](generated/immich/openapi_client/docs/PeopleResponseDto.md)
- [PeopleUpdate](generated/immich/openapi_client/docs/PeopleUpdate.md)
- [PeopleUpdateDto](generated/immich/openapi_client/docs/PeopleUpdateDto.md)
- [PeopleUpdateItem](generated/immich/openapi_client/docs/PeopleUpdateItem.md)
- [Permission](generated/immich/openapi_client/docs/Permission.md)
- [PersonCreateDto](generated/immich/openapi_client/docs/PersonCreateDto.md)
- [PersonResponseDto](generated/immich/openapi_client/docs/PersonResponseDto.md)
- [PersonStatisticsResponseDto](generated/immich/openapi_client/docs/PersonStatisticsResponseDto.md)
- [PersonUpdateDto](generated/immich/openapi_client/docs/PersonUpdateDto.md)
- [PersonWithFacesResponseDto](generated/immich/openapi_client/docs/PersonWithFacesResponseDto.md)
- [PlacesResponseDto](generated/immich/openapi_client/docs/PlacesResponseDto.md)
- [PurchaseResponse](generated/immich/openapi_client/docs/PurchaseResponse.md)
- [PurchaseUpdate](generated/immich/openapi_client/docs/PurchaseUpdate.md)
- [QueueStatusDto](generated/immich/openapi_client/docs/QueueStatusDto.md)
- [RandomSearchDto](generated/immich/openapi_client/docs/RandomSearchDto.md)
- [RatingsResponse](generated/immich/openapi_client/docs/RatingsResponse.md)
- [RatingsUpdate](generated/immich/openapi_client/docs/RatingsUpdate.md)
- [ReactionLevel](generated/immich/openapi_client/docs/ReactionLevel.md)
- [ReactionType](generated/immich/openapi_client/docs/ReactionType.md)
- [ReverseGeocodingStateResponseDto](generated/immich/openapi_client/docs/ReverseGeocodingStateResponseDto.md)
- [SearchAlbumResponseDto](generated/immich/openapi_client/docs/SearchAlbumResponseDto.md)
- [SearchAssetResponseDto](generated/immich/openapi_client/docs/SearchAssetResponseDto.md)
- [SearchExploreItem](generated/immich/openapi_client/docs/SearchExploreItem.md)
- [SearchExploreResponseDto](generated/immich/openapi_client/docs/SearchExploreResponseDto.md)
- [SearchFacetCountResponseDto](generated/immich/openapi_client/docs/SearchFacetCountResponseDto.md)
- [SearchFacetResponseDto](generated/immich/openapi_client/docs/SearchFacetResponseDto.md)
- [SearchResponseDto](generated/immich/openapi_client/docs/SearchResponseDto.md)
- [SearchSuggestionType](generated/immich/openapi_client/docs/SearchSuggestionType.md)
- [ServerAboutResponseDto](generated/immich/openapi_client/docs/ServerAboutResponseDto.md)
- [ServerConfigDto](generated/immich/openapi_client/docs/ServerConfigDto.md)
- [ServerFeaturesDto](generated/immich/openapi_client/docs/ServerFeaturesDto.md)
- [ServerMediaTypesResponseDto](generated/immich/openapi_client/docs/ServerMediaTypesResponseDto.md)
- [ServerPingResponse](generated/immich/openapi_client/docs/ServerPingResponse.md)
- [ServerStatsResponseDto](generated/immich/openapi_client/docs/ServerStatsResponseDto.md)
- [ServerStorageResponseDto](generated/immich/openapi_client/docs/ServerStorageResponseDto.md)
- [ServerThemeDto](generated/immich/openapi_client/docs/ServerThemeDto.md)
- [ServerVersionHistoryResponseDto](generated/immich/openapi_client/docs/ServerVersionHistoryResponseDto.md)
- [ServerVersionResponseDto](generated/immich/openapi_client/docs/ServerVersionResponseDto.md)
- [SessionResponseDto](generated/immich/openapi_client/docs/SessionResponseDto.md)
- [SharedLinkCreateDto](generated/immich/openapi_client/docs/SharedLinkCreateDto.md)
- [SharedLinkEditDto](generated/immich/openapi_client/docs/SharedLinkEditDto.md)
- [SharedLinkResponseDto](generated/immich/openapi_client/docs/SharedLinkResponseDto.md)
- [SharedLinkType](generated/immich/openapi_client/docs/SharedLinkType.md)
- [SharedLinksResponse](generated/immich/openapi_client/docs/SharedLinksResponse.md)
- [SharedLinksUpdate](generated/immich/openapi_client/docs/SharedLinksUpdate.md)
- [SignUpDto](generated/immich/openapi_client/docs/SignUpDto.md)
- [SmartSearchDto](generated/immich/openapi_client/docs/SmartSearchDto.md)
- [SourceType](generated/immich/openapi_client/docs/SourceType.md)
- [StackCreateDto](generated/immich/openapi_client/docs/StackCreateDto.md)
- [StackResponseDto](generated/immich/openapi_client/docs/StackResponseDto.md)
- [StackUpdateDto](generated/immich/openapi_client/docs/StackUpdateDto.md)
- [SyncAckDeleteDto](generated/immich/openapi_client/docs/SyncAckDeleteDto.md)
- [SyncAckDto](generated/immich/openapi_client/docs/SyncAckDto.md)
- [SyncAckSetDto](generated/immich/openapi_client/docs/SyncAckSetDto.md)
- [SyncAssetDeleteV1](generated/immich/openapi_client/docs/SyncAssetDeleteV1.md)
- [SyncAssetExifV1](generated/immich/openapi_client/docs/SyncAssetExifV1.md)
- [SyncAssetV1](generated/immich/openapi_client/docs/SyncAssetV1.md)
- [SyncEntityType](generated/immich/openapi_client/docs/SyncEntityType.md)
- [SyncPartnerDeleteV1](generated/immich/openapi_client/docs/SyncPartnerDeleteV1.md)
- [SyncPartnerV1](generated/immich/openapi_client/docs/SyncPartnerV1.md)
- [SyncRequestType](generated/immich/openapi_client/docs/SyncRequestType.md)
- [SyncStreamDto](generated/immich/openapi_client/docs/SyncStreamDto.md)
- [SyncUserDeleteV1](generated/immich/openapi_client/docs/SyncUserDeleteV1.md)
- [SyncUserV1](generated/immich/openapi_client/docs/SyncUserV1.md)
- [SystemConfigBackupsDto](generated/immich/openapi_client/docs/SystemConfigBackupsDto.md)
- [SystemConfigDto](generated/immich/openapi_client/docs/SystemConfigDto.md)
- [SystemConfigFFmpegDto](generated/immich/openapi_client/docs/SystemConfigFFmpegDto.md)
- [SystemConfigFacesDto](generated/immich/openapi_client/docs/SystemConfigFacesDto.md)
- [SystemConfigGeneratedFullsizeImageDto](generated/immich/openapi_client/docs/SystemConfigGeneratedFullsizeImageDto.md)
- [SystemConfigGeneratedImageDto](generated/immich/openapi_client/docs/SystemConfigGeneratedImageDto.md)
- [SystemConfigImageDto](generated/immich/openapi_client/docs/SystemConfigImageDto.md)
- [SystemConfigJobDto](generated/immich/openapi_client/docs/SystemConfigJobDto.md)
- [SystemConfigLibraryDto](generated/immich/openapi_client/docs/SystemConfigLibraryDto.md)
- [SystemConfigLibraryScanDto](generated/immich/openapi_client/docs/SystemConfigLibraryScanDto.md)
- [SystemConfigLibraryWatchDto](generated/immich/openapi_client/docs/SystemConfigLibraryWatchDto.md)
- [SystemConfigLoggingDto](generated/immich/openapi_client/docs/SystemConfigLoggingDto.md)
- [SystemConfigMachineLearningDto](generated/immich/openapi_client/docs/SystemConfigMachineLearningDto.md)
- [SystemConfigMapDto](generated/immich/openapi_client/docs/SystemConfigMapDto.md)
- [SystemConfigMetadataDto](generated/immich/openapi_client/docs/SystemConfigMetadataDto.md)
- [SystemConfigNewVersionCheckDto](generated/immich/openapi_client/docs/SystemConfigNewVersionCheckDto.md)
- [SystemConfigNotificationsDto](generated/immich/openapi_client/docs/SystemConfigNotificationsDto.md)
- [SystemConfigOAuthDto](generated/immich/openapi_client/docs/SystemConfigOAuthDto.md)
- [SystemConfigPasswordLoginDto](generated/immich/openapi_client/docs/SystemConfigPasswordLoginDto.md)
- [SystemConfigReverseGeocodingDto](generated/immich/openapi_client/docs/SystemConfigReverseGeocodingDto.md)
- [SystemConfigServerDto](generated/immich/openapi_client/docs/SystemConfigServerDto.md)
- [SystemConfigSmtpDto](generated/immich/openapi_client/docs/SystemConfigSmtpDto.md)
- [SystemConfigSmtpTransportDto](generated/immich/openapi_client/docs/SystemConfigSmtpTransportDto.md)
- [SystemConfigStorageTemplateDto](generated/immich/openapi_client/docs/SystemConfigStorageTemplateDto.md)
- [SystemConfigTemplateEmailsDto](generated/immich/openapi_client/docs/SystemConfigTemplateEmailsDto.md)
- [SystemConfigTemplateStorageOptionDto](generated/immich/openapi_client/docs/SystemConfigTemplateStorageOptionDto.md)
- [SystemConfigTemplatesDto](generated/immich/openapi_client/docs/SystemConfigTemplatesDto.md)
- [SystemConfigThemeDto](generated/immich/openapi_client/docs/SystemConfigThemeDto.md)
- [SystemConfigTrashDto](generated/immich/openapi_client/docs/SystemConfigTrashDto.md)
- [SystemConfigUserDto](generated/immich/openapi_client/docs/SystemConfigUserDto.md)
- [TagBulkAssetsDto](generated/immich/openapi_client/docs/TagBulkAssetsDto.md)
- [TagBulkAssetsResponseDto](generated/immich/openapi_client/docs/TagBulkAssetsResponseDto.md)
- [TagCreateDto](generated/immich/openapi_client/docs/TagCreateDto.md)
- [TagResponseDto](generated/immich/openapi_client/docs/TagResponseDto.md)
- [TagUpdateDto](generated/immich/openapi_client/docs/TagUpdateDto.md)
- [TagUpsertDto](generated/immich/openapi_client/docs/TagUpsertDto.md)
- [TagsResponse](generated/immich/openapi_client/docs/TagsResponse.md)
- [TagsUpdate](generated/immich/openapi_client/docs/TagsUpdate.md)
- [TemplateDto](generated/immich/openapi_client/docs/TemplateDto.md)
- [TemplateResponseDto](generated/immich/openapi_client/docs/TemplateResponseDto.md)
- [TestEmailResponseDto](generated/immich/openapi_client/docs/TestEmailResponseDto.md)
- [TimeBucketResponseDto](generated/immich/openapi_client/docs/TimeBucketResponseDto.md)
- [TimeBucketSize](generated/immich/openapi_client/docs/TimeBucketSize.md)
- [ToneMapping](generated/immich/openapi_client/docs/ToneMapping.md)
- [TranscodeHWAccel](generated/immich/openapi_client/docs/TranscodeHWAccel.md)
- [TranscodePolicy](generated/immich/openapi_client/docs/TranscodePolicy.md)
- [TrashResponseDto](generated/immich/openapi_client/docs/TrashResponseDto.md)
- [UpdateAlbumDto](generated/immich/openapi_client/docs/UpdateAlbumDto.md)
- [UpdateAlbumUserDto](generated/immich/openapi_client/docs/UpdateAlbumUserDto.md)
- [UpdateAssetDto](generated/immich/openapi_client/docs/UpdateAssetDto.md)
- [UpdateLibraryDto](generated/immich/openapi_client/docs/UpdateLibraryDto.md)
- [UpdatePartnerDto](generated/immich/openapi_client/docs/UpdatePartnerDto.md)
- [UsageByUserDto](generated/immich/openapi_client/docs/UsageByUserDto.md)
- [UserAdminCreateDto](generated/immich/openapi_client/docs/UserAdminCreateDto.md)
- [UserAdminDeleteDto](generated/immich/openapi_client/docs/UserAdminDeleteDto.md)
- [UserAdminResponseDto](generated/immich/openapi_client/docs/UserAdminResponseDto.md)
- [UserAdminUpdateDto](generated/immich/openapi_client/docs/UserAdminUpdateDto.md)
- [UserAvatarColor](generated/immich/openapi_client/docs/UserAvatarColor.md)
- [UserLicense](generated/immich/openapi_client/docs/UserLicense.md)
- [UserPreferencesResponseDto](generated/immich/openapi_client/docs/UserPreferencesResponseDto.md)
- [UserPreferencesUpdateDto](generated/immich/openapi_client/docs/UserPreferencesUpdateDto.md)
- [UserResponseDto](generated/immich/openapi_client/docs/UserResponseDto.md)
- [UserStatus](generated/immich/openapi_client/docs/UserStatus.md)
- [UserUpdateMeDto](generated/immich/openapi_client/docs/UserUpdateMeDto.md)
- [ValidateAccessTokenResponseDto](generated/immich/openapi_client/docs/ValidateAccessTokenResponseDto.md)
- [ValidateLibraryDto](generated/immich/openapi_client/docs/ValidateLibraryDto.md)
- [ValidateLibraryImportPathResponseDto](generated/immich/openapi_client/docs/ValidateLibraryImportPathResponseDto.md)
- [ValidateLibraryResponseDto](generated/immich/openapi_client/docs/ValidateLibraryResponseDto.md)
- [VideoCodec](generated/immich/openapi_client/docs/VideoCodec.md)
- [VideoContainer](generated/immich/openapi_client/docs/VideoContainer.md)
## Documentation For Authorization
Authentication schemes defined for the API:
### bearer
- **Type**: Bearer authentication (JWT)
### cookie
- **Type**: API key
- **API key parameter name**: immich_access_token
- **Location**:
### api_key
- **Type**: API key
- **API key parameter name**: x-api-key
- **Location**: HTTP header
## Author