# 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: 3.0.1 - Package version: 1.0.0 - Generator version: 7.9.0 - Build package: org.openapitools.codegen.languages.PythonClientCodegen ## Requirements. Python 3.7+ ## 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.AlbumsApi(api_client) id = 'id_example' # str | bulk_ids_dto = generated.immich.openapi_client.BulkIdsDto() # BulkIdsDto | try: # Add assets to an album api_response = api_instance.add_assets_to_album(id, bulk_ids_dto) print("The response of AlbumsApi->add_assets_to_album:\n") pprint(api_response) except ApiException as e: print("Exception when calling AlbumsApi->add_assets_to_album: %s\n" % e) ``` ## Documentation for API Endpoints All URIs are relative to *https://github.com/api* Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- *AlbumsApi* | [**add_assets_to_album**](generated/immich/openapi_client/docs/AlbumsApi.md#add_assets_to_album) | **PUT** /albums/{id}/assets | Add assets to an album *AlbumsApi* | [**add_assets_to_albums**](generated/immich/openapi_client/docs/AlbumsApi.md#add_assets_to_albums) | **PUT** /albums/assets | Add assets to albums *AlbumsApi* | [**add_users_to_album**](generated/immich/openapi_client/docs/AlbumsApi.md#add_users_to_album) | **PUT** /albums/{id}/users | Share album with users *AlbumsApi* | [**create_album**](generated/immich/openapi_client/docs/AlbumsApi.md#create_album) | **POST** /albums | Create an album *AlbumsApi* | [**delete_album**](generated/immich/openapi_client/docs/AlbumsApi.md#delete_album) | **DELETE** /albums/{id} | Delete an album *AlbumsApi* | [**get_album_info**](generated/immich/openapi_client/docs/AlbumsApi.md#get_album_info) | **GET** /albums/{id} | Retrieve an album *AlbumsApi* | [**get_album_map_markers**](generated/immich/openapi_client/docs/AlbumsApi.md#get_album_map_markers) | **GET** /albums/{id}/map-markers | Retrieve album map markers *AlbumsApi* | [**get_album_statistics**](generated/immich/openapi_client/docs/AlbumsApi.md#get_album_statistics) | **GET** /albums/statistics | Retrieve album statistics *AlbumsApi* | [**get_all_albums**](generated/immich/openapi_client/docs/AlbumsApi.md#get_all_albums) | **GET** /albums | List all albums *AlbumsApi* | [**remove_asset_from_album**](generated/immich/openapi_client/docs/AlbumsApi.md#remove_asset_from_album) | **DELETE** /albums/{id}/assets | Remove assets from an album *AlbumsApi* | [**remove_user_from_album**](generated/immich/openapi_client/docs/AlbumsApi.md#remove_user_from_album) | **DELETE** /albums/{id}/user/{userId} | Remove user from album *AlbumsApi* | [**update_album_info**](generated/immich/openapi_client/docs/AlbumsApi.md#update_album_info) | **PATCH** /albums/{id} | Update an album *AlbumsApi* | [**update_album_user**](generated/immich/openapi_client/docs/AlbumsApi.md#update_album_user) | **PUT** /albums/{id}/user/{userId} | Update user role *AssetsApi* | [**check_bulk_upload**](generated/immich/openapi_client/docs/AssetsApi.md#check_bulk_upload) | **POST** /assets/bulk-upload-check | Check bulk upload *AssetsApi* | [**copy_asset**](generated/immich/openapi_client/docs/AssetsApi.md#copy_asset) | **PUT** /assets/copy | Copy asset *AssetsApi* | [**delete_asset_metadata**](generated/immich/openapi_client/docs/AssetsApi.md#delete_asset_metadata) | **DELETE** /assets/{id}/metadata/{key} | Delete asset metadata by key *AssetsApi* | [**delete_assets**](generated/immich/openapi_client/docs/AssetsApi.md#delete_assets) | **DELETE** /assets | Delete assets *AssetsApi* | [**delete_bulk_asset_metadata**](generated/immich/openapi_client/docs/AssetsApi.md#delete_bulk_asset_metadata) | **DELETE** /assets/metadata | Delete asset metadata *AssetsApi* | [**download_asset**](generated/immich/openapi_client/docs/AssetsApi.md#download_asset) | **GET** /assets/{id}/original | Download original asset *AssetsApi* | [**edit_asset**](generated/immich/openapi_client/docs/AssetsApi.md#edit_asset) | **PUT** /assets/{id}/edits | Apply edits to an existing asset *AssetsApi* | [**end_session**](generated/immich/openapi_client/docs/AssetsApi.md#end_session) | **DELETE** /assets/{id}/video/stream/{sessionId} | End HLS streaming session *AssetsApi* | [**get_asset_edits**](generated/immich/openapi_client/docs/AssetsApi.md#get_asset_edits) | **GET** /assets/{id}/edits | Retrieve edits for an existing asset *AssetsApi* | [**get_asset_info**](generated/immich/openapi_client/docs/AssetsApi.md#get_asset_info) | **GET** /assets/{id} | Retrieve an asset *AssetsApi* | [**get_asset_metadata**](generated/immich/openapi_client/docs/AssetsApi.md#get_asset_metadata) | **GET** /assets/{id}/metadata | Get asset metadata *AssetsApi* | [**get_asset_metadata_by_key**](generated/immich/openapi_client/docs/AssetsApi.md#get_asset_metadata_by_key) | **GET** /assets/{id}/metadata/{key} | Retrieve asset metadata by key *AssetsApi* | [**get_asset_ocr**](generated/immich/openapi_client/docs/AssetsApi.md#get_asset_ocr) | **GET** /assets/{id}/ocr | Retrieve asset OCR data *AssetsApi* | [**get_asset_statistics**](generated/immich/openapi_client/docs/AssetsApi.md#get_asset_statistics) | **GET** /assets/statistics | Get asset statistics *AssetsApi* | [**get_main_playlist**](generated/immich/openapi_client/docs/AssetsApi.md#get_main_playlist) | **GET** /assets/{id}/video/stream/main.m3u8 | Get HLS main playlist *AssetsApi* | [**get_media_playlist**](generated/immich/openapi_client/docs/AssetsApi.md#get_media_playlist) | **GET** /assets/{id}/video/stream/{sessionId}/{variantIndex}/playlist.m3u8 | Get HLS media playlist *AssetsApi* | [**get_segment**](generated/immich/openapi_client/docs/AssetsApi.md#get_segment) | **GET** /assets/{id}/video/stream/{sessionId}/{variantIndex}/{filename} | Get HLS segment or init file *AssetsApi* | [**play_asset_video**](generated/immich/openapi_client/docs/AssetsApi.md#play_asset_video) | **GET** /assets/{id}/video/playback | Play asset video *AssetsApi* | [**remove_asset_edits**](generated/immich/openapi_client/docs/AssetsApi.md#remove_asset_edits) | **DELETE** /assets/{id}/edits | Remove edits from an existing asset *AssetsApi* | [**run_asset_jobs**](generated/immich/openapi_client/docs/AssetsApi.md#run_asset_jobs) | **POST** /assets/jobs | Run an asset job *AssetsApi* | [**update_asset**](generated/immich/openapi_client/docs/AssetsApi.md#update_asset) | **PUT** /assets/{id} | Update an asset *AssetsApi* | [**update_asset_metadata**](generated/immich/openapi_client/docs/AssetsApi.md#update_asset_metadata) | **PUT** /assets/{id}/metadata | Update asset metadata *AssetsApi* | [**update_assets**](generated/immich/openapi_client/docs/AssetsApi.md#update_assets) | **PUT** /assets | Update assets *AssetsApi* | [**update_bulk_asset_metadata**](generated/immich/openapi_client/docs/AssetsApi.md#update_bulk_asset_metadata) | **PUT** /assets/metadata | Upsert asset metadata *AssetsApi* | [**upload_asset**](generated/immich/openapi_client/docs/AssetsApi.md#upload_asset) | **POST** /assets | Upload asset *AssetsApi* | [**view_asset**](generated/immich/openapi_client/docs/AssetsApi.md#view_asset) | **GET** /assets/{id}/thumbnail | View asset thumbnail *SearchApi* | [**get_assets_by_city**](generated/immich/openapi_client/docs/SearchApi.md#get_assets_by_city) | **GET** /search/cities | Retrieve assets by city *SearchApi* | [**get_explore_data**](generated/immich/openapi_client/docs/SearchApi.md#get_explore_data) | **GET** /search/explore | Retrieve explore data *SearchApi* | [**get_search_suggestions**](generated/immich/openapi_client/docs/SearchApi.md#get_search_suggestions) | **GET** /search/suggestions | Retrieve search suggestions *SearchApi* | [**search_asset_statistics**](generated/immich/openapi_client/docs/SearchApi.md#search_asset_statistics) | **POST** /search/statistics | Search asset statistics *SearchApi* | [**search_assets**](generated/immich/openapi_client/docs/SearchApi.md#search_assets) | **POST** /search/metadata | Search assets by metadata *SearchApi* | [**search_large_assets**](generated/immich/openapi_client/docs/SearchApi.md#search_large_assets) | **POST** /search/large-assets | Search large assets *SearchApi* | [**search_person**](generated/immich/openapi_client/docs/SearchApi.md#search_person) | **GET** /search/person | Search people *SearchApi* | [**search_places**](generated/immich/openapi_client/docs/SearchApi.md#search_places) | **GET** /search/places | Search places *SearchApi* | [**search_random**](generated/immich/openapi_client/docs/SearchApi.md#search_random) | **POST** /search/random | Search random assets *SearchApi* | [**search_smart**](generated/immich/openapi_client/docs/SearchApi.md#search_smart) | **POST** /search/smart | Smart asset search ## Documentation For Models - [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) - [AlbumsAddAssetsDto](generated/immich/openapi_client/docs/AlbumsAddAssetsDto.md) - [AlbumsAddAssetsResponseDto](generated/immich/openapi_client/docs/AlbumsAddAssetsResponseDto.md) - [AlbumsResponse](generated/immich/openapi_client/docs/AlbumsResponse.md) - [AlbumsUpdate](generated/immich/openapi_client/docs/AlbumsUpdate.md) - [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) - [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) - [AssetCopyDto](generated/immich/openapi_client/docs/AssetCopyDto.md) - [AssetEditAction](generated/immich/openapi_client/docs/AssetEditAction.md) - [AssetEditActionItemDto](generated/immich/openapi_client/docs/AssetEditActionItemDto.md) - [AssetEditActionItemDtoParameters](generated/immich/openapi_client/docs/AssetEditActionItemDtoParameters.md) - [AssetEditActionItemResponseDto](generated/immich/openapi_client/docs/AssetEditActionItemResponseDto.md) - [AssetEditsCreateDto](generated/immich/openapi_client/docs/AssetEditsCreateDto.md) - [AssetEditsResponseDto](generated/immich/openapi_client/docs/AssetEditsResponseDto.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) - [AssetIdErrorReason](generated/immich/openapi_client/docs/AssetIdErrorReason.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) - [AssetMetadataBulkDeleteDto](generated/immich/openapi_client/docs/AssetMetadataBulkDeleteDto.md) - [AssetMetadataBulkDeleteItemDto](generated/immich/openapi_client/docs/AssetMetadataBulkDeleteItemDto.md) - [AssetMetadataBulkResponseDto](generated/immich/openapi_client/docs/AssetMetadataBulkResponseDto.md) - [AssetMetadataBulkUpsertDto](generated/immich/openapi_client/docs/AssetMetadataBulkUpsertDto.md) - [AssetMetadataBulkUpsertItemDto](generated/immich/openapi_client/docs/AssetMetadataBulkUpsertItemDto.md) - [AssetMetadataResponseDto](generated/immich/openapi_client/docs/AssetMetadataResponseDto.md) - [AssetMetadataUpsertDto](generated/immich/openapi_client/docs/AssetMetadataUpsertDto.md) - [AssetMetadataUpsertItemDto](generated/immich/openapi_client/docs/AssetMetadataUpsertItemDto.md) - [AssetOcrResponseDto](generated/immich/openapi_client/docs/AssetOcrResponseDto.md) - [AssetOrder](generated/immich/openapi_client/docs/AssetOrder.md) - [AssetOrderBy](generated/immich/openapi_client/docs/AssetOrderBy.md) - [AssetRejectReason](generated/immich/openapi_client/docs/AssetRejectReason.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) - [AssetUploadAction](generated/immich/openapi_client/docs/AssetUploadAction.md) - [AssetVisibility](generated/immich/openapi_client/docs/AssetVisibility.md) - [AudioCodec](generated/immich/openapi_client/docs/AudioCodec.md) - [AuthStatusResponseDto](generated/immich/openapi_client/docs/AuthStatusResponseDto.md) - [AvatarUpdate](generated/immich/openapi_client/docs/AvatarUpdate.md) - [BulkIdErrorReason](generated/immich/openapi_client/docs/BulkIdErrorReason.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) - [CalendarHeatmapResponseDto](generated/immich/openapi_client/docs/CalendarHeatmapResponseDto.md) - [CalendarHeatmapResponseDtoSeriesInner](generated/immich/openapi_client/docs/CalendarHeatmapResponseDtoSeriesInner.md) - [CalendarHeatmapType](generated/immich/openapi_client/docs/CalendarHeatmapType.md) - [CastResponse](generated/immich/openapi_client/docs/CastResponse.md) - [CastUpdate](generated/immich/openapi_client/docs/CastUpdate.md) - [ChangePasswordDto](generated/immich/openapi_client/docs/ChangePasswordDto.md) - [Colorspace](generated/immich/openapi_client/docs/Colorspace.md) - [ContributorCountResponseDto](generated/immich/openapi_client/docs/ContributorCountResponseDto.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) - [CropParameters](generated/immich/openapi_client/docs/CropParameters.md) - [DatabaseBackupConfig](generated/immich/openapi_client/docs/DatabaseBackupConfig.md) - [DatabaseBackupDeleteDto](generated/immich/openapi_client/docs/DatabaseBackupDeleteDto.md) - [DatabaseBackupDto](generated/immich/openapi_client/docs/DatabaseBackupDto.md) - [DatabaseBackupListResponseDto](generated/immich/openapi_client/docs/DatabaseBackupListResponseDto.md) - [DownloadArchiveDto](generated/immich/openapi_client/docs/DownloadArchiveDto.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) - [DuplicateResolveDto](generated/immich/openapi_client/docs/DuplicateResolveDto.md) - [DuplicateResolveGroupDto](generated/immich/openapi_client/docs/DuplicateResolveGroupDto.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) - [FoldersResponse](generated/immich/openapi_client/docs/FoldersResponse.md) - [FoldersUpdate](generated/immich/openapi_client/docs/FoldersUpdate.md) - [ImageFormat](generated/immich/openapi_client/docs/ImageFormat.md) - [IntegrityReport](generated/immich/openapi_client/docs/IntegrityReport.md) - [IntegrityReportResponseDto](generated/immich/openapi_client/docs/IntegrityReportResponseDto.md) - [IntegrityReportResponseDtoItemsInner](generated/immich/openapi_client/docs/IntegrityReportResponseDtoItemsInner.md) - [IntegrityReportSummaryResponseDto](generated/immich/openapi_client/docs/IntegrityReportSummaryResponseDto.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) - [LibraryResponseDto](generated/immich/openapi_client/docs/LibraryResponseDto.md) - [LibraryStatsResponseDto](generated/immich/openapi_client/docs/LibraryStatsResponseDto.md) - [LicenseKeyDto](generated/immich/openapi_client/docs/LicenseKeyDto.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) - [MachineLearningAvailabilityChecksDto](generated/immich/openapi_client/docs/MachineLearningAvailabilityChecksDto.md) - [MaintenanceAction](generated/immich/openapi_client/docs/MaintenanceAction.md) - [MaintenanceAuthDto](generated/immich/openapi_client/docs/MaintenanceAuthDto.md) - [MaintenanceDetectInstallResponseDto](generated/immich/openapi_client/docs/MaintenanceDetectInstallResponseDto.md) - [MaintenanceDetectInstallStorageFolderDto](generated/immich/openapi_client/docs/MaintenanceDetectInstallStorageFolderDto.md) - [MaintenanceLoginDto](generated/immich/openapi_client/docs/MaintenanceLoginDto.md) - [MaintenanceStatusResponseDto](generated/immich/openapi_client/docs/MaintenanceStatusResponseDto.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) - [MemoryResponseDto](generated/immich/openapi_client/docs/MemoryResponseDto.md) - [MemorySearchOrder](generated/immich/openapi_client/docs/MemorySearchOrder.md) - [MemoryStatisticsResponseDto](generated/immich/openapi_client/docs/MemoryStatisticsResponseDto.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) - [MirrorAxis](generated/immich/openapi_client/docs/MirrorAxis.md) - [MirrorParameters](generated/immich/openapi_client/docs/MirrorParameters.md) - [NotificationCreateDto](generated/immich/openapi_client/docs/NotificationCreateDto.md) - [NotificationDeleteAllDto](generated/immich/openapi_client/docs/NotificationDeleteAllDto.md) - [NotificationDto](generated/immich/openapi_client/docs/NotificationDto.md) - [NotificationLevel](generated/immich/openapi_client/docs/NotificationLevel.md) - [NotificationType](generated/immich/openapi_client/docs/NotificationType.md) - [NotificationUpdateAllDto](generated/immich/openapi_client/docs/NotificationUpdateAllDto.md) - [NotificationUpdateDto](generated/immich/openapi_client/docs/NotificationUpdateDto.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) - [OAuthTokenEndpointAuthMethod](generated/immich/openapi_client/docs/OAuthTokenEndpointAuthMethod.md) - [OcrConfig](generated/immich/openapi_client/docs/OcrConfig.md) - [OnThisDayDto](generated/immich/openapi_client/docs/OnThisDayDto.md) - [OnboardingDto](generated/immich/openapi_client/docs/OnboardingDto.md) - [OnboardingResponseDto](generated/immich/openapi_client/docs/OnboardingResponseDto.md) - [PartnerCreateDto](generated/immich/openapi_client/docs/PartnerCreateDto.md) - [PartnerDirection](generated/immich/openapi_client/docs/PartnerDirection.md) - [PartnerResponseDto](generated/immich/openapi_client/docs/PartnerResponseDto.md) - [PartnerUpdateDto](generated/immich/openapi_client/docs/PartnerUpdateDto.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) - [PinCodeChangeDto](generated/immich/openapi_client/docs/PinCodeChangeDto.md) - [PinCodeResetDto](generated/immich/openapi_client/docs/PinCodeResetDto.md) - [PinCodeSetupDto](generated/immich/openapi_client/docs/PinCodeSetupDto.md) - [PlacesResponseDto](generated/immich/openapi_client/docs/PlacesResponseDto.md) - [PluginMethodResponseDto](generated/immich/openapi_client/docs/PluginMethodResponseDto.md) - [PluginResponseDto](generated/immich/openapi_client/docs/PluginResponseDto.md) - [PluginTemplateResponseDto](generated/immich/openapi_client/docs/PluginTemplateResponseDto.md) - [PluginTemplateStepResponseDto](generated/immich/openapi_client/docs/PluginTemplateStepResponseDto.md) - [PurchaseResponse](generated/immich/openapi_client/docs/PurchaseResponse.md) - [PurchaseUpdate](generated/immich/openapi_client/docs/PurchaseUpdate.md) - [QueueCommand](generated/immich/openapi_client/docs/QueueCommand.md) - [QueueCommandDto](generated/immich/openapi_client/docs/QueueCommandDto.md) - [QueueDeleteDto](generated/immich/openapi_client/docs/QueueDeleteDto.md) - [QueueJobResponseDto](generated/immich/openapi_client/docs/QueueJobResponseDto.md) - [QueueJobStatus](generated/immich/openapi_client/docs/QueueJobStatus.md) - [QueueName](generated/immich/openapi_client/docs/QueueName.md) - [QueueResponseDto](generated/immich/openapi_client/docs/QueueResponseDto.md) - [QueueResponseLegacyDto](generated/immich/openapi_client/docs/QueueResponseLegacyDto.md) - [QueueStatisticsDto](generated/immich/openapi_client/docs/QueueStatisticsDto.md) - [QueueStatusLegacyDto](generated/immich/openapi_client/docs/QueueStatusLegacyDto.md) - [QueueUpdateDto](generated/immich/openapi_client/docs/QueueUpdateDto.md) - [QueuesResponseLegacyDto](generated/immich/openapi_client/docs/QueuesResponseLegacyDto.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) - [RecentlyAddedResponse](generated/immich/openapi_client/docs/RecentlyAddedResponse.md) - [RecentlyAddedUpdate](generated/immich/openapi_client/docs/RecentlyAddedUpdate.md) - [ReleaseChannel](generated/immich/openapi_client/docs/ReleaseChannel.md) - [ReleaseEventV1](generated/immich/openapi_client/docs/ReleaseEventV1.md) - [ReleaseType](generated/immich/openapi_client/docs/ReleaseType.md) - [ReverseGeocodingStateResponseDto](generated/immich/openapi_client/docs/ReverseGeocodingStateResponseDto.md) - [RotateParameters](generated/immich/openapi_client/docs/RotateParameters.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) - [SearchStatisticsResponseDto](generated/immich/openapi_client/docs/SearchStatisticsResponseDto.md) - [SearchSuggestionType](generated/immich/openapi_client/docs/SearchSuggestionType.md) - [ServerAboutResponseDto](generated/immich/openapi_client/docs/ServerAboutResponseDto.md) - [ServerApkLinksDto](generated/immich/openapi_client/docs/ServerApkLinksDto.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) - [ServerVersionHistoryResponseDto](generated/immich/openapi_client/docs/ServerVersionHistoryResponseDto.md) - [ServerVersionResponseDto](generated/immich/openapi_client/docs/ServerVersionResponseDto.md) - [SessionCreateDto](generated/immich/openapi_client/docs/SessionCreateDto.md) - [SessionCreateResponseDto](generated/immich/openapi_client/docs/SessionCreateResponseDto.md) - [SessionResponseDto](generated/immich/openapi_client/docs/SessionResponseDto.md) - [SessionUnlockDto](generated/immich/openapi_client/docs/SessionUnlockDto.md) - [SessionUpdateDto](generated/immich/openapi_client/docs/SessionUpdateDto.md) - [SetMaintenanceModeDto](generated/immich/openapi_client/docs/SetMaintenanceModeDto.md) - [SharedLinkCreateDto](generated/immich/openapi_client/docs/SharedLinkCreateDto.md) - [SharedLinkEditDto](generated/immich/openapi_client/docs/SharedLinkEditDto.md) - [SharedLinkLoginDto](generated/immich/openapi_client/docs/SharedLinkLoginDto.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) - [StatisticsSearchDto](generated/immich/openapi_client/docs/StatisticsSearchDto.md) - [StorageFolder](generated/immich/openapi_client/docs/StorageFolder.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) - [SyncAlbumDeleteV1](generated/immich/openapi_client/docs/SyncAlbumDeleteV1.md) - [SyncAlbumToAssetDeleteV1](generated/immich/openapi_client/docs/SyncAlbumToAssetDeleteV1.md) - [SyncAlbumToAssetV1](generated/immich/openapi_client/docs/SyncAlbumToAssetV1.md) - [SyncAlbumUserDeleteV1](generated/immich/openapi_client/docs/SyncAlbumUserDeleteV1.md) - [SyncAlbumUserV1](generated/immich/openapi_client/docs/SyncAlbumUserV1.md) - [SyncAlbumV1](generated/immich/openapi_client/docs/SyncAlbumV1.md) - [SyncAlbumV2](generated/immich/openapi_client/docs/SyncAlbumV2.md) - [SyncAssetDeleteV1](generated/immich/openapi_client/docs/SyncAssetDeleteV1.md) - [SyncAssetEditDeleteV1](generated/immich/openapi_client/docs/SyncAssetEditDeleteV1.md) - [SyncAssetEditV1](generated/immich/openapi_client/docs/SyncAssetEditV1.md) - [SyncAssetExifV1](generated/immich/openapi_client/docs/SyncAssetExifV1.md) - [SyncAssetFaceDeleteV1](generated/immich/openapi_client/docs/SyncAssetFaceDeleteV1.md) - [SyncAssetFaceV1](generated/immich/openapi_client/docs/SyncAssetFaceV1.md) - [SyncAssetFaceV2](generated/immich/openapi_client/docs/SyncAssetFaceV2.md) - [SyncAssetMetadataDeleteV1](generated/immich/openapi_client/docs/SyncAssetMetadataDeleteV1.md) - [SyncAssetMetadataV1](generated/immich/openapi_client/docs/SyncAssetMetadataV1.md) - [SyncAssetOcrDeleteV1](generated/immich/openapi_client/docs/SyncAssetOcrDeleteV1.md) - [SyncAssetOcrV1](generated/immich/openapi_client/docs/SyncAssetOcrV1.md) - [SyncAssetV1](generated/immich/openapi_client/docs/SyncAssetV1.md) - [SyncAssetV2](generated/immich/openapi_client/docs/SyncAssetV2.md) - [SyncAuthUserV1](generated/immich/openapi_client/docs/SyncAuthUserV1.md) - [SyncEntityType](generated/immich/openapi_client/docs/SyncEntityType.md) - [SyncMemoryAssetDeleteV1](generated/immich/openapi_client/docs/SyncMemoryAssetDeleteV1.md) - [SyncMemoryAssetV1](generated/immich/openapi_client/docs/SyncMemoryAssetV1.md) - [SyncMemoryDeleteV1](generated/immich/openapi_client/docs/SyncMemoryDeleteV1.md) - [SyncMemoryV1](generated/immich/openapi_client/docs/SyncMemoryV1.md) - [SyncPartnerDeleteV1](generated/immich/openapi_client/docs/SyncPartnerDeleteV1.md) - [SyncPartnerV1](generated/immich/openapi_client/docs/SyncPartnerV1.md) - [SyncPersonDeleteV1](generated/immich/openapi_client/docs/SyncPersonDeleteV1.md) - [SyncPersonV1](generated/immich/openapi_client/docs/SyncPersonV1.md) - [SyncRequestType](generated/immich/openapi_client/docs/SyncRequestType.md) - [SyncStackDeleteV1](generated/immich/openapi_client/docs/SyncStackDeleteV1.md) - [SyncStackV1](generated/immich/openapi_client/docs/SyncStackV1.md) - [SyncStreamDto](generated/immich/openapi_client/docs/SyncStreamDto.md) - [SyncUserDeleteV1](generated/immich/openapi_client/docs/SyncUserDeleteV1.md) - [SyncUserMetadataDeleteV1](generated/immich/openapi_client/docs/SyncUserMetadataDeleteV1.md) - [SyncUserMetadataV1](generated/immich/openapi_client/docs/SyncUserMetadataV1.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) - [SystemConfigFFmpegRealtimeDto](generated/immich/openapi_client/docs/SystemConfigFFmpegRealtimeDto.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) - [SystemConfigIntegrityChecks](generated/immich/openapi_client/docs/SystemConfigIntegrityChecks.md) - [SystemConfigIntegrityChecksumJob](generated/immich/openapi_client/docs/SystemConfigIntegrityChecksumJob.md) - [SystemConfigIntegrityJob](generated/immich/openapi_client/docs/SystemConfigIntegrityJob.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) - [SystemConfigNightlyTasksDto](generated/immich/openapi_client/docs/SystemConfigNightlyTasksDto.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) - [TimeBucketAssetResponseDto](generated/immich/openapi_client/docs/TimeBucketAssetResponseDto.md) - [TimeBucketsResponseDto](generated/immich/openapi_client/docs/TimeBucketsResponseDto.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) - [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) - [UserMetadataKey](generated/immich/openapi_client/docs/UserMetadataKey.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) - [VersionCheckStateResponseDto](generated/immich/openapi_client/docs/VersionCheckStateResponseDto.md) - [VideoCodec](generated/immich/openapi_client/docs/VideoCodec.md) - [VideoContainer](generated/immich/openapi_client/docs/VideoContainer.md) - [WorkflowCreateDto](generated/immich/openapi_client/docs/WorkflowCreateDto.md) - [WorkflowResponseDto](generated/immich/openapi_client/docs/WorkflowResponseDto.md) - [WorkflowShareResponseDto](generated/immich/openapi_client/docs/WorkflowShareResponseDto.md) - [WorkflowShareStepDto](generated/immich/openapi_client/docs/WorkflowShareStepDto.md) - [WorkflowStepDto](generated/immich/openapi_client/docs/WorkflowStepDto.md) - [WorkflowTrigger](generated/immich/openapi_client/docs/WorkflowTrigger.md) - [WorkflowTriggerResponseDto](generated/immich/openapi_client/docs/WorkflowTriggerResponseDto.md) - [WorkflowType](generated/immich/openapi_client/docs/WorkflowType.md) - [WorkflowUpdateDto](generated/immich/openapi_client/docs/WorkflowUpdateDto.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