immich-python-sdk 1.93.0

Immich python SDK

immich-python-sdk

Immich API

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 1.92.1
• Package version: 1.93.0
• Generator version: 7.14.0-SNAPSHOT
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.9+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/Marian-Braendle/immich-python-sdk.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/Marian-Braendle/immich-python-sdk.git)

Then import the package:

import immich_python_sdk

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import immich_python_sdk

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import immich_python_sdk
from immich_python_sdk.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 = immich_python_sdk.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 = immich_python_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with immich_python_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = immich_python_sdk.APIKeyApi(api_client)
    api_key_create_dto = immich_python_sdk.APIKeyCreateDto() # APIKeyCreateDto | 

    try:
        api_response = api_instance.create_api_key(api_key_create_dto)
        print("The response of APIKeyApi->create_api_key:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling APIKeyApi->create_api_key: %s\n" % e)

Documentation for API Endpoints

Class	Method	HTTP request	Description
APIKeyApi	create_api_key	POST /api-key
APIKeyApi	delete_api_key	DELETE /api-key/{id}
APIKeyApi	get_api_key	GET /api-key/{id}
APIKeyApi	get_api_keys	GET /api-key
APIKeyApi	update_api_key	PUT /api-key/{id}
ActivityApi	create_activity	POST /activity
ActivityApi	delete_activity	DELETE /activity/{id}
ActivityApi	get_activities	GET /activity
ActivityApi	get_activity_statistics	GET /activity/statistics
AlbumApi	add_assets_to_album	PUT /album/{id}/assets
AlbumApi	add_users_to_album	PUT /album/{id}/users
AlbumApi	create_album	POST /album
AlbumApi	delete_album	DELETE /album/{id}
AlbumApi	get_album_count	GET /album/count
AlbumApi	get_album_info	GET /album/{id}
AlbumApi	get_all_albums	GET /album
AlbumApi	remove_asset_from_album	DELETE /album/{id}/assets
AlbumApi	remove_user_from_album	DELETE /album/{id}/user/{userId}
AlbumApi	update_album_info	PATCH /album/{id}
AssetApi	check_bulk_upload	POST /asset/bulk-upload-check
AssetApi	check_existing_assets	POST /asset/exist
AssetApi	delete_assets	DELETE /asset
AssetApi	download_archive	POST /asset/download/archive
AssetApi	download_file	POST /asset/download/{id}
AssetApi	empty_trash	POST /asset/trash/empty
AssetApi	get_all_assets	GET /asset
AssetApi	get_all_user_assets_by_device_id	GET /asset/device/{deviceId}
AssetApi	get_asset_by_id	GET /asset/assetById/{id}
AssetApi	get_asset_search_terms	GET /asset/search-terms
AssetApi	get_asset_statistics	GET /asset/statistics
AssetApi	get_asset_thumbnail	GET /asset/thumbnail/{id}
AssetApi	get_curated_locations	GET /asset/curated-locations
AssetApi	get_curated_objects	GET /asset/curated-objects
AssetApi	get_download_info	POST /asset/download/info
AssetApi	get_map_markers	GET /asset/map-marker
AssetApi	get_memory_lane	GET /asset/memory-lane
AssetApi	get_random	GET /asset/random
AssetApi	get_time_bucket	GET /asset/time-bucket
AssetApi	get_time_buckets	GET /asset/time-buckets
AssetApi	get_user_assets_by_device_id	GET /asset/{deviceId}	Use /asset/device/:deviceId instead - Remove in 1.92 release
AssetApi	restore_assets	POST /asset/restore
AssetApi	restore_trash	POST /asset/trash/restore
AssetApi	run_asset_jobs	POST /asset/jobs
AssetApi	search_assets	GET /assets
AssetApi	serve_file	GET /asset/file/{id}
AssetApi	update_asset	PUT /asset/{id}
AssetApi	update_assets	PUT /asset
AssetApi	update_stack_parent	PUT /asset/stack/parent
AssetApi	upload_file	POST /asset/upload
AuditApi	fix_audit_files	POST /audit/file-report/fix
AuditApi	get_audit_deletes	GET /audit/deletes
AuditApi	get_audit_files	GET /audit/file-report
AuditApi	get_file_checksums	POST /audit/file-report/checksum
AuthenticationApi	change_password	POST /auth/change-password
AuthenticationApi	get_auth_devices	GET /auth/devices
AuthenticationApi	login	POST /auth/login
AuthenticationApi	logout	POST /auth/logout
AuthenticationApi	logout_auth_device	DELETE /auth/devices/{id}
AuthenticationApi	logout_auth_devices	DELETE /auth/devices
AuthenticationApi	sign_up_admin	POST /auth/admin-sign-up
AuthenticationApi	validate_access_token	POST /auth/validateToken
FaceApi	get_faces	GET /face
FaceApi	reassign_faces_by_id	PUT /face/{id}
JobApi	get_all_jobs_status	GET /jobs
JobApi	send_job_command	PUT /jobs/{id}
LibraryApi	create_library	POST /library
LibraryApi	delete_library	DELETE /library/{id}
LibraryApi	get_libraries	GET /library
LibraryApi	get_library_info	GET /library/{id}
LibraryApi	get_library_statistics	GET /library/{id}/statistics
LibraryApi	remove_offline_files	POST /library/{id}/removeOffline
LibraryApi	scan_library	POST /library/{id}/scan
LibraryApi	update_library	PUT /library/{id}
OAuthApi	finish_o_auth	POST /oauth/callback
OAuthApi	generate_o_auth_config	POST /oauth/config
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
PartnerApi	create_partner	POST /partner/{id}
PartnerApi	get_partners	GET /partner
PartnerApi	remove_partner	DELETE /partner/{id}
PartnerApi	update_partner	PUT /partner/{id}
PersonApi	create_person	POST /person
PersonApi	get_all_people	GET /person
PersonApi	get_person	GET /person/{id}
PersonApi	get_person_assets	GET /person/{id}/assets
PersonApi	get_person_statistics	GET /person/{id}/statistics
PersonApi	get_person_thumbnail	GET /person/{id}/thumbnail
PersonApi	merge_person	POST /person/{id}/merge
PersonApi	reassign_faces	PUT /person/{id}/reassign
PersonApi	update_people	PUT /person
PersonApi	update_person	PUT /person/{id}
SearchApi	get_explore_data	GET /search/explore
SearchApi	search	GET /search
SearchApi	search_person	GET /search/person
ServerInfoApi	get_server_config	GET /server-info/config
ServerInfoApi	get_server_features	GET /server-info/features
ServerInfoApi	get_server_info	GET /server-info
ServerInfoApi	get_server_statistics	GET /server-info/statistics
ServerInfoApi	get_server_version	GET /server-info/version
ServerInfoApi	get_supported_media_types	GET /server-info/media-types
ServerInfoApi	get_theme	GET /server-info/theme
ServerInfoApi	ping_server	GET /server-info/ping
ServerInfoApi	set_admin_onboarding	POST /server-info/admin-onboarding
SharedLinkApi	add_shared_link_assets	PUT /shared-link/{id}/assets
SharedLinkApi	create_shared_link	POST /shared-link
SharedLinkApi	get_all_shared_links	GET /shared-link
SharedLinkApi	get_my_shared_link	GET /shared-link/me
SharedLinkApi	get_shared_link_by_id	GET /shared-link/{id}
SharedLinkApi	remove_shared_link	DELETE /shared-link/{id}
SharedLinkApi	remove_shared_link_assets	DELETE /shared-link/{id}/assets
SharedLinkApi	update_shared_link	PATCH /shared-link/{id}
SystemConfigApi	get_config	GET /system-config
SystemConfigApi	get_config_defaults	GET /system-config/defaults
SystemConfigApi	get_map_style	GET /system-config/map/style.json
SystemConfigApi	get_storage_template_options	GET /system-config/storage-template-options
SystemConfigApi	update_config	PUT /system-config
TagApi	create_tag	POST /tag
TagApi	delete_tag	DELETE /tag/{id}
TagApi	get_all_tags	GET /tag
TagApi	get_tag_assets	GET /tag/{id}/assets
TagApi	get_tag_by_id	GET /tag/{id}
TagApi	tag_assets	PUT /tag/{id}/assets
TagApi	untag_assets	DELETE /tag/{id}/assets
TagApi	update_tag	PATCH /tag/{id}
UserApi	create_profile_image	POST /user/profile-image
UserApi	create_user	POST /user
UserApi	delete_profile_image	DELETE /user/profile-image
UserApi	delete_user	DELETE /user/{id}
UserApi	get_all_users	GET /user
UserApi	get_my_user_info	GET /user/me
UserApi	get_profile_image	GET /user/profile-image/{id}
UserApi	get_user_by_id	GET /user/info/{id}
UserApi	restore_user	POST /user/{id}/restore
UserApi	update_user	PUT /user

Documentation For Models

• APIKeyCreateDto
• APIKeyCreateResponseDto
• APIKeyResponseDto
• APIKeyUpdateDto
• ActivityCreateDto
• ActivityResponseDto
• ActivityStatisticsResponseDto
• AddUsersDto
• AlbumCountResponseDto
• AlbumResponseDto
• AllJobStatusResponseDto
• AssetBulkDeleteDto
• AssetBulkUpdateDto
• AssetBulkUploadCheckDto
• AssetBulkUploadCheckItem
• AssetBulkUploadCheckResponseDto
• AssetBulkUploadCheckResult
• AssetFaceResponseDto
• AssetFaceUpdateDto
• AssetFaceUpdateItem
• AssetFaceWithoutPersonResponseDto
• AssetFileUploadResponseDto
• AssetIdsDto
• AssetIdsResponseDto
• AssetJobName
• AssetJobsDto
• AssetOrder
• AssetResponseDto
• AssetStatsResponseDto
• AssetTypeEnum
• AudioCodec
• AuditDeletesResponseDto
• AuthDeviceResponseDto
• BulkIdResponseDto
• BulkIdsDto
• CLIPConfig
• CLIPMode
• CQMode
• ChangePasswordDto
• CheckExistingAssetsDto
• CheckExistingAssetsResponseDto
• Colorspace
• CreateAlbumDto
• CreateLibraryDto
• CreateProfileImageResponseDto
• CreateTagDto
• CreateUserDto
• CuratedLocationsResponseDto
• CuratedObjectsResponseDto
• DownloadArchiveInfo
• DownloadInfoDto
• DownloadResponseDto
• EntityType
• ExifResponseDto
• FaceDto
• FileChecksumDto
• FileChecksumResponseDto
• FileReportDto
• FileReportFixDto
• FileReportItemDto
• JobCommand
• JobCommandDto
• JobCountsDto
• JobName
• JobSettingsDto
• JobStatusDto
• LibraryResponseDto
• LibraryStatsResponseDto
• LibraryType
• LogLevel
• LoginCredentialDto
• LoginResponseDto
• LogoutResponseDto
• MapMarkerResponseDto
• MapTheme
• MemoryLaneResponseDto
• MergePersonDto
• ModelType
• OAuthAuthorizeResponseDto
• OAuthCallbackDto
• OAuthConfigDto
• OAuthConfigResponseDto
• PartnerResponseDto
• PathEntityType
• PathType
• PeopleResponseDto
• PeopleUpdateDto
• PeopleUpdateItem
• PersonResponseDto
• PersonStatisticsResponseDto
• PersonUpdateDto
• PersonWithFacesResponseDto
• QueueStatusDto
• ReactionLevel
• ReactionType
• RecognitionConfig
• ScanLibraryDto
• SearchAlbumResponseDto
• SearchAssetResponseDto
• SearchExploreItem
• SearchExploreResponseDto
• SearchFacetCountResponseDto
• SearchFacetResponseDto
• SearchResponseDto
• ServerConfigDto
• ServerFeaturesDto
• ServerInfoResponseDto
• ServerMediaTypesResponseDto
• ServerPingResponse
• ServerStatsResponseDto
• ServerThemeDto
• ServerVersionResponseDto
• SharedLinkCreateDto
• SharedLinkEditDto
• SharedLinkResponseDto
• SharedLinkType
• SignUpDto
• SmartInfoResponseDto
• SystemConfigDto
• SystemConfigFFmpegDto
• SystemConfigJobDto
• SystemConfigLibraryDto
• SystemConfigLibraryScanDto
• SystemConfigLoggingDto
• SystemConfigMachineLearningDto
• SystemConfigMapDto
• SystemConfigNewVersionCheckDto
• SystemConfigOAuthDto
• SystemConfigPasswordLoginDto
• SystemConfigReverseGeocodingDto
• SystemConfigServerDto
• SystemConfigStorageTemplateDto
• SystemConfigTemplateStorageOptionDto
• SystemConfigThemeDto
• SystemConfigThumbnailDto
• SystemConfigTrashDto
• TagResponseDto
• TagTypeEnum
• ThumbnailFormat
• TimeBucketResponseDto
• TimeBucketSize
• ToneMapping
• TranscodeHWAccel
• TranscodePolicy
• UpdateAlbumDto
• UpdateAssetDto
• UpdateLibraryDto
• UpdatePartnerDto
• UpdateStackParentDto
• UpdateTagDto
• UpdateUserDto
• UsageByUserDto
• UserAvatarColor
• UserDto
• UserResponseDto
• ValidateAccessTokenResponseDto
• VideoCodec

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