77 KiB
77 KiB
generated.immich.openapi-client
Immich API
The generated.immich.openapi_client package is automatically generated by the OpenAPI Generator project:
- API version: 3.0.1
- Package version: 1.0.0
- Generator version: 7.18.0-SNAPSHOT
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
Requirements.
Python 3.9+
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 >= 2.1.0, < 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:
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:
# Create an API key
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 | POST /api-keys | Create an API key |
| APIKeysApi | delete_api_key | DELETE /api-keys/{id} | Delete an API key |
| APIKeysApi | get_api_key | GET /api-keys/{id} | Retrieve an API key |
| APIKeysApi | get_api_keys | GET /api-keys | List all API keys |
| APIKeysApi | get_my_api_key | GET /api-keys/me | Retrieve the current API key |
| APIKeysApi | update_api_key | PUT /api-keys/{id} | Update an API key |
| ActivitiesApi | create_activity | POST /activities | Create an activity |
| ActivitiesApi | delete_activity | DELETE /activities/{id} | Delete an activity |
| ActivitiesApi | get_activities | GET /activities | List all activities |
| ActivitiesApi | get_activity_statistics | GET /activities/statistics | Retrieve activity statistics |
| AlbumsApi | add_assets_to_album | PUT /albums/{id}/assets | Add assets to an album |
| AlbumsApi | add_assets_to_albums | PUT /albums/assets | Add assets to albums |
| AlbumsApi | add_users_to_album | PUT /albums/{id}/users | Share album with users |
| AlbumsApi | create_album | POST /albums | Create an album |
| AlbumsApi | delete_album | DELETE /albums/{id} | Delete an album |
| AlbumsApi | get_album_info | GET /albums/{id} | Retrieve an album |
| AlbumsApi | get_album_map_markers | GET /albums/{id}/map-markers | Retrieve album map markers |
| AlbumsApi | get_album_statistics | GET /albums/statistics | Retrieve album statistics |
| AlbumsApi | get_all_albums | GET /albums | List all albums |
| AlbumsApi | remove_asset_from_album | DELETE /albums/{id}/assets | Remove assets from an album |
| AlbumsApi | remove_user_from_album | DELETE /albums/{id}/user/{userId} | Remove user from album |
| AlbumsApi | update_album_info | PATCH /albums/{id} | Update an album |
| AlbumsApi | update_album_user | PUT /albums/{id}/user/{userId} | Update user role |
| AssetsApi | check_bulk_upload | POST /assets/bulk-upload-check | Check bulk upload |
| AssetsApi | copy_asset | PUT /assets/copy | Copy asset |
| AssetsApi | delete_asset_metadata | DELETE /assets/{id}/metadata/{key} | Delete asset metadata by key |
| AssetsApi | delete_assets | DELETE /assets | Delete assets |
| AssetsApi | delete_bulk_asset_metadata | DELETE /assets/metadata | Delete asset metadata |
| AssetsApi | download_asset | GET /assets/{id}/original | Download original asset |
| AssetsApi | edit_asset | PUT /assets/{id}/edits | Apply edits to an existing asset |
| AssetsApi | end_session | DELETE /assets/{id}/video/stream/{sessionId} | End HLS streaming session |
| AssetsApi | get_asset_edits | GET /assets/{id}/edits | Retrieve edits for an existing asset |
| AssetsApi | get_asset_info | GET /assets/{id} | Retrieve an asset |
| AssetsApi | get_asset_metadata | GET /assets/{id}/metadata | Get asset metadata |
| AssetsApi | get_asset_metadata_by_key | GET /assets/{id}/metadata/{key} | Retrieve asset metadata by key |
| AssetsApi | get_asset_ocr | GET /assets/{id}/ocr | Retrieve asset OCR data |
| AssetsApi | get_asset_statistics | GET /assets/statistics | Get asset statistics |
| AssetsApi | get_main_playlist | GET /assets/{id}/video/stream/main.m3u8 | Get HLS main playlist |
| AssetsApi | get_media_playlist | GET /assets/{id}/video/stream/{sessionId}/{variantIndex}/playlist.m3u8 | Get HLS media playlist |
| AssetsApi | get_segment | GET /assets/{id}/video/stream/{sessionId}/{variantIndex}/{filename} | Get HLS segment or init file |
| AssetsApi | play_asset_video | GET /assets/{id}/video/playback | Play asset video |
| AssetsApi | remove_asset_edits | DELETE /assets/{id}/edits | Remove edits from an existing asset |
| AssetsApi | run_asset_jobs | POST /assets/jobs | Run an asset job |
| AssetsApi | update_asset | PUT /assets/{id} | Update an asset |
| AssetsApi | update_asset_metadata | PUT /assets/{id}/metadata | Update asset metadata |
| AssetsApi | update_assets | PUT /assets | Update assets |
| AssetsApi | update_bulk_asset_metadata | PUT /assets/metadata | Upsert asset metadata |
| AssetsApi | upload_asset | POST /assets | Upload asset |
| AssetsApi | view_asset | GET /assets/{id}/thumbnail | View asset thumbnail |
| AuthenticationApi | change_password | POST /auth/change-password | Change password |
| AuthenticationApi | change_pin_code | PUT /auth/pin-code | Change pin code |
| AuthenticationApi | finish_o_auth | POST /oauth/callback | Finish OAuth |
| AuthenticationApi | get_auth_status | GET /auth/status | Retrieve auth status |
| AuthenticationApi | link_o_auth_account | POST /oauth/link | Link OAuth account |
| AuthenticationApi | lock_auth_session | POST /auth/session/lock | Lock auth session |
| AuthenticationApi | login | POST /auth/login | Login |
| AuthenticationApi | logout | POST /auth/logout | Logout |
| AuthenticationApi | logout_o_auth | POST /oauth/backchannel-logout | Backchannel OAuth logout |
| AuthenticationApi | redirect_o_auth_to_mobile | GET /oauth/mobile-redirect | Redirect OAuth to mobile |
| AuthenticationApi | reset_pin_code | DELETE /auth/pin-code | Reset pin code |
| AuthenticationApi | setup_pin_code | POST /auth/pin-code | Setup pin code |
| AuthenticationApi | sign_up_admin | POST /auth/admin-sign-up | Register admin |
| AuthenticationApi | start_o_auth | POST /oauth/authorize | Start OAuth |
| AuthenticationApi | unlink_o_auth_account | POST /oauth/unlink | Unlink OAuth account |
| AuthenticationApi | unlock_auth_session | POST /auth/session/unlock | Unlock auth session |
| AuthenticationApi | validate_access_token | POST /auth/validateToken | Validate access token |
| AuthenticationAdminApi | unlink_all_o_auth_accounts_admin | POST /admin/auth/unlink-all | Unlink all OAuth accounts |
| DatabaseBackupsAdminApi | delete_database_backup | DELETE /admin/database-backups | Delete database backup |
| DatabaseBackupsAdminApi | download_database_backup | GET /admin/database-backups/{filename} | Download database backup |
| DatabaseBackupsAdminApi | list_database_backups | GET /admin/database-backups | List database backups |
| DatabaseBackupsAdminApi | start_database_restore_flow | POST /admin/database-backups/start-restore | Start database backup restore flow |
| DatabaseBackupsAdminApi | upload_database_backup | POST /admin/database-backups/upload | Upload database backup |
| DeprecatedApi | create_partner_deprecated | POST /partners/{id} | Create a partner |
| DeprecatedApi | get_queues_legacy | GET /jobs | Retrieve queue counts and status |
| DeprecatedApi | run_queue_command_legacy | PUT /jobs/{name} | Run jobs |
| DeprecatedApi | update_api_key | PUT /api-keys/{id} | Update an API key |
| DeprecatedApi | update_asset | PUT /assets/{id} | Update an asset |
| DeprecatedApi | update_assets | PUT /assets | Update assets |
| DeprecatedApi | update_library | PUT /libraries/{id} | Update a library |
| DeprecatedApi | update_memory | PUT /memories/{id} | Update a memory |
| DeprecatedApi | update_my_preferences | PUT /users/me/preferences | Update my preferences |
| DeprecatedApi | update_my_user | PUT /users/me | Update current user |
| DeprecatedApi | update_person | PUT /people/{id} | Update person |
| DeprecatedApi | update_session | PUT /sessions/{id} | Update a session |
| DeprecatedApi | update_stack | PUT /stacks/{id} | Update a stack |
| DeprecatedApi | update_tag | PUT /tags/{id} | Update a tag |
| DeprecatedApi | update_user_admin | PUT /admin/users/{id} | Update a user |
| DeprecatedApi | update_user_preferences_admin | PUT /admin/users/{id}/preferences | Update user preferences |
| DeprecatedApi | update_workflow | PUT /workflows/{id} | Update a workflow |
| DownloadApi | download_archive | POST /download/archive | Download asset archive |
| DownloadApi | get_download_info | POST /download/info | Retrieve download information |
| DuplicatesApi | delete_duplicate | DELETE /duplicates/{id} | Dismiss a duplicate group |
| DuplicatesApi | delete_duplicates | DELETE /duplicates | Delete duplicates |
| DuplicatesApi | get_asset_duplicates | GET /duplicates | Retrieve duplicates |
| DuplicatesApi | resolve_duplicates | POST /duplicates/resolve | Resolve duplicate groups |
| FacesApi | create_face | POST /faces | Create a face |
| FacesApi | delete_face | DELETE /faces/{id} | Delete a face |
| FacesApi | get_faces | GET /faces | Retrieve faces for asset |
| FacesApi | reassign_faces_by_id | PUT /faces/{id} | Re-assign a face to another person |
| JobsApi | create_job | POST /jobs | Create a manual job |
| JobsApi | get_queues_legacy | GET /jobs | Retrieve queue counts and status |
| JobsApi | run_queue_command_legacy | PUT /jobs/{name} | Run jobs |
| LibrariesApi | create_library | POST /libraries | Create a library |
| LibrariesApi | delete_library | DELETE /libraries/{id} | Delete a library |
| LibrariesApi | get_all_libraries | GET /libraries | Retrieve libraries |
| LibrariesApi | get_library | GET /libraries/{id} | Retrieve a library |
| LibrariesApi | get_library_statistics | GET /libraries/{id}/statistics | Retrieve library statistics |
| LibrariesApi | scan_library | POST /libraries/{id}/scan | Scan a library |
| LibrariesApi | update_library | PUT /libraries/{id} | Update a library |
| LibrariesApi | validate | POST /libraries/{id}/validate | Validate library settings |
| MaintenanceAdminApi | delete_integrity_report | DELETE /admin/integrity/report/{id} | Delete integrity report item |
| MaintenanceAdminApi | detect_prior_install | GET /admin/maintenance/detect-install | Detect existing install |
| MaintenanceAdminApi | get_integrity_report | GET /admin/integrity/report | Get integrity report by type |
| MaintenanceAdminApi | get_integrity_report_csv | GET /admin/integrity/report/{type}/csv | Export integrity report by type as CSV |
| MaintenanceAdminApi | get_integrity_report_file | GET /admin/integrity/report/{id}/file | Download flagged file |
| MaintenanceAdminApi | get_integrity_report_summary | GET /admin/integrity/summary | Get integrity report summary |
| MaintenanceAdminApi | get_maintenance_status | GET /admin/maintenance/status | Get maintenance mode status |
| MaintenanceAdminApi | maintenance_login | POST /admin/maintenance/login | Log into maintenance mode |
| MaintenanceAdminApi | set_maintenance_mode | POST /admin/maintenance | Set maintenance mode |
| MapApi | get_map_markers | GET /map/markers | Retrieve map markers |
| MapApi | reverse_geocode | GET /map/reverse-geocode | Reverse geocode coordinates |
| MemoriesApi | add_memory_assets | PUT /memories/{id}/assets | Add assets to a memory |
| MemoriesApi | create_memory | POST /memories | Create a memory |
| MemoriesApi | delete_memory | DELETE /memories/{id} | Delete a memory |
| MemoriesApi | get_memory | GET /memories/{id} | Retrieve a memory |
| MemoriesApi | memories_statistics | GET /memories/statistics | Retrieve memories statistics |
| MemoriesApi | remove_memory_assets | DELETE /memories/{id}/assets | Remove assets from a memory |
| MemoriesApi | search_memories | GET /memories | Retrieve memories |
| MemoriesApi | update_memory | PUT /memories/{id} | Update a memory |
| NotificationsApi | delete_notification | DELETE /notifications/{id} | Delete a notification |
| NotificationsApi | delete_notifications | DELETE /notifications | Delete notifications |
| NotificationsApi | get_notification | GET /notifications/{id} | Get a notification |
| NotificationsApi | get_notifications | GET /notifications | Retrieve notifications |
| NotificationsApi | update_notification | PUT /notifications/{id} | Update a notification |
| NotificationsApi | update_notifications | PUT /notifications | Update notifications |
| NotificationsAdminApi | create_notification | POST /admin/notifications | Create a notification |
| NotificationsAdminApi | get_notification_template_admin | POST /admin/notifications/templates/{name} | Render email template |
| NotificationsAdminApi | send_test_email_admin | POST /admin/notifications/test-email | Send test email |
| PartnersApi | create_partner | POST /partners | Create a partner |
| PartnersApi | create_partner_deprecated | POST /partners/{id} | Create a partner |
| PartnersApi | get_partners | GET /partners | Retrieve partners |
| PartnersApi | remove_partner | DELETE /partners/{id} | Remove a partner |
| PartnersApi | update_partner | PUT /partners/{id} | Update a partner |
| PeopleApi | create_person | POST /people | Create a person |
| PeopleApi | delete_people | DELETE /people | Delete people |
| PeopleApi | delete_person | DELETE /people/{id} | Delete person |
| PeopleApi | get_all_people | GET /people | Get all people |
| PeopleApi | get_person | GET /people/{id} | Get a person |
| PeopleApi | get_person_statistics | GET /people/{id}/statistics | Get person statistics |
| PeopleApi | get_person_thumbnail | GET /people/{id}/thumbnail | Get person thumbnail |
| PeopleApi | merge_person | POST /people/{id}/merge | Merge people |
| PeopleApi | reassign_faces | PUT /people/{id}/reassign | Reassign faces |
| PeopleApi | update_people | PUT /people | Update people |
| PeopleApi | update_person | PUT /people/{id} | Update person |
| PluginsApi | get_plugin | GET /plugins/{id} | Retrieve a plugin |
| PluginsApi | search_plugin_methods | GET /plugins/methods | Retrieve plugin methods |
| PluginsApi | search_plugin_templates | GET /plugins/templates | Retrieve workflow templates |
| PluginsApi | search_plugins | GET /plugins | List all plugins |
| QueuesApi | empty_queue | DELETE /queues/{name}/jobs | Empty a queue |
| QueuesApi | get_queue | GET /queues/{name} | Retrieve a queue |
| QueuesApi | get_queue_jobs | GET /queues/{name}/jobs | Retrieve queue jobs |
| QueuesApi | get_queues | GET /queues | List all queues |
| QueuesApi | update_queue | PUT /queues/{name} | Update a queue |
| SearchApi | get_assets_by_city | GET /search/cities | Retrieve assets by city |
| SearchApi | get_explore_data | GET /search/explore | Retrieve explore data |
| SearchApi | get_search_suggestions | GET /search/suggestions | Retrieve search suggestions |
| SearchApi | search_asset_statistics | POST /search/statistics | Search asset statistics |
| SearchApi | search_assets | POST /search/metadata | Search assets by metadata |
| SearchApi | search_large_assets | POST /search/large-assets | Search large assets |
| SearchApi | search_person | GET /search/person | Search people |
| SearchApi | search_places | GET /search/places | Search places |
| SearchApi | search_random | POST /search/random | Search random assets |
| SearchApi | search_smart | POST /search/smart | Smart asset search |
| ServerApi | delete_server_license | DELETE /server/license | Delete server product key |
| ServerApi | get_about_info | GET /server/about | Get server information |
| ServerApi | get_apk_links | GET /server/apk-links | Get APK links |
| ServerApi | get_server_config | GET /server/config | Get config |
| ServerApi | get_server_features | GET /server/features | Get features |
| ServerApi | get_server_license | GET /server/license | Get product key |
| ServerApi | get_server_statistics | GET /server/statistics | Get statistics |
| ServerApi | get_server_version | GET /server/version | Get server version |
| ServerApi | get_storage | GET /server/storage | Get storage |
| ServerApi | get_supported_media_types | GET /server/media-types | Get supported media types |
| ServerApi | get_version_check | GET /server/version-check | Get version check status |
| ServerApi | get_version_history | GET /server/version-history | Get version history |
| ServerApi | ping_server | GET /server/ping | Ping |
| ServerApi | set_server_license | PUT /server/license | Set server product key |
| SessionsApi | create_session | POST /sessions | Create a session |
| SessionsApi | delete_all_sessions | DELETE /sessions | Delete all sessions |
| SessionsApi | delete_session | DELETE /sessions/{id} | Delete a session |
| SessionsApi | get_sessions | GET /sessions | Retrieve sessions |
| SessionsApi | lock_session | POST /sessions/{id}/lock | Lock a session |
| SessionsApi | update_session | PUT /sessions/{id} | Update a session |
| SharedLinksApi | add_shared_link_assets | PUT /shared-links/{id}/assets | Add assets to a shared link |
| SharedLinksApi | create_shared_link | POST /shared-links | Create a shared link |
| SharedLinksApi | get_all_shared_links | GET /shared-links | Retrieve all shared links |
| SharedLinksApi | get_my_shared_link | GET /shared-links/me | Retrieve current shared link |
| SharedLinksApi | get_shared_link_by_id | GET /shared-links/{id} | Retrieve a shared link |
| SharedLinksApi | remove_shared_link | DELETE /shared-links/{id} | Delete a shared link |
| SharedLinksApi | remove_shared_link_assets | DELETE /shared-links/{id}/assets | Remove assets from a shared link |
| SharedLinksApi | shared_link_login | POST /shared-links/login | Shared link login |
| SharedLinksApi | update_shared_link | PATCH /shared-links/{id} | Update a shared link |
| StacksApi | create_stack | POST /stacks | Create a stack |
| StacksApi | delete_stack | DELETE /stacks/{id} | Delete a stack |
| StacksApi | delete_stacks | DELETE /stacks | Delete stacks |
| StacksApi | get_stack | GET /stacks/{id} | Retrieve a stack |
| StacksApi | remove_asset_from_stack | DELETE /stacks/{id}/assets/{assetId} | Remove an asset from a stack |
| StacksApi | search_stacks | GET /stacks | Retrieve stacks |
| StacksApi | update_stack | PUT /stacks/{id} | Update a stack |
| SyncApi | delete_sync_ack | DELETE /sync/ack | Delete acknowledgements |
| SyncApi | get_sync_ack | GET /sync/ack | Retrieve acknowledgements |
| SyncApi | get_sync_stream | POST /sync/stream | Stream sync changes |
| SyncApi | send_sync_ack | POST /sync/ack | Acknowledge changes |
| SystemConfigApi | get_config | GET /system-config | Get system configuration |
| SystemConfigApi | get_config_defaults | GET /system-config/defaults | Get system configuration defaults |
| SystemConfigApi | get_storage_template_options | GET /system-config/storage-template-options | Get storage template options |
| SystemConfigApi | update_config | PUT /system-config | Update system configuration |
| SystemMetadataApi | get_admin_onboarding | GET /system-metadata/admin-onboarding | Retrieve admin onboarding |
| SystemMetadataApi | get_reverse_geocoding_state | GET /system-metadata/reverse-geocoding-state | Retrieve reverse geocoding state |
| SystemMetadataApi | get_version_check_state | GET /system-metadata/version-check-state | Retrieve version check state |
| SystemMetadataApi | update_admin_onboarding | POST /system-metadata/admin-onboarding | Update admin onboarding |
| TagsApi | bulk_tag_assets | PUT /tags/assets | Tag assets |
| TagsApi | create_tag | POST /tags | Create a tag |
| TagsApi | delete_tag | DELETE /tags/{id} | Delete a tag |
| TagsApi | get_all_tags | GET /tags | Retrieve tags |
| TagsApi | get_tag_by_id | GET /tags/{id} | Retrieve a tag |
| TagsApi | tag_assets | PUT /tags/{id}/assets | Tag assets |
| TagsApi | untag_assets | DELETE /tags/{id}/assets | Untag assets |
| TagsApi | update_tag | PUT /tags/{id} | Update a tag |
| TagsApi | upsert_tags | PUT /tags | Upsert tags |
| TimelineApi | get_time_bucket | GET /timeline/bucket | Get time bucket |
| TimelineApi | get_time_buckets | GET /timeline/buckets | Get time buckets |
| TrashApi | empty_trash | POST /trash/empty | Empty trash |
| TrashApi | restore_assets | POST /trash/restore/assets | Restore assets |
| TrashApi | restore_trash | POST /trash/restore | Restore trash |
| UsersApi | create_profile_image | POST /users/profile-image | Create user profile image |
| UsersApi | delete_profile_image | DELETE /users/profile-image | Delete user profile image |
| UsersApi | delete_user_license | DELETE /users/me/license | Delete user product key |
| UsersApi | delete_user_onboarding | DELETE /users/me/onboarding | Delete user onboarding |
| UsersApi | get_my_calendar_heatmap | GET /users/me/calendar-heatmap | Retrieve calendar heatmap activity |
| UsersApi | get_my_preferences | GET /users/me/preferences | Get my preferences |
| UsersApi | get_my_user | GET /users/me | Get current user |
| UsersApi | get_profile_image | GET /users/{id}/profile-image | Retrieve user profile image |
| UsersApi | get_user | GET /users/{id} | Retrieve a user |
| UsersApi | get_user_license | GET /users/me/license | Retrieve user product key |
| UsersApi | get_user_onboarding | GET /users/me/onboarding | Retrieve user onboarding |
| UsersApi | search_users | GET /users | Get all users |
| UsersApi | set_user_license | PUT /users/me/license | Set user product key |
| UsersApi | set_user_onboarding | PUT /users/me/onboarding | Update user onboarding |
| UsersApi | update_my_preferences | PUT /users/me/preferences | Update my preferences |
| UsersApi | update_my_user | PUT /users/me | Update current user |
| UsersAdminApi | create_user_admin | POST /admin/users | Create a user |
| UsersAdminApi | delete_user_admin | DELETE /admin/users/{id} | Delete a user |
| UsersAdminApi | get_user_admin | GET /admin/users/{id} | Retrieve a user |
| UsersAdminApi | get_user_calendar_heatmap_admin | GET /admin/users/{id}/calendar-heatmap | Retrieve calendar heatmap activity |
| UsersAdminApi | get_user_preferences_admin | GET /admin/users/{id}/preferences | Retrieve user preferences |
| UsersAdminApi | get_user_sessions_admin | GET /admin/users/{id}/sessions | Retrieve user sessions |
| UsersAdminApi | get_user_statistics_admin | GET /admin/users/{id}/statistics | Retrieve user statistics |
| UsersAdminApi | restore_user_admin | POST /admin/users/{id}/restore | Restore a deleted user |
| UsersAdminApi | search_users_admin | GET /admin/users | Search users |
| UsersAdminApi | update_user_admin | PUT /admin/users/{id} | Update a user |
| UsersAdminApi | update_user_preferences_admin | PUT /admin/users/{id}/preferences | Update user preferences |
| ViewsApi | get_assets_by_original_path | GET /view/folder | Retrieve assets by original path |
| ViewsApi | get_unique_original_paths | GET /view/folder/unique-paths | Retrieve unique paths |
| WorkflowsApi | create_workflow | POST /workflows | Create a workflow |
| WorkflowsApi | delete_workflow | DELETE /workflows/{id} | Delete a workflow |
| WorkflowsApi | get_workflow | GET /workflows/{id} | Retrieve a workflow |
| WorkflowsApi | get_workflow_for_share | GET /workflows/{id}/share | Retrieve a workflow |
| WorkflowsApi | get_workflow_triggers | GET /workflows/triggers | List all workflow triggers |
| WorkflowsApi | search_workflows | GET /workflows | List all workflows |
| WorkflowsApi | update_workflow | PUT /workflows/{id} | Update a workflow |
Documentation For Models
- ActivityCreateDto
- ActivityResponseDto
- ActivityStatisticsResponseDto
- AddUsersDto
- AdminOnboardingUpdateDto
- AlbumResponseDto
- AlbumStatisticsResponseDto
- AlbumUserAddDto
- AlbumUserCreateDto
- AlbumUserResponseDto
- AlbumUserRole
- AlbumsAddAssetsDto
- AlbumsAddAssetsResponseDto
- AlbumsResponse
- AlbumsUpdate
- ApiKeyCreateDto
- ApiKeyCreateResponseDto
- ApiKeyResponseDto
- ApiKeyUpdateDto
- AssetBulkDeleteDto
- AssetBulkUpdateDto
- AssetBulkUploadCheckDto
- AssetBulkUploadCheckItem
- AssetBulkUploadCheckResponseDto
- AssetBulkUploadCheckResult
- AssetCopyDto
- AssetEditAction
- AssetEditActionItemDto
- AssetEditActionItemDtoParameters
- AssetEditActionItemResponseDto
- AssetEditsCreateDto
- AssetEditsResponseDto
- AssetFaceCreateDto
- AssetFaceDeleteDto
- AssetFaceResponseDto
- AssetFaceUpdateDto
- AssetFaceUpdateItem
- AssetIdErrorReason
- AssetIdsDto
- AssetIdsResponseDto
- AssetJobName
- AssetJobsDto
- AssetMediaResponseDto
- AssetMediaSize
- AssetMediaStatus
- AssetMetadataBulkDeleteDto
- AssetMetadataBulkDeleteItemDto
- AssetMetadataBulkResponseDto
- AssetMetadataBulkUpsertDto
- AssetMetadataBulkUpsertItemDto
- AssetMetadataResponseDto
- AssetMetadataUpsertDto
- AssetMetadataUpsertItemDto
- AssetOcrResponseDto
- AssetOrder
- AssetOrderBy
- AssetRejectReason
- AssetResponseDto
- AssetStackResponseDto
- AssetStatsResponseDto
- AssetTypeEnum
- AssetUploadAction
- AssetVisibility
- AudioCodec
- AuthStatusResponseDto
- AvatarUpdate
- BulkIdErrorReason
- BulkIdResponseDto
- BulkIdsDto
- CLIPConfig
- CQMode
- CalendarHeatmapResponseDto
- CalendarHeatmapResponseDtoSeriesInner
- CalendarHeatmapType
- CastResponse
- CastUpdate
- ChangePasswordDto
- Colorspace
- ContributorCountResponseDto
- CreateAlbumDto
- CreateLibraryDto
- CreateProfileImageResponseDto
- CropParameters
- DatabaseBackupConfig
- DatabaseBackupDeleteDto
- DatabaseBackupDto
- DatabaseBackupListResponseDto
- DownloadArchiveDto
- DownloadArchiveInfo
- DownloadInfoDto
- DownloadResponse
- DownloadResponseDto
- DownloadUpdate
- DuplicateDetectionConfig
- DuplicateResolveDto
- DuplicateResolveGroupDto
- DuplicateResponseDto
- EmailNotificationsResponse
- EmailNotificationsUpdate
- ExifResponseDto
- FaceDto
- FacialRecognitionConfig
- FoldersResponse
- FoldersUpdate
- ImageFormat
- IntegrityReport
- IntegrityReportResponseDto
- IntegrityReportResponseDtoItemsInner
- IntegrityReportSummaryResponseDto
- JobCreateDto
- JobName
- JobSettingsDto
- LibraryResponseDto
- LibraryStatsResponseDto
- LicenseKeyDto
- LogLevel
- LoginCredentialDto
- LoginResponseDto
- LogoutResponseDto
- MachineLearningAvailabilityChecksDto
- MaintenanceAction
- MaintenanceAuthDto
- MaintenanceDetectInstallResponseDto
- MaintenanceDetectInstallStorageFolderDto
- MaintenanceLoginDto
- MaintenanceStatusResponseDto
- ManualJobName
- MapMarkerResponseDto
- MapReverseGeocodeResponseDto
- MemoriesResponse
- MemoriesUpdate
- MemoryCreateDto
- MemoryResponseDto
- MemorySearchOrder
- MemoryStatisticsResponseDto
- MemoryType
- MemoryUpdateDto
- MergePersonDto
- MetadataSearchDto
- MirrorAxis
- MirrorParameters
- NotificationCreateDto
- NotificationDeleteAllDto
- NotificationDto
- NotificationLevel
- NotificationType
- NotificationUpdateAllDto
- NotificationUpdateDto
- OAuthAuthorizeResponseDto
- OAuthCallbackDto
- OAuthConfigDto
- OAuthTokenEndpointAuthMethod
- OcrConfig
- OnThisDayDto
- OnboardingDto
- OnboardingResponseDto
- PartnerCreateDto
- PartnerDirection
- PartnerResponseDto
- PartnerUpdateDto
- PeopleResponse
- PeopleResponseDto
- PeopleUpdate
- PeopleUpdateDto
- PeopleUpdateItem
- Permission
- PersonCreateDto
- PersonResponseDto
- PersonStatisticsResponseDto
- PersonUpdateDto
- PinCodeChangeDto
- PinCodeResetDto
- PinCodeSetupDto
- PlacesResponseDto
- PluginMethodResponseDto
- PluginResponseDto
- PluginTemplateResponseDto
- PluginTemplateStepResponseDto
- PurchaseResponse
- PurchaseUpdate
- QueueCommand
- QueueCommandDto
- QueueDeleteDto
- QueueJobResponseDto
- QueueJobStatus
- QueueName
- QueueResponseDto
- QueueResponseLegacyDto
- QueueStatisticsDto
- QueueStatusLegacyDto
- QueueUpdateDto
- QueuesResponseLegacyDto
- RandomSearchDto
- RatingsResponse
- RatingsUpdate
- ReactionLevel
- ReactionType
- RecentlyAddedResponse
- RecentlyAddedUpdate
- ReleaseChannel
- ReleaseEventV1
- ReleaseType
- ReverseGeocodingStateResponseDto
- RotateParameters
- SearchAlbumResponseDto
- SearchAssetResponseDto
- SearchExploreItem
- SearchExploreResponseDto
- SearchFacetCountResponseDto
- SearchFacetResponseDto
- SearchResponseDto
- SearchStatisticsResponseDto
- SearchSuggestionType
- ServerAboutResponseDto
- ServerApkLinksDto
- ServerConfigDto
- ServerFeaturesDto
- ServerMediaTypesResponseDto
- ServerPingResponse
- ServerStatsResponseDto
- ServerStorageResponseDto
- ServerVersionHistoryResponseDto
- ServerVersionResponseDto
- SessionCreateDto
- SessionCreateResponseDto
- SessionResponseDto
- SessionUnlockDto
- SessionUpdateDto
- SetMaintenanceModeDto
- SharedLinkCreateDto
- SharedLinkEditDto
- SharedLinkLoginDto
- SharedLinkResponseDto
- SharedLinkType
- SharedLinksResponse
- SharedLinksUpdate
- SignUpDto
- SmartSearchDto
- SourceType
- StackCreateDto
- StackResponseDto
- StackUpdateDto
- StatisticsSearchDto
- StorageFolder
- SyncAckDeleteDto
- SyncAckDto
- SyncAckSetDto
- SyncAlbumDeleteV1
- SyncAlbumToAssetDeleteV1
- SyncAlbumToAssetV1
- SyncAlbumUserDeleteV1
- SyncAlbumUserV1
- SyncAlbumV1
- SyncAlbumV2
- SyncAssetDeleteV1
- SyncAssetEditDeleteV1
- SyncAssetEditV1
- SyncAssetExifV1
- SyncAssetFaceDeleteV1
- SyncAssetFaceV1
- SyncAssetFaceV2
- SyncAssetMetadataDeleteV1
- SyncAssetMetadataV1
- SyncAssetOcrDeleteV1
- SyncAssetOcrV1
- SyncAssetV1
- SyncAssetV2
- SyncAuthUserV1
- SyncEntityType
- SyncMemoryAssetDeleteV1
- SyncMemoryAssetV1
- SyncMemoryDeleteV1
- SyncMemoryV1
- SyncPartnerDeleteV1
- SyncPartnerV1
- SyncPersonDeleteV1
- SyncPersonV1
- SyncRequestType
- SyncStackDeleteV1
- SyncStackV1
- SyncStreamDto
- SyncUserDeleteV1
- SyncUserMetadataDeleteV1
- SyncUserMetadataV1
- SyncUserV1
- SystemConfigBackupsDto
- SystemConfigDto
- SystemConfigFFmpegDto
- SystemConfigFFmpegRealtimeDto
- SystemConfigFacesDto
- SystemConfigGeneratedFullsizeImageDto
- SystemConfigGeneratedImageDto
- SystemConfigImageDto
- SystemConfigIntegrityChecks
- SystemConfigIntegrityChecksumJob
- SystemConfigIntegrityJob
- SystemConfigJobDto
- SystemConfigLibraryDto
- SystemConfigLibraryScanDto
- SystemConfigLibraryWatchDto
- SystemConfigLoggingDto
- SystemConfigMachineLearningDto
- SystemConfigMapDto
- SystemConfigMetadataDto
- SystemConfigNewVersionCheckDto
- SystemConfigNightlyTasksDto
- SystemConfigNotificationsDto
- SystemConfigOAuthDto
- SystemConfigPasswordLoginDto
- SystemConfigReverseGeocodingDto
- SystemConfigServerDto
- SystemConfigSmtpDto
- SystemConfigSmtpTransportDto
- SystemConfigStorageTemplateDto
- SystemConfigTemplateEmailsDto
- SystemConfigTemplateStorageOptionDto
- SystemConfigTemplatesDto
- SystemConfigThemeDto
- SystemConfigTrashDto
- SystemConfigUserDto
- TagBulkAssetsDto
- TagBulkAssetsResponseDto
- TagCreateDto
- TagResponseDto
- TagUpdateDto
- TagUpsertDto
- TagsResponse
- TagsUpdate
- TemplateDto
- TemplateResponseDto
- TestEmailResponseDto
- TimeBucketAssetResponseDto
- TimeBucketsResponseDto
- ToneMapping
- TranscodeHWAccel
- TranscodePolicy
- TrashResponseDto
- UpdateAlbumDto
- UpdateAlbumUserDto
- UpdateAssetDto
- UpdateLibraryDto
- UsageByUserDto
- UserAdminCreateDto
- UserAdminDeleteDto
- UserAdminResponseDto
- UserAdminUpdateDto
- UserAvatarColor
- UserLicense
- UserMetadataKey
- UserPreferencesResponseDto
- UserPreferencesUpdateDto
- UserResponseDto
- UserStatus
- UserUpdateMeDto
- ValidateAccessTokenResponseDto
- ValidateLibraryDto
- ValidateLibraryImportPathResponseDto
- ValidateLibraryResponseDto
- VersionCheckStateResponseDto
- VideoCodec
- VideoContainer
- WorkflowCreateDto
- WorkflowResponseDto
- WorkflowShareResponseDto
- WorkflowShareStepDto
- WorkflowStepDto
- WorkflowTrigger
- WorkflowTriggerResponseDto
- WorkflowType
- WorkflowUpdateDto
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