Back to Immich

openapi

mobile/openapi/README.md

2.7.551.9 KB
Original Source

openapi

Immich API

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

  • API version: 2.7.5
  • Generator version: 7.8.0
  • Build package: org.openapitools.codegen.languages.DartClientCodegen

Requirements

Dart 2.12 or later

Installation & Usage

Github

If this Dart package is published to Github, add the following dependency to your pubspec.yaml

dependencies:
  openapi:
    git: https://github.com/GIT_USER_ID/GIT_REPO_ID.git

Local

To use the package in your local drive, add the following dependency to your pubspec.yaml

dependencies:
  openapi:
    path: /path/to/openapi

Tests

TODO

Getting Started

Please follow the installation procedure and then run the following:

dart
import 'package:openapi/api.dart';

// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKeyPrefix = 'Bearer';
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearer').setAccessToken(yourTokenGeneratorFunction);

final api_instance = APIKeysApi();
final aPIKeyCreateDto = APIKeyCreateDto(); // APIKeyCreateDto | 

try {
    final result = api_instance.createApiKey(aPIKeyCreateDto);
    print(result);
} catch (e) {
    print('Exception when calling APIKeysApi->createApiKey: $e\n');
}

Documentation for API Endpoints

All URIs are relative to /api

ClassMethodHTTP requestDescription
APIKeysApicreateApiKeyPOST /api-keysCreate an API key
APIKeysApideleteApiKeyDELETE /api-keys/{id}Delete an API key
APIKeysApigetApiKeyGET /api-keys/{id}Retrieve an API key
APIKeysApigetApiKeysGET /api-keysList all API keys
APIKeysApigetMyApiKeyGET /api-keys/meRetrieve the current API key
APIKeysApiupdateApiKeyPUT /api-keys/{id}Update an API key
ActivitiesApicreateActivityPOST /activitiesCreate an activity
ActivitiesApideleteActivityDELETE /activities/{id}Delete an activity
ActivitiesApigetActivitiesGET /activitiesList all activities
ActivitiesApigetActivityStatisticsGET /activities/statisticsRetrieve activity statistics
AlbumsApiaddAssetsToAlbumPUT /albums/{id}/assetsAdd assets to an album
AlbumsApiaddAssetsToAlbumsPUT /albums/assetsAdd assets to albums
AlbumsApiaddUsersToAlbumPUT /albums/{id}/usersShare album with users
AlbumsApicreateAlbumPOST /albumsCreate an album
AlbumsApideleteAlbumDELETE /albums/{id}Delete an album
AlbumsApigetAlbumInfoGET /albums/{id}Retrieve an album
AlbumsApigetAlbumStatisticsGET /albums/statisticsRetrieve album statistics
AlbumsApigetAllAlbumsGET /albumsList all albums
AlbumsApiremoveAssetFromAlbumDELETE /albums/{id}/assetsRemove assets from an album
AlbumsApiremoveUserFromAlbumDELETE /albums/{id}/user/{userId}Remove user from album
AlbumsApiupdateAlbumInfoPATCH /albums/{id}Update an album
AlbumsApiupdateAlbumUserPUT /albums/{id}/user/{userId}Update user role
AssetsApicheckBulkUploadPOST /assets/bulk-upload-checkCheck bulk upload
AssetsApicheckExistingAssetsPOST /assets/existCheck existing assets
AssetsApicopyAssetPUT /assets/copyCopy asset
AssetsApideleteAssetMetadataDELETE /assets/{id}/metadata/{key}Delete asset metadata by key
AssetsApideleteAssetsDELETE /assetsDelete assets
AssetsApideleteBulkAssetMetadataDELETE /assets/metadataDelete asset metadata
AssetsApidownloadAssetGET /assets/{id}/originalDownload original asset
AssetsApieditAssetPUT /assets/{id}/editsApply edits to an existing asset
AssetsApigetAllUserAssetsByDeviceIdGET /assets/device/{deviceId}Retrieve assets by device ID
AssetsApigetAssetEditsGET /assets/{id}/editsRetrieve edits for an existing asset
AssetsApigetAssetInfoGET /assets/{id}Retrieve an asset
AssetsApigetAssetMetadataGET /assets/{id}/metadataGet asset metadata
AssetsApigetAssetMetadataByKeyGET /assets/{id}/metadata/{key}Retrieve asset metadata by key
AssetsApigetAssetOcrGET /assets/{id}/ocrRetrieve asset OCR data
AssetsApigetAssetStatisticsGET /assets/statisticsGet asset statistics
AssetsApigetRandomGET /assets/randomGet random assets
AssetsApiplayAssetVideoGET /assets/{id}/video/playbackPlay asset video
AssetsApiremoveAssetEditsDELETE /assets/{id}/editsRemove edits from an existing asset
AssetsApireplaceAssetPUT /assets/{id}/originalReplace asset
AssetsApirunAssetJobsPOST /assets/jobsRun an asset job
AssetsApiupdateAssetPUT /assets/{id}Update an asset
AssetsApiupdateAssetMetadataPUT /assets/{id}/metadataUpdate asset metadata
AssetsApiupdateAssetsPUT /assetsUpdate assets
AssetsApiupdateBulkAssetMetadataPUT /assets/metadataUpsert asset metadata
AssetsApiuploadAssetPOST /assetsUpload asset
AssetsApiviewAssetGET /assets/{id}/thumbnailView asset thumbnail
AuthenticationApichangePasswordPOST /auth/change-passwordChange password
AuthenticationApichangePinCodePUT /auth/pin-codeChange pin code
AuthenticationApifinishOAuthPOST /oauth/callbackFinish OAuth
AuthenticationApigetAuthStatusGET /auth/statusRetrieve auth status
AuthenticationApilinkOAuthAccountPOST /oauth/linkLink OAuth account
AuthenticationApilockAuthSessionPOST /auth/session/lockLock auth session
AuthenticationApiloginPOST /auth/loginLogin
AuthenticationApilogoutPOST /auth/logoutLogout
AuthenticationApiredirectOAuthToMobileGET /oauth/mobile-redirectRedirect OAuth to mobile
AuthenticationApiresetPinCodeDELETE /auth/pin-codeReset pin code
AuthenticationApisetupPinCodePOST /auth/pin-codeSetup pin code
AuthenticationApisignUpAdminPOST /auth/admin-sign-upRegister admin
AuthenticationApistartOAuthPOST /oauth/authorizeStart OAuth
AuthenticationApiunlinkOAuthAccountPOST /oauth/unlinkUnlink OAuth account
AuthenticationApiunlockAuthSessionPOST /auth/session/unlockUnlock auth session
AuthenticationApivalidateAccessTokenPOST /auth/validateTokenValidate access token
AuthenticationAdminApiunlinkAllOAuthAccountsAdminPOST /admin/auth/unlink-allUnlink all OAuth accounts
DatabaseBackupsAdminApideleteDatabaseBackupDELETE /admin/database-backupsDelete database backup
DatabaseBackupsAdminApidownloadDatabaseBackupGET /admin/database-backups/{filename}Download database backup
DatabaseBackupsAdminApilistDatabaseBackupsGET /admin/database-backupsList database backups
DatabaseBackupsAdminApistartDatabaseRestoreFlowPOST /admin/database-backups/start-restoreStart database backup restore flow
DatabaseBackupsAdminApiuploadDatabaseBackupPOST /admin/database-backups/uploadUpload database backup
DeprecatedApicreatePartnerDeprecatedPOST /partners/{id}Create a partner
DeprecatedApigetAllUserAssetsByDeviceIdGET /assets/device/{deviceId}Retrieve assets by device ID
DeprecatedApigetDeltaSyncPOST /sync/delta-syncGet delta sync for user
DeprecatedApigetFullSyncForUserPOST /sync/full-syncGet full sync for user
DeprecatedApigetQueuesLegacyGET /jobsRetrieve queue counts and status
DeprecatedApigetRandomGET /assets/randomGet random assets
DeprecatedApireplaceAssetPUT /assets/{id}/originalReplace asset
DeprecatedApirunQueueCommandLegacyPUT /jobs/{name}Run jobs
DownloadApidownloadArchivePOST /download/archiveDownload asset archive
DownloadApigetDownloadInfoPOST /download/infoRetrieve download information
DuplicatesApideleteDuplicateDELETE /duplicates/{id}Delete a duplicate
DuplicatesApideleteDuplicatesDELETE /duplicatesDelete duplicates
DuplicatesApigetAssetDuplicatesGET /duplicatesRetrieve duplicates
DuplicatesApiresolveDuplicatesPOST /duplicates/resolveResolve duplicate groups
FacesApicreateFacePOST /facesCreate a face
FacesApideleteFaceDELETE /faces/{id}Delete a face
FacesApigetFacesGET /facesRetrieve faces for asset
FacesApireassignFacesByIdPUT /faces/{id}Re-assign a face to another person
JobsApicreateJobPOST /jobsCreate a manual job
JobsApigetQueuesLegacyGET /jobsRetrieve queue counts and status
JobsApirunQueueCommandLegacyPUT /jobs/{name}Run jobs
LibrariesApicreateLibraryPOST /librariesCreate a library
LibrariesApideleteLibraryDELETE /libraries/{id}Delete a library
LibrariesApigetAllLibrariesGET /librariesRetrieve libraries
LibrariesApigetLibraryGET /libraries/{id}Retrieve a library
LibrariesApigetLibraryStatisticsGET /libraries/{id}/statisticsRetrieve library statistics
LibrariesApiscanLibraryPOST /libraries/{id}/scanScan a library
LibrariesApiupdateLibraryPUT /libraries/{id}Update a library
LibrariesApivalidatePOST /libraries/{id}/validateValidate library settings
MaintenanceAdminApidetectPriorInstallGET /admin/maintenance/detect-installDetect existing install
MaintenanceAdminApigetMaintenanceStatusGET /admin/maintenance/statusGet maintenance mode status
MaintenanceAdminApimaintenanceLoginPOST /admin/maintenance/loginLog into maintenance mode
MaintenanceAdminApisetMaintenanceModePOST /admin/maintenanceSet maintenance mode
MapApigetMapMarkersGET /map/markersRetrieve map markers
MapApireverseGeocodeGET /map/reverse-geocodeReverse geocode coordinates
MemoriesApiaddMemoryAssetsPUT /memories/{id}/assetsAdd assets to a memory
MemoriesApicreateMemoryPOST /memoriesCreate a memory
MemoriesApideleteMemoryDELETE /memories/{id}Delete a memory
MemoriesApigetMemoryGET /memories/{id}Retrieve a memory
MemoriesApimemoriesStatisticsGET /memories/statisticsRetrieve memories statistics
MemoriesApiremoveMemoryAssetsDELETE /memories/{id}/assetsRemove assets from a memory
MemoriesApisearchMemoriesGET /memoriesRetrieve memories
MemoriesApiupdateMemoryPUT /memories/{id}Update a memory
NotificationsApideleteNotificationDELETE /notifications/{id}Delete a notification
NotificationsApideleteNotificationsDELETE /notificationsDelete notifications
NotificationsApigetNotificationGET /notifications/{id}Get a notification
NotificationsApigetNotificationsGET /notificationsRetrieve notifications
NotificationsApiupdateNotificationPUT /notifications/{id}Update a notification
NotificationsApiupdateNotificationsPUT /notificationsUpdate notifications
NotificationsAdminApicreateNotificationPOST /admin/notificationsCreate a notification
NotificationsAdminApigetNotificationTemplateAdminPOST /admin/notifications/templates/{name}Render email template
NotificationsAdminApisendTestEmailAdminPOST /admin/notifications/test-emailSend test email
PartnersApicreatePartnerPOST /partnersCreate a partner
PartnersApicreatePartnerDeprecatedPOST /partners/{id}Create a partner
PartnersApigetPartnersGET /partnersRetrieve partners
PartnersApiremovePartnerDELETE /partners/{id}Remove a partner
PartnersApiupdatePartnerPUT /partners/{id}Update a partner
PeopleApicreatePersonPOST /peopleCreate a person
PeopleApideletePeopleDELETE /peopleDelete people
PeopleApideletePersonDELETE /people/{id}Delete person
PeopleApigetAllPeopleGET /peopleGet all people
PeopleApigetPersonGET /people/{id}Get a person
PeopleApigetPersonStatisticsGET /people/{id}/statisticsGet person statistics
PeopleApigetPersonThumbnailGET /people/{id}/thumbnailGet person thumbnail
PeopleApimergePersonPOST /people/{id}/mergeMerge people
PeopleApireassignFacesPUT /people/{id}/reassignReassign faces
PeopleApiupdatePeoplePUT /peopleUpdate people
PeopleApiupdatePersonPUT /people/{id}Update person
PluginsApigetPluginGET /plugins/{id}Retrieve a plugin
PluginsApigetPluginTriggersGET /plugins/triggersList all plugin triggers
PluginsApigetPluginsGET /pluginsList all plugins
QueuesApiemptyQueueDELETE /queues/{name}/jobsEmpty a queue
QueuesApigetQueueGET /queues/{name}Retrieve a queue
QueuesApigetQueueJobsGET /queues/{name}/jobsRetrieve queue jobs
QueuesApigetQueuesGET /queuesList all queues
QueuesApiupdateQueuePUT /queues/{name}Update a queue
SearchApigetAssetsByCityGET /search/citiesRetrieve assets by city
SearchApigetExploreDataGET /search/exploreRetrieve explore data
SearchApigetSearchSuggestionsGET /search/suggestionsRetrieve search suggestions
SearchApisearchAssetStatisticsPOST /search/statisticsSearch asset statistics
SearchApisearchAssetsPOST /search/metadataSearch assets by metadata
SearchApisearchLargeAssetsPOST /search/large-assetsSearch large assets
SearchApisearchPersonGET /search/personSearch people
SearchApisearchPlacesGET /search/placesSearch places
SearchApisearchRandomPOST /search/randomSearch random assets
SearchApisearchSmartPOST /search/smartSmart asset search
ServerApideleteServerLicenseDELETE /server/licenseDelete server product key
ServerApigetAboutInfoGET /server/aboutGet server information
ServerApigetApkLinksGET /server/apk-linksGet APK links
ServerApigetServerConfigGET /server/configGet config
ServerApigetServerFeaturesGET /server/featuresGet features
ServerApigetServerLicenseGET /server/licenseGet product key
ServerApigetServerStatisticsGET /server/statisticsGet statistics
ServerApigetServerVersionGET /server/versionGet server version
ServerApigetStorageGET /server/storageGet storage
ServerApigetSupportedMediaTypesGET /server/media-typesGet supported media types
ServerApigetThemeGET /server/themeGet theme
ServerApigetVersionCheckGET /server/version-checkGet version check status
ServerApigetVersionHistoryGET /server/version-historyGet version history
ServerApipingServerGET /server/pingPing
ServerApisetServerLicensePUT /server/licenseSet server product key
SessionsApicreateSessionPOST /sessionsCreate a session
SessionsApideleteAllSessionsDELETE /sessionsDelete all sessions
SessionsApideleteSessionDELETE /sessions/{id}Delete a session
SessionsApigetSessionsGET /sessionsRetrieve sessions
SessionsApilockSessionPOST /sessions/{id}/lockLock a session
SessionsApiupdateSessionPUT /sessions/{id}Update a session
SharedLinksApiaddSharedLinkAssetsPUT /shared-links/{id}/assetsAdd assets to a shared link
SharedLinksApicreateSharedLinkPOST /shared-linksCreate a shared link
SharedLinksApigetAllSharedLinksGET /shared-linksRetrieve all shared links
SharedLinksApigetMySharedLinkGET /shared-links/meRetrieve current shared link
SharedLinksApigetSharedLinkByIdGET /shared-links/{id}Retrieve a shared link
SharedLinksApiremoveSharedLinkDELETE /shared-links/{id}Delete a shared link
SharedLinksApiremoveSharedLinkAssetsDELETE /shared-links/{id}/assetsRemove assets from a shared link
SharedLinksApisharedLinkLoginPOST /shared-links/loginShared link login
SharedLinksApiupdateSharedLinkPATCH /shared-links/{id}Update a shared link
StacksApicreateStackPOST /stacksCreate a stack
StacksApideleteStackDELETE /stacks/{id}Delete a stack
StacksApideleteStacksDELETE /stacksDelete stacks
StacksApigetStackGET /stacks/{id}Retrieve a stack
StacksApiremoveAssetFromStackDELETE /stacks/{id}/assets/{assetId}Remove an asset from a stack
StacksApisearchStacksGET /stacksRetrieve stacks
StacksApiupdateStackPUT /stacks/{id}Update a stack
SyncApideleteSyncAckDELETE /sync/ackDelete acknowledgements
SyncApigetDeltaSyncPOST /sync/delta-syncGet delta sync for user
SyncApigetFullSyncForUserPOST /sync/full-syncGet full sync for user
SyncApigetSyncAckGET /sync/ackRetrieve acknowledgements
SyncApigetSyncStreamPOST /sync/streamStream sync changes
SyncApisendSyncAckPOST /sync/ackAcknowledge changes
SystemConfigApigetConfigGET /system-configGet system configuration
SystemConfigApigetConfigDefaultsGET /system-config/defaultsGet system configuration defaults
SystemConfigApigetStorageTemplateOptionsGET /system-config/storage-template-optionsGet storage template options
SystemConfigApiupdateConfigPUT /system-configUpdate system configuration
SystemMetadataApigetAdminOnboardingGET /system-metadata/admin-onboardingRetrieve admin onboarding
SystemMetadataApigetReverseGeocodingStateGET /system-metadata/reverse-geocoding-stateRetrieve reverse geocoding state
SystemMetadataApigetVersionCheckStateGET /system-metadata/version-check-stateRetrieve version check state
SystemMetadataApiupdateAdminOnboardingPOST /system-metadata/admin-onboardingUpdate admin onboarding
TagsApibulkTagAssetsPUT /tags/assetsTag assets
TagsApicreateTagPOST /tagsCreate a tag
TagsApideleteTagDELETE /tags/{id}Delete a tag
TagsApigetAllTagsGET /tagsRetrieve tags
TagsApigetTagByIdGET /tags/{id}Retrieve a tag
TagsApitagAssetsPUT /tags/{id}/assetsTag assets
TagsApiuntagAssetsDELETE /tags/{id}/assetsUntag assets
TagsApiupdateTagPUT /tags/{id}Update a tag
TagsApiupsertTagsPUT /tagsUpsert tags
TimelineApigetTimeBucketGET /timeline/bucketGet time bucket
TimelineApigetTimeBucketsGET /timeline/bucketsGet time buckets
TrashApiemptyTrashPOST /trash/emptyEmpty trash
TrashApirestoreAssetsPOST /trash/restore/assetsRestore assets
TrashApirestoreTrashPOST /trash/restoreRestore trash
UsersApicreateProfileImagePOST /users/profile-imageCreate user profile image
UsersApideleteProfileImageDELETE /users/profile-imageDelete user profile image
UsersApideleteUserLicenseDELETE /users/me/licenseDelete user product key
UsersApideleteUserOnboardingDELETE /users/me/onboardingDelete user onboarding
UsersApigetMyPreferencesGET /users/me/preferencesGet my preferences
UsersApigetMyUserGET /users/meGet current user
UsersApigetProfileImageGET /users/{id}/profile-imageRetrieve user profile image
UsersApigetUserGET /users/{id}Retrieve a user
UsersApigetUserLicenseGET /users/me/licenseRetrieve user product key
UsersApigetUserOnboardingGET /users/me/onboardingRetrieve user onboarding
UsersApisearchUsersGET /usersGet all users
UsersApisetUserLicensePUT /users/me/licenseSet user product key
UsersApisetUserOnboardingPUT /users/me/onboardingUpdate user onboarding
UsersApiupdateMyPreferencesPUT /users/me/preferencesUpdate my preferences
UsersApiupdateMyUserPUT /users/meUpdate current user
UsersAdminApicreateUserAdminPOST /admin/usersCreate a user
UsersAdminApideleteUserAdminDELETE /admin/users/{id}Delete a user
UsersAdminApigetUserAdminGET /admin/users/{id}Retrieve a user
UsersAdminApigetUserPreferencesAdminGET /admin/users/{id}/preferencesRetrieve user preferences
UsersAdminApigetUserSessionsAdminGET /admin/users/{id}/sessionsRetrieve user sessions
UsersAdminApigetUserStatisticsAdminGET /admin/users/{id}/statisticsRetrieve user statistics
UsersAdminApirestoreUserAdminPOST /admin/users/{id}/restoreRestore a deleted user
UsersAdminApisearchUsersAdminGET /admin/usersSearch users
UsersAdminApiupdateUserAdminPUT /admin/users/{id}Update a user
UsersAdminApiupdateUserPreferencesAdminPUT /admin/users/{id}/preferencesUpdate user preferences
ViewsApigetAssetsByOriginalPathGET /view/folderRetrieve assets by original path
ViewsApigetUniqueOriginalPathsGET /view/folder/unique-pathsRetrieve unique paths
WorkflowsApicreateWorkflowPOST /workflowsCreate a workflow
WorkflowsApideleteWorkflowDELETE /workflows/{id}Delete a workflow
WorkflowsApigetWorkflowGET /workflows/{id}Retrieve a workflow
WorkflowsApigetWorkflowsGET /workflowsList all workflows
WorkflowsApiupdateWorkflowPUT /workflows/{id}Update a workflow

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

bearer

  • Type: HTTP Bearer authentication
  • 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