immich/mobile/openapi/README.md

openapi

Immich API

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

• API version: 1.122.3
• 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:

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

Class	Method	HTTP request	Description
APIKeysApi	createApiKey	POST /api-keys
APIKeysApi	deleteApiKey	DELETE /api-keys/{id}
APIKeysApi	getApiKey	GET /api-keys/{id}
APIKeysApi	getApiKeys	GET /api-keys
APIKeysApi	updateApiKey	PUT /api-keys/{id}
ActivitiesApi	createActivity	POST /activities
ActivitiesApi	deleteActivity	DELETE /activities/{id}
ActivitiesApi	getActivities	GET /activities
ActivitiesApi	getActivityStatistics	GET /activities/statistics
AlbumsApi	addAssetsToAlbum	PUT /albums/{id}/assets
AlbumsApi	addUsersToAlbum	PUT /albums/{id}/users
AlbumsApi	createAlbum	POST /albums
AlbumsApi	deleteAlbum	DELETE /albums/{id}
AlbumsApi	getAlbumInfo	GET /albums/{id}
AlbumsApi	getAlbumStatistics	GET /albums/statistics
AlbumsApi	getAllAlbums	GET /albums
AlbumsApi	removeAssetFromAlbum	DELETE /albums/{id}/assets
AlbumsApi	removeUserFromAlbum	DELETE /albums/{id}/user/{userId}
AlbumsApi	updateAlbumInfo	PATCH /albums/{id}
AlbumsApi	updateAlbumUser	PUT /albums/{id}/user/{userId}
AssetsApi	checkBulkUpload	POST /assets/bulk-upload-check
AssetsApi	checkExistingAssets	POST /assets/exist
AssetsApi	deleteAssets	DELETE /assets
AssetsApi	downloadAsset	GET /assets/{id}/original
AssetsApi	getAllUserAssetsByDeviceId	GET /assets/device/{deviceId}
AssetsApi	getAssetInfo	GET /assets/{id}
AssetsApi	getAssetStatistics	GET /assets/statistics
AssetsApi	getMemoryLane	GET /assets/memory-lane
AssetsApi	getRandom	GET /assets/random
AssetsApi	playAssetVideo	GET /assets/{id}/video/playback
AssetsApi	replaceAsset	PUT /assets/{id}/original
AssetsApi	runAssetJobs	POST /assets/jobs
AssetsApi	updateAsset	PUT /assets/{id}
AssetsApi	updateAssets	PUT /assets
AssetsApi	uploadAsset	POST /assets
AssetsApi	viewAsset	GET /assets/{id}/thumbnail
AuditApi	getAuditDeletes	GET /audit/deletes
AuthenticationApi	changePassword	POST /auth/change-password
AuthenticationApi	login	POST /auth/login
AuthenticationApi	logout	POST /auth/logout
AuthenticationApi	signUpAdmin	POST /auth/admin-sign-up
AuthenticationApi	validateAccessToken	POST /auth/validateToken
DeprecatedApi	getRandom	GET /assets/random
DownloadApi	downloadArchive	POST /download/archive
DownloadApi	getDownloadInfo	POST /download/info
DuplicatesApi	getAssetDuplicates	GET /duplicates
FacesApi	getFaces	GET /faces
FacesApi	reassignFacesById	PUT /faces/{id}
FileReportsApi	fixAuditFiles	POST /reports/fix
FileReportsApi	getAuditFiles	GET /reports
FileReportsApi	getFileChecksums	POST /reports/checksum
JobsApi	createJob	POST /jobs
JobsApi	getAllJobsStatus	GET /jobs
JobsApi	sendJobCommand	PUT /jobs/{id}
LibrariesApi	createLibrary	POST /libraries
LibrariesApi	deleteLibrary	DELETE /libraries/{id}
LibrariesApi	getAllLibraries	GET /libraries
LibrariesApi	getLibrary	GET /libraries/{id}
LibrariesApi	getLibraryStatistics	GET /libraries/{id}/statistics
LibrariesApi	scanLibrary	POST /libraries/{id}/scan
LibrariesApi	updateLibrary	PUT /libraries/{id}
LibrariesApi	validate	POST /libraries/{id}/validate
MapApi	getMapMarkers	GET /map/markers
MapApi	reverseGeocode	GET /map/reverse-geocode
MemoriesApi	addMemoryAssets	PUT /memories/{id}/assets
MemoriesApi	createMemory	POST /memories
MemoriesApi	deleteMemory	DELETE /memories/{id}
MemoriesApi	getMemory	GET /memories/{id}
MemoriesApi	removeMemoryAssets	DELETE /memories/{id}/assets
MemoriesApi	searchMemories	GET /memories
MemoriesApi	updateMemory	PUT /memories/{id}
NotificationsApi	getNotificationTemplate	POST /notifications/templates/{name}
NotificationsApi	sendTestEmail	POST /notifications/test-email
OAuthApi	finishOAuth	POST /oauth/callback
OAuthApi	linkOAuthAccount	POST /oauth/link
OAuthApi	redirectOAuthToMobile	GET /oauth/mobile-redirect
OAuthApi	startOAuth	POST /oauth/authorize
OAuthApi	unlinkOAuthAccount	POST /oauth/unlink
PartnersApi	createPartner	POST /partners/{id}
PartnersApi	getPartners	GET /partners
PartnersApi	removePartner	DELETE /partners/{id}
PartnersApi	updatePartner	PUT /partners/{id}
PeopleApi	createPerson	POST /people
PeopleApi	getAllPeople	GET /people
PeopleApi	getPerson	GET /people/{id}
PeopleApi	getPersonStatistics	GET /people/{id}/statistics
PeopleApi	getPersonThumbnail	GET /people/{id}/thumbnail
PeopleApi	mergePerson	POST /people/{id}/merge
PeopleApi	reassignFaces	PUT /people/{id}/reassign
PeopleApi	updatePeople	PUT /people
PeopleApi	updatePerson	PUT /people/{id}
SearchApi	getAssetsByCity	GET /search/cities
SearchApi	getExploreData	GET /search/explore
SearchApi	getSearchSuggestions	GET /search/suggestions
SearchApi	searchAssets	POST /search/metadata
SearchApi	searchPerson	GET /search/person
SearchApi	searchPlaces	GET /search/places
SearchApi	searchRandom	POST /search/random
SearchApi	searchSmart	POST /search/smart
ServerApi	deleteServerLicense	DELETE /server/license
ServerApi	getAboutInfo	GET /server/about
ServerApi	getServerConfig	GET /server/config
ServerApi	getServerFeatures	GET /server/features
ServerApi	getServerLicense	GET /server/license
ServerApi	getServerStatistics	GET /server/statistics
ServerApi	getServerVersion	GET /server/version
ServerApi	getStorage	GET /server/storage
ServerApi	getSupportedMediaTypes	GET /server/media-types
ServerApi	getTheme	GET /server/theme
ServerApi	getVersionHistory	GET /server/version-history
ServerApi	pingServer	GET /server/ping
ServerApi	setServerLicense	PUT /server/license
SessionsApi	deleteAllSessions	DELETE /sessions
SessionsApi	deleteSession	DELETE /sessions/{id}
SessionsApi	getSessions	GET /sessions
SharedLinksApi	addSharedLinkAssets	PUT /shared-links/{id}/assets
SharedLinksApi	createSharedLink	POST /shared-links
SharedLinksApi	getAllSharedLinks	GET /shared-links
SharedLinksApi	getMySharedLink	GET /shared-links/me
SharedLinksApi	getSharedLinkById	GET /shared-links/{id}
SharedLinksApi	removeSharedLink	DELETE /shared-links/{id}
SharedLinksApi	removeSharedLinkAssets	DELETE /shared-links/{id}/assets
SharedLinksApi	updateSharedLink	PATCH /shared-links/{id}
StacksApi	createStack	POST /stacks
StacksApi	deleteStack	DELETE /stacks/{id}
StacksApi	deleteStacks	DELETE /stacks
StacksApi	getStack	GET /stacks/{id}
StacksApi	searchStacks	GET /stacks
StacksApi	updateStack	PUT /stacks/{id}
SyncApi	getDeltaSync	POST /sync/delta-sync
SyncApi	getFullSyncForUser	POST /sync/full-sync
SystemConfigApi	getConfig	GET /system-config
SystemConfigApi	getConfigDefaults	GET /system-config/defaults
SystemConfigApi	getStorageTemplateOptions	GET /system-config/storage-template-options
SystemConfigApi	updateConfig	PUT /system-config
SystemMetadataApi	getAdminOnboarding	GET /system-metadata/admin-onboarding
SystemMetadataApi	getReverseGeocodingState	GET /system-metadata/reverse-geocoding-state
SystemMetadataApi	updateAdminOnboarding	POST /system-metadata/admin-onboarding
TagsApi	bulkTagAssets	PUT /tags/assets
TagsApi	createTag	POST /tags
TagsApi	deleteTag	DELETE /tags/{id}
TagsApi	getAllTags	GET /tags
TagsApi	getTagById	GET /tags/{id}
TagsApi	tagAssets	PUT /tags/{id}/assets
TagsApi	untagAssets	DELETE /tags/{id}/assets
TagsApi	updateTag	PUT /tags/{id}
TagsApi	upsertTags	PUT /tags
TimelineApi	getTimeBucket	GET /timeline/bucket
TimelineApi	getTimeBuckets	GET /timeline/buckets
TrashApi	emptyTrash	POST /trash/empty
TrashApi	restoreAssets	POST /trash/restore/assets
TrashApi	restoreTrash	POST /trash/restore
UsersApi	createProfileImage	POST /users/profile-image
UsersApi	deleteProfileImage	DELETE /users/profile-image
UsersApi	deleteUserLicense	DELETE /users/me/license
UsersApi	getMyPreferences	GET /users/me/preferences
UsersApi	getMyUser	GET /users/me
UsersApi	getProfileImage	GET /users/{id}/profile-image
UsersApi	getUser	GET /users/{id}
UsersApi	getUserLicense	GET /users/me/license
UsersApi	searchUsers	GET /users
UsersApi	setUserLicense	PUT /users/me/license
UsersApi	updateMyPreferences	PUT /users/me/preferences
UsersApi	updateMyUser	PUT /users/me
UsersAdminApi	createUserAdmin	POST /admin/users
UsersAdminApi	deleteUserAdmin	DELETE /admin/users/{id}
UsersAdminApi	getUserAdmin	GET /admin/users/{id}
UsersAdminApi	getUserPreferencesAdmin	GET /admin/users/{id}/preferences
UsersAdminApi	restoreUserAdmin	POST /admin/users/{id}/restore
UsersAdminApi	searchUsersAdmin	GET /admin/users
UsersAdminApi	updateUserAdmin	PUT /admin/users/{id}
UsersAdminApi	updateUserPreferencesAdmin	PUT /admin/users/{id}/preferences
ViewApi	getAssetsByOriginalPath	GET /view/folder
ViewApi	getUniqueOriginalPaths	GET /view/folder/unique-paths

Documentation For Models

• APIKeyCreateDto
• APIKeyCreateResponseDto
• APIKeyResponseDto
• APIKeyUpdateDto
• ActivityCreateDto
• ActivityResponseDto
• ActivityStatisticsResponseDto
• AddUsersDto
• AdminOnboardingUpdateDto
• AlbumResponseDto
• AlbumStatisticsResponseDto
• AlbumUserAddDto
• AlbumUserCreateDto
• AlbumUserResponseDto
• AlbumUserRole
• AllJobStatusResponseDto
• AssetBulkDeleteDto
• AssetBulkUpdateDto
• AssetBulkUploadCheckDto
• AssetBulkUploadCheckItem
• AssetBulkUploadCheckResponseDto
• AssetBulkUploadCheckResult
• AssetDeltaSyncDto
• AssetDeltaSyncResponseDto
• AssetFaceResponseDto
• AssetFaceUpdateDto
• AssetFaceUpdateItem
• AssetFaceWithoutPersonResponseDto
• AssetFullSyncDto
• AssetIdsDto
• AssetIdsResponseDto
• AssetJobName
• AssetJobsDto
• AssetMediaResponseDto
• AssetMediaSize
• AssetMediaStatus
• AssetOrder
• AssetResponseDto
• AssetStackResponseDto
• AssetStatsResponseDto
• AssetTypeEnum
• AudioCodec
• AuditDeletesResponseDto
• AvatarResponse
• AvatarUpdate
• BulkIdResponseDto
• BulkIdsDto
• CLIPConfig
• CQMode
• ChangePasswordDto
• CheckExistingAssetsDto
• CheckExistingAssetsResponseDto
• Colorspace
• CreateAlbumDto
• CreateLibraryDto
• CreateProfileImageResponseDto
• DatabaseBackupConfig
• DownloadArchiveInfo
• DownloadInfoDto
• DownloadResponse
• DownloadResponseDto
• DownloadUpdate
• DuplicateDetectionConfig
• DuplicateResponseDto
• EmailNotificationsResponse
• EmailNotificationsUpdate
• EntityType
• ExifResponseDto
• FaceDto
• FacialRecognitionConfig
• FileChecksumDto
• FileChecksumResponseDto
• FileReportDto
• FileReportFixDto
• FileReportItemDto
• FoldersResponse
• FoldersUpdate
• ImageFormat
• JobCommand
• JobCommandDto
• JobCountsDto
• JobCreateDto
• JobName
• JobSettingsDto
• JobStatusDto
• LibraryResponseDto
• LibraryStatsResponseDto
• LicenseKeyDto
• LicenseResponseDto
• LogLevel
• LoginCredentialDto
• LoginResponseDto
• LogoutResponseDto
• ManualJobName
• MapMarkerResponseDto
• MapReverseGeocodeResponseDto
• MemoriesResponse
• MemoriesUpdate
• MemoryCreateDto
• MemoryLaneResponseDto
• MemoryResponseDto
• MemoryType
• MemoryUpdateDto
• MergePersonDto
• MetadataSearchDto
• OAuthAuthorizeResponseDto
• OAuthCallbackDto
• OAuthConfigDto
• OnThisDayDto
• PartnerDirection
• PartnerResponseDto
• PathEntityType
• PathType
• PeopleResponse
• PeopleResponseDto
• PeopleUpdate
• PeopleUpdateDto
• PeopleUpdateItem
• Permission
• PersonCreateDto
• PersonResponseDto
• PersonStatisticsResponseDto
• PersonUpdateDto
• PersonWithFacesResponseDto
• PlacesResponseDto
• PurchaseResponse
• PurchaseUpdate
• QueueStatusDto
• RandomSearchDto
• RatingsResponse
• RatingsUpdate
• ReactionLevel
• ReactionType
• ReverseGeocodingStateResponseDto
• SearchAlbumResponseDto
• SearchAssetResponseDto
• SearchExploreItem
• SearchExploreResponseDto
• SearchFacetCountResponseDto
• SearchFacetResponseDto
• SearchResponseDto
• SearchSuggestionType
• ServerAboutResponseDto
• ServerConfigDto
• ServerFeaturesDto
• ServerMediaTypesResponseDto
• ServerPingResponse
• ServerStatsResponseDto
• ServerStorageResponseDto
• ServerThemeDto
• ServerVersionHistoryResponseDto
• ServerVersionResponseDto
• SessionResponseDto
• SharedLinkCreateDto
• SharedLinkEditDto
• SharedLinkResponseDto
• SharedLinkType
• SignUpDto
• SmartSearchDto
• SourceType
• StackCreateDto
• StackResponseDto
• StackUpdateDto
• SystemConfigBackupsDto
• SystemConfigDto
• SystemConfigFFmpegDto
• SystemConfigFacesDto
• SystemConfigGeneratedImageDto
• SystemConfigImageDto
• SystemConfigJobDto
• SystemConfigLibraryDto
• SystemConfigLibraryScanDto
• SystemConfigLibraryWatchDto
• SystemConfigLoggingDto
• SystemConfigMachineLearningDto
• SystemConfigMapDto
• SystemConfigMetadataDto
• SystemConfigNewVersionCheckDto
• 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
• TimeBucketResponseDto
• TimeBucketSize
• ToneMapping
• TranscodeHWAccel
• TranscodePolicy
• TrashResponseDto
• UpdateAlbumDto
• UpdateAlbumUserDto
• UpdateAssetDto
• UpdateLibraryDto
• UpdatePartnerDto
• UsageByUserDto
• UserAdminCreateDto
• UserAdminDeleteDto
• UserAdminResponseDto
• UserAdminUpdateDto
• UserAvatarColor
• UserLicense
• UserPreferencesResponseDto
• UserPreferencesUpdateDto
• UserResponseDto
• UserStatus
• UserUpdateMeDto
• ValidateAccessTokenResponseDto
• ValidateLibraryDto
• ValidateLibraryImportPathResponseDto
• ValidateLibraryResponseDto
• VideoCodec
• VideoContainer

Documentation For Authorization

Authentication schemes defined for the API:

bearer

• Type: HTTP Bearer authentication

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