immich/mobile/openapi

openapi

Immich API

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

• API version: 1.97.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 = APIKeyApi();
final aPIKeyCreateDto = APIKeyCreateDto(); // APIKeyCreateDto | 

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

Documentation for API Endpoints

All URIs are relative to /api

Class	Method	HTTP request	Description
APIKeyApi	createApiKey	POST /api-key
APIKeyApi	deleteApiKey	DELETE /api-key/{id}
APIKeyApi	getApiKey	GET /api-key/{id}
APIKeyApi	getApiKeys	GET /api-key
APIKeyApi	updateApiKey	PUT /api-key/{id}
ActivityApi	createActivity	POST /activity
ActivityApi	deleteActivity	DELETE /activity/{id}
ActivityApi	getActivities	GET /activity
ActivityApi	getActivityStatistics	GET /activity/statistics
AlbumApi	addAssetsToAlbum	PUT /album/{id}/assets
AlbumApi	addUsersToAlbum	PUT /album/{id}/users
AlbumApi	createAlbum	POST /album
AlbumApi	deleteAlbum	DELETE /album/{id}
AlbumApi	getAlbumCount	GET /album/count
AlbumApi	getAlbumInfo	GET /album/{id}
AlbumApi	getAllAlbums	GET /album
AlbumApi	removeAssetFromAlbum	DELETE /album/{id}/assets
AlbumApi	removeUserFromAlbum	DELETE /album/{id}/user/{userId}
AlbumApi	updateAlbumInfo	PATCH /album/{id}
AssetApi	checkBulkUpload	POST /asset/bulk-upload-check
AssetApi	checkExistingAssets	POST /asset/exist
AssetApi	deleteAssets	DELETE /asset
AssetApi	getAllAssets	GET /asset
AssetApi	getAllUserAssetsByDeviceId	GET /asset/device/{deviceId}
AssetApi	getAssetInfo	GET /asset/{id}
AssetApi	getAssetSearchTerms	GET /asset/search-terms
AssetApi	getAssetStatistics	GET /asset/statistics
AssetApi	getAssetThumbnail	GET /asset/thumbnail/{id}
AssetApi	getCuratedLocations	GET /asset/curated-locations
AssetApi	getCuratedObjects	GET /asset/curated-objects
AssetApi	getMapMarkers	GET /asset/map-marker
AssetApi	getMemoryLane	GET /asset/memory-lane
AssetApi	getRandom	GET /asset/random
AssetApi	getTimeBucket	GET /asset/time-bucket
AssetApi	getTimeBuckets	GET /asset/time-buckets
AssetApi	runAssetJobs	POST /asset/jobs
AssetApi	searchAssets	GET /assets
AssetApi	serveFile	GET /asset/file/{id}
AssetApi	updateAsset	PUT /asset/{id}
AssetApi	updateAssets	PUT /asset
AssetApi	updateStackParent	PUT /asset/stack/parent
AssetApi	uploadFile	POST /asset/upload
AuditApi	fixAuditFiles	POST /audit/file-report/fix
AuditApi	getAuditDeletes	GET /audit/deletes
AuditApi	getAuditFiles	GET /audit/file-report
AuditApi	getFileChecksums	POST /audit/file-report/checksum
AuthenticationApi	changePassword	POST /auth/change-password
AuthenticationApi	getAuthDevices	GET /auth/devices
AuthenticationApi	login	POST /auth/login
AuthenticationApi	logout	POST /auth/logout
AuthenticationApi	logoutAuthDevice	DELETE /auth/devices/{id}
AuthenticationApi	logoutAuthDevices	DELETE /auth/devices
AuthenticationApi	signUpAdmin	POST /auth/admin-sign-up
AuthenticationApi	validateAccessToken	POST /auth/validateToken
DownloadApi	downloadArchive	POST /download/archive
DownloadApi	downloadFile	POST /download/asset/{id}
DownloadApi	getDownloadInfo	POST /download/info
FaceApi	getFaces	GET /face
FaceApi	reassignFacesById	PUT /face/{id}
JobApi	getAllJobsStatus	GET /jobs
JobApi	sendJobCommand	PUT /jobs/{id}
LibraryApi	createLibrary	POST /library
LibraryApi	deleteLibrary	DELETE /library/{id}
LibraryApi	getAllLibraries	GET /library
LibraryApi	getLibrary	GET /library/{id}
LibraryApi	getLibraryStatistics	GET /library/{id}/statistics
LibraryApi	removeOfflineFiles	POST /library/{id}/removeOffline
LibraryApi	scanLibrary	POST /library/{id}/scan
LibraryApi	updateLibrary	PUT /library/{id}
LibraryApi	validate	POST /library/{id}/validate
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
PartnerApi	createPartner	POST /partner/{id}
PartnerApi	getPartners	GET /partner
PartnerApi	removePartner	DELETE /partner/{id}
PartnerApi	updatePartner	PUT /partner/{id}
PersonApi	createPerson	POST /person
PersonApi	getAllPeople	GET /person
PersonApi	getPerson	GET /person/{id}
PersonApi	getPersonAssets	GET /person/{id}/assets
PersonApi	getPersonStatistics	GET /person/{id}/statistics
PersonApi	getPersonThumbnail	GET /person/{id}/thumbnail
PersonApi	mergePerson	POST /person/{id}/merge
PersonApi	reassignFaces	PUT /person/{id}/reassign
PersonApi	updatePeople	PUT /person
PersonApi	updatePerson	PUT /person/{id}
SearchApi	getExploreData	GET /search/explore
SearchApi	getSearchSuggestions	GET /search/suggestions
SearchApi	search	GET /search
SearchApi	searchMetadata	POST /search/metadata
SearchApi	searchPerson	GET /search/person
SearchApi	searchPlaces	GET /search/places
SearchApi	searchSmart	POST /search/smart
ServerInfoApi	getServerConfig	GET /server-info/config
ServerInfoApi	getServerFeatures	GET /server-info/features
ServerInfoApi	getServerInfo	GET /server-info
ServerInfoApi	getServerStatistics	GET /server-info/statistics
ServerInfoApi	getServerVersion	GET /server-info/version
ServerInfoApi	getSupportedMediaTypes	GET /server-info/media-types
ServerInfoApi	getTheme	GET /server-info/theme
ServerInfoApi	pingServer	GET /server-info/ping
ServerInfoApi	setAdminOnboarding	POST /server-info/admin-onboarding
SharedLinkApi	addSharedLinkAssets	PUT /shared-link/{id}/assets
SharedLinkApi	createSharedLink	POST /shared-link
SharedLinkApi	getAllSharedLinks	GET /shared-link
SharedLinkApi	getMySharedLink	GET /shared-link/me
SharedLinkApi	getSharedLinkById	GET /shared-link/{id}
SharedLinkApi	removeSharedLink	DELETE /shared-link/{id}
SharedLinkApi	removeSharedLinkAssets	DELETE /shared-link/{id}/assets
SharedLinkApi	updateSharedLink	PATCH /shared-link/{id}
SystemConfigApi	getConfig	GET /system-config
SystemConfigApi	getConfigDefaults	GET /system-config/defaults
SystemConfigApi	getMapStyle	GET /system-config/map/style.json
SystemConfigApi	getStorageTemplateOptions	GET /system-config/storage-template-options
SystemConfigApi	updateConfig	PUT /system-config
TagApi	createTag	POST /tag
TagApi	deleteTag	DELETE /tag/{id}
TagApi	getAllTags	GET /tag
TagApi	getTagAssets	GET /tag/{id}/assets
TagApi	getTagById	GET /tag/{id}
TagApi	tagAssets	PUT /tag/{id}/assets
TagApi	untagAssets	DELETE /tag/{id}/assets
TagApi	updateTag	PATCH /tag/{id}
TrashApi	emptyTrash	POST /trash/empty
TrashApi	restoreAssets	POST /trash/restore/assets
TrashApi	restoreTrash	POST /trash/restore
UserApi	createProfileImage	POST /user/profile-image
UserApi	createUser	POST /user
UserApi	deleteProfileImage	DELETE /user/profile-image
UserApi	deleteUser	DELETE /user/{id}
UserApi	getAllUsers	GET /user
UserApi	getMyUserInfo	GET /user/me
UserApi	getProfileImage	GET /user/profile-image/{id}
UserApi	getUserById	GET /user/info/{id}
UserApi	restoreUser	POST /user/{id}/restore
UserApi	updateUser	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
• MetadataSearchDto
• ModelType
• OAuthAuthorizeResponseDto
• OAuthCallbackDto
• OAuthConfigDto
• PartnerResponseDto
• PathEntityType
• PathType
• PeopleResponseDto
• PeopleUpdateDto
• PeopleUpdateItem
• PersonResponseDto
• PersonStatisticsResponseDto
• PersonUpdateDto
• PersonWithFacesResponseDto
• PlacesResponseDto
• QueueStatusDto
• ReactionLevel
• ReactionType
• RecognitionConfig
• ScanLibraryDto
• SearchAlbumResponseDto
• SearchAssetResponseDto
• SearchExploreItem
• SearchExploreResponseDto
• SearchFacetCountResponseDto
• SearchFacetResponseDto
• SearchResponseDto
• SearchSuggestionType
• ServerConfigDto
• ServerFeaturesDto
• ServerInfoResponseDto
• ServerMediaTypesResponseDto
• ServerPingResponse
• ServerStatsResponseDto
• ServerThemeDto
• ServerVersionResponseDto
• SharedLinkCreateDto
• SharedLinkEditDto
• SharedLinkResponseDto
• SharedLinkType
• SignUpDto
• SmartInfoResponseDto
• SmartSearchDto
• SystemConfigDto
• SystemConfigFFmpegDto
• SystemConfigJobDto
• SystemConfigLibraryDto
• SystemConfigLibraryScanDto
• SystemConfigLibraryWatchDto
• SystemConfigLoggingDto
• SystemConfigMachineLearningDto
• SystemConfigMapDto
• SystemConfigNewVersionCheckDto
• SystemConfigOAuthDto
• SystemConfigPasswordLoginDto
• SystemConfigReverseGeocodingDto
• SystemConfigServerDto
• SystemConfigStorageTemplateDto
• SystemConfigTemplateStorageOptionDto
• SystemConfigThemeDto
• SystemConfigThumbnailDto
• SystemConfigTrashDto
• SystemConfigUserDto
• TagResponseDto
• TagTypeEnum
• ThumbnailFormat
• TimeBucketResponseDto
• TimeBucketSize
• ToneMapping
• TranscodeHWAccel
• TranscodePolicy
• UpdateAlbumDto
• UpdateAssetDto
• UpdateLibraryDto
• UpdatePartnerDto
• UpdateStackParentDto
• UpdateTagDto
• UpdateUserDto
• UsageByUserDto
• UserAvatarColor
• UserDto
• UserResponseDto
• ValidateAccessTokenResponseDto
• ValidateLibraryDto
• ValidateLibraryImportPathResponseDto
• ValidateLibraryResponseDto
• VideoCodec

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