Debian Codegraph @

scripts/.github/immich-api-monitor/immich-openapi-specs-baseline.json

raw
1 {
2 "openapi": "3.0.0",
3 "paths": {
4 "/activities": {
5 "get": {
6 "operationId": "getActivities",
7 "parameters": [
8 {
9 "name": "albumId",
10 "required": true,
11 "in": "query",
12 "schema": {
13 "format": "uuid",
14 "type": "string"
15 }
16 },
17 {
18 "name": "assetId",
19 "required": false,
20 "in": "query",
21 "schema": {
22 "format": "uuid",
23 "type": "string"
24 }
25 },
26 {
27 "name": "level",
28 "required": false,
29 "in": "query",
30 "schema": {
31 "$ref": "#/components/schemas/ReactionLevel"
32 }
33 },
34 {
35 "name": "type",
36 "required": false,
37 "in": "query",
38 "schema": {
39 "$ref": "#/components/schemas/ReactionType"
40 }
41 },
42 {
43 "name": "userId",
44 "required": false,
45 "in": "query",
46 "schema": {
47 "format": "uuid",
48 "type": "string"
49 }
50 }
51 ],
52 "responses": {
53 "200": {
54 "content": {
55 "application/json": {
56 "schema": {
57 "items": {
58 "$ref": "#/components/schemas/ActivityResponseDto"
59 },
60 "type": "array"
61 }
62 }
63 },
64 "description": ""
65 }
66 },
67 "security": [
68 {
69 "bearer": []
70 },
71 {
72 "cookie": []
73 },
74 {
75 "api_key": []
76 }
77 ],
78 "tags": [
79 "Activities"
80 ],
81 "x-immich-permission": "activity.read",
82 "description": "This endpoint requires the `activity.read` permission."
83 },
84 "post": {
85 "operationId": "createActivity",
86 "parameters": [],
87 "requestBody": {
88 "content": {
89 "application/json": {
90 "schema": {
91 "$ref": "#/components/schemas/ActivityCreateDto"
92 }
93 }
94 },
95 "required": true
96 },
97 "responses": {
98 "201": {
99 "content": {
100 "application/json": {
101 "schema": {
102 "$ref": "#/components/schemas/ActivityResponseDto"
103 }
104 }
105 },
106 "description": ""
107 }
108 },
109 "security": [
110 {
111 "bearer": []
112 },
113 {
114 "cookie": []
115 },
116 {
117 "api_key": []
118 }
119 ],
120 "tags": [
121 "Activities"
122 ],
123 "x-immich-permission": "activity.create",
124 "description": "This endpoint requires the `activity.create` permission."
125 }
126 },
127 "/activities/statistics": {
128 "get": {
129 "operationId": "getActivityStatistics",
130 "parameters": [
131 {
132 "name": "albumId",
133 "required": true,
134 "in": "query",
135 "schema": {
136 "format": "uuid",
137 "type": "string"
138 }
139 },
140 {
141 "name": "assetId",
142 "required": false,
143 "in": "query",
144 "schema": {
145 "format": "uuid",
146 "type": "string"
147 }
148 }
149 ],
150 "responses": {
151 "200": {
152 "content": {
153 "application/json": {
154 "schema": {
155 "$ref": "#/components/schemas/ActivityStatisticsResponseDto"
156 }
157 }
158 },
159 "description": ""
160 }
161 },
162 "security": [
163 {
164 "bearer": []
165 },
166 {
167 "cookie": []
168 },
169 {
170 "api_key": []
171 }
172 ],
173 "tags": [
174 "Activities"
175 ],
176 "x-immich-permission": "activity.statistics",
177 "description": "This endpoint requires the `activity.statistics` permission."
178 }
179 },
180 "/activities/{id}": {
181 "delete": {
182 "operationId": "deleteActivity",
183 "parameters": [
184 {
185 "name": "id",
186 "required": true,
187 "in": "path",
188 "schema": {
189 "format": "uuid",
190 "type": "string"
191 }
192 }
193 ],
194 "responses": {
195 "204": {
196 "description": ""
197 }
198 },
199 "security": [
200 {
201 "bearer": []
202 },
203 {
204 "cookie": []
205 },
206 {
207 "api_key": []
208 }
209 ],
210 "tags": [
211 "Activities"
212 ],
213 "x-immich-permission": "activity.delete",
214 "description": "This endpoint requires the `activity.delete` permission."
215 }
216 },
217 "/admin/auth/unlink-all": {
218 "post": {
219 "operationId": "unlinkAllOAuthAccountsAdmin",
220 "parameters": [],
221 "responses": {
222 "204": {
223 "description": ""
224 }
225 },
226 "security": [
227 {
228 "bearer": []
229 },
230 {
231 "cookie": []
232 },
233 {
234 "api_key": []
235 }
236 ],
237 "tags": [
238 "Auth (admin)"
239 ],
240 "x-immich-admin-only": true,
241 "x-immich-permission": "adminAuth.unlinkAll",
242 "description": "This endpoint is an admin-only route, and requires the `adminAuth.unlinkAll` permission."
243 }
244 },
245 "/admin/notifications": {
246 "post": {
247 "operationId": "createNotification",
248 "parameters": [],
249 "requestBody": {
250 "content": {
251 "application/json": {
252 "schema": {
253 "$ref": "#/components/schemas/NotificationCreateDto"
254 }
255 }
256 },
257 "required": true
258 },
259 "responses": {
260 "201": {
261 "content": {
262 "application/json": {
263 "schema": {
264 "$ref": "#/components/schemas/NotificationDto"
265 }
266 }
267 },
268 "description": ""
269 }
270 },
271 "security": [
272 {
273 "bearer": []
274 },
275 {
276 "cookie": []
277 },
278 {
279 "api_key": []
280 }
281 ],
282 "tags": [
283 "Notifications (Admin)"
284 ],
285 "x-immich-admin-only": true
286 }
287 },
288 "/admin/notifications/templates/{name}": {
289 "post": {
290 "operationId": "getNotificationTemplateAdmin",
291 "parameters": [
292 {
293 "name": "name",
294 "required": true,
295 "in": "path",
296 "schema": {
297 "type": "string"
298 }
299 }
300 ],
301 "requestBody": {
302 "content": {
303 "application/json": {
304 "schema": {
305 "$ref": "#/components/schemas/TemplateDto"
306 }
307 }
308 },
309 "required": true
310 },
311 "responses": {
312 "200": {
313 "content": {
314 "application/json": {
315 "schema": {
316 "$ref": "#/components/schemas/TemplateResponseDto"
317 }
318 }
319 },
320 "description": ""
321 }
322 },
323 "security": [
324 {
325 "bearer": []
326 },
327 {
328 "cookie": []
329 },
330 {
331 "api_key": []
332 }
333 ],
334 "tags": [
335 "Notifications (Admin)"
336 ],
337 "x-immich-admin-only": true
338 }
339 },
340 "/admin/notifications/test-email": {
341 "post": {
342 "operationId": "sendTestEmailAdmin",
343 "parameters": [],
344 "requestBody": {
345 "content": {
346 "application/json": {
347 "schema": {
348 "$ref": "#/components/schemas/SystemConfigSmtpDto"
349 }
350 }
351 },
352 "required": true
353 },
354 "responses": {
355 "200": {
356 "content": {
357 "application/json": {
358 "schema": {
359 "$ref": "#/components/schemas/TestEmailResponseDto"
360 }
361 }
362 },
363 "description": ""
364 }
365 },
366 "security": [
367 {
368 "bearer": []
369 },
370 {
371 "cookie": []
372 },
373 {
374 "api_key": []
375 }
376 ],
377 "tags": [
378 "Notifications (Admin)"
379 ],
380 "x-immich-admin-only": true
381 }
382 },
383 "/admin/users": {
384 "get": {
385 "operationId": "searchUsersAdmin",
386 "parameters": [
387 {
388 "name": "id",
389 "required": false,
390 "in": "query",
391 "schema": {
392 "format": "uuid",
393 "type": "string"
394 }
395 },
396 {
397 "name": "withDeleted",
398 "required": false,
399 "in": "query",
400 "schema": {
401 "type": "boolean"
402 }
403 }
404 ],
405 "responses": {
406 "200": {
407 "content": {
408 "application/json": {
409 "schema": {
410 "items": {
411 "$ref": "#/components/schemas/UserAdminResponseDto"
412 },
413 "type": "array"
414 }
415 }
416 },
417 "description": ""
418 }
419 },
420 "security": [
421 {
422 "bearer": []
423 },
424 {
425 "cookie": []
426 },
427 {
428 "api_key": []
429 }
430 ],
431 "tags": [
432 "Users (admin)"
433 ],
434 "x-immich-admin-only": true,
435 "x-immich-permission": "adminUser.read",
436 "description": "This endpoint is an admin-only route, and requires the `adminUser.read` permission."
437 },
438 "post": {
439 "operationId": "createUserAdmin",
440 "parameters": [],
441 "requestBody": {
442 "content": {
443 "application/json": {
444 "schema": {
445 "$ref": "#/components/schemas/UserAdminCreateDto"
446 }
447 }
448 },
449 "required": true
450 },
451 "responses": {
452 "201": {
453 "content": {
454 "application/json": {
455 "schema": {
456 "$ref": "#/components/schemas/UserAdminResponseDto"
457 }
458 }
459 },
460 "description": ""
461 }
462 },
463 "security": [
464 {
465 "bearer": []
466 },
467 {
468 "cookie": []
469 },
470 {
471 "api_key": []
472 }
473 ],
474 "tags": [
475 "Users (admin)"
476 ],
477 "x-immich-admin-only": true,
478 "x-immich-permission": "adminUser.create",
479 "description": "This endpoint is an admin-only route, and requires the `adminUser.create` permission."
480 }
481 },
482 "/admin/users/{id}": {
483 "delete": {
484 "operationId": "deleteUserAdmin",
485 "parameters": [
486 {
487 "name": "id",
488 "required": true,
489 "in": "path",
490 "schema": {
491 "format": "uuid",
492 "type": "string"
493 }
494 }
495 ],
496 "requestBody": {
497 "content": {
498 "application/json": {
499 "schema": {
500 "$ref": "#/components/schemas/UserAdminDeleteDto"
501 }
502 }
503 },
504 "required": true
505 },
506 "responses": {
507 "200": {
508 "content": {
509 "application/json": {
510 "schema": {
511 "$ref": "#/components/schemas/UserAdminResponseDto"
512 }
513 }
514 },
515 "description": ""
516 }
517 },
518 "security": [
519 {
520 "bearer": []
521 },
522 {
523 "cookie": []
524 },
525 {
526 "api_key": []
527 }
528 ],
529 "tags": [
530 "Users (admin)"
531 ],
532 "x-immich-admin-only": true,
533 "x-immich-permission": "adminUser.delete",
534 "description": "This endpoint is an admin-only route, and requires the `adminUser.delete` permission."
535 },
536 "get": {
537 "operationId": "getUserAdmin",
538 "parameters": [
539 {
540 "name": "id",
541 "required": true,
542 "in": "path",
543 "schema": {
544 "format": "uuid",
545 "type": "string"
546 }
547 }
548 ],
549 "responses": {
550 "200": {
551 "content": {
552 "application/json": {
553 "schema": {
554 "$ref": "#/components/schemas/UserAdminResponseDto"
555 }
556 }
557 },
558 "description": ""
559 }
560 },
561 "security": [
562 {
563 "bearer": []
564 },
565 {
566 "cookie": []
567 },
568 {
569 "api_key": []
570 }
571 ],
572 "tags": [
573 "Users (admin)"
574 ],
575 "x-immich-admin-only": true,
576 "x-immich-permission": "adminUser.read",
577 "description": "This endpoint is an admin-only route, and requires the `adminUser.read` permission."
578 },
579 "put": {
580 "operationId": "updateUserAdmin",
581 "parameters": [
582 {
583 "name": "id",
584 "required": true,
585 "in": "path",
586 "schema": {
587 "format": "uuid",
588 "type": "string"
589 }
590 }
591 ],
592 "requestBody": {
593 "content": {
594 "application/json": {
595 "schema": {
596 "$ref": "#/components/schemas/UserAdminUpdateDto"
597 }
598 }
599 },
600 "required": true
601 },
602 "responses": {
603 "200": {
604 "content": {
605 "application/json": {
606 "schema": {
607 "$ref": "#/components/schemas/UserAdminResponseDto"
608 }
609 }
610 },
611 "description": ""
612 }
613 },
614 "security": [
615 {
616 "bearer": []
617 },
618 {
619 "cookie": []
620 },
621 {
622 "api_key": []
623 }
624 ],
625 "tags": [
626 "Users (admin)"
627 ],
628 "x-immich-admin-only": true,
629 "x-immich-permission": "adminUser.update",
630 "description": "This endpoint is an admin-only route, and requires the `adminUser.update` permission."
631 }
632 },
633 "/admin/users/{id}/preferences": {
634 "get": {
635 "operationId": "getUserPreferencesAdmin",
636 "parameters": [
637 {
638 "name": "id",
639 "required": true,
640 "in": "path",
641 "schema": {
642 "format": "uuid",
643 "type": "string"
644 }
645 }
646 ],
647 "responses": {
648 "200": {
649 "content": {
650 "application/json": {
651 "schema": {
652 "$ref": "#/components/schemas/UserPreferencesResponseDto"
653 }
654 }
655 },
656 "description": ""
657 }
658 },
659 "security": [
660 {
661 "bearer": []
662 },
663 {
664 "cookie": []
665 },
666 {
667 "api_key": []
668 }
669 ],
670 "tags": [
671 "Users (admin)"
672 ],
673 "x-immich-admin-only": true,
674 "x-immich-permission": "adminUser.read",
675 "description": "This endpoint is an admin-only route, and requires the `adminUser.read` permission."
676 },
677 "put": {
678 "operationId": "updateUserPreferencesAdmin",
679 "parameters": [
680 {
681 "name": "id",
682 "required": true,
683 "in": "path",
684 "schema": {
685 "format": "uuid",
686 "type": "string"
687 }
688 }
689 ],
690 "requestBody": {
691 "content": {
692 "application/json": {
693 "schema": {
694 "$ref": "#/components/schemas/UserPreferencesUpdateDto"
695 }
696 }
697 },
698 "required": true
699 },
700 "responses": {
701 "200": {
702 "content": {
703 "application/json": {
704 "schema": {
705 "$ref": "#/components/schemas/UserPreferencesResponseDto"
706 }
707 }
708 },
709 "description": ""
710 }
711 },
712 "security": [
713 {
714 "bearer": []
715 },
716 {
717 "cookie": []
718 },
719 {
720 "api_key": []
721 }
722 ],
723 "tags": [
724 "Users (admin)"
725 ],
726 "x-immich-admin-only": true,
727 "x-immich-permission": "adminUser.update",
728 "description": "This endpoint is an admin-only route, and requires the `adminUser.update` permission."
729 }
730 },
731 "/admin/users/{id}/restore": {
732 "post": {
733 "operationId": "restoreUserAdmin",
734 "parameters": [
735 {
736 "name": "id",
737 "required": true,
738 "in": "path",
739 "schema": {
740 "format": "uuid",
741 "type": "string"
742 }
743 }
744 ],
745 "responses": {
746 "200": {
747 "content": {
748 "application/json": {
749 "schema": {
750 "$ref": "#/components/schemas/UserAdminResponseDto"
751 }
752 }
753 },
754 "description": ""
755 }
756 },
757 "security": [
758 {
759 "bearer": []
760 },
761 {
762 "cookie": []
763 },
764 {
765 "api_key": []
766 }
767 ],
768 "tags": [
769 "Users (admin)"
770 ],
771 "x-immich-admin-only": true,
772 "x-immich-permission": "adminUser.delete",
773 "description": "This endpoint is an admin-only route, and requires the `adminUser.delete` permission."
774 }
775 },
776 "/admin/users/{id}/statistics": {
777 "get": {
778 "operationId": "getUserStatisticsAdmin",
779 "parameters": [
780 {
781 "name": "id",
782 "required": true,
783 "in": "path",
784 "schema": {
785 "format": "uuid",
786 "type": "string"
787 }
788 },
789 {
790 "name": "isFavorite",
791 "required": false,
792 "in": "query",
793 "schema": {
794 "type": "boolean"
795 }
796 },
797 {
798 "name": "isTrashed",
799 "required": false,
800 "in": "query",
801 "schema": {
802 "type": "boolean"
803 }
804 },
805 {
806 "name": "visibility",
807 "required": false,
808 "in": "query",
809 "schema": {
810 "$ref": "#/components/schemas/AssetVisibility"
811 }
812 }
813 ],
814 "responses": {
815 "200": {
816 "content": {
817 "application/json": {
818 "schema": {
819 "$ref": "#/components/schemas/AssetStatsResponseDto"
820 }
821 }
822 },
823 "description": ""
824 }
825 },
826 "security": [
827 {
828 "bearer": []
829 },
830 {
831 "cookie": []
832 },
833 {
834 "api_key": []
835 }
836 ],
837 "tags": [
838 "Users (admin)"
839 ],
840 "x-immich-admin-only": true,
841 "x-immich-permission": "adminUser.read",
842 "description": "This endpoint is an admin-only route, and requires the `adminUser.read` permission."
843 }
844 },
845 "/albums": {
846 "get": {
847 "operationId": "getAllAlbums",
848 "parameters": [
849 {
850 "name": "assetId",
851 "required": false,
852 "in": "query",
853 "description": "Only returns albums that contain the asset\nIgnores the shared parameter\nundefined: get all albums",
854 "schema": {
855 "format": "uuid",
856 "type": "string"
857 }
858 },
859 {
860 "name": "shared",
861 "required": false,
862 "in": "query",
863 "schema": {
864 "type": "boolean"
865 }
866 }
867 ],
868 "responses": {
869 "200": {
870 "content": {
871 "application/json": {
872 "schema": {
873 "items": {
874 "$ref": "#/components/schemas/AlbumResponseDto"
875 },
876 "type": "array"
877 }
878 }
879 },
880 "description": ""
881 }
882 },
883 "security": [
884 {
885 "bearer": []
886 },
887 {
888 "cookie": []
889 },
890 {
891 "api_key": []
892 }
893 ],
894 "tags": [
895 "Albums"
896 ],
897 "x-immich-permission": "album.read",
898 "description": "This endpoint requires the `album.read` permission."
899 },
900 "post": {
901 "operationId": "createAlbum",
902 "parameters": [],
903 "requestBody": {
904 "content": {
905 "application/json": {
906 "schema": {
907 "$ref": "#/components/schemas/CreateAlbumDto"
908 }
909 }
910 },
911 "required": true
912 },
913 "responses": {
914 "201": {
915 "content": {
916 "application/json": {
917 "schema": {
918 "$ref": "#/components/schemas/AlbumResponseDto"
919 }
920 }
921 },
922 "description": ""
923 }
924 },
925 "security": [
926 {
927 "bearer": []
928 },
929 {
930 "cookie": []
931 },
932 {
933 "api_key": []
934 }
935 ],
936 "tags": [
937 "Albums"
938 ],
939 "x-immich-permission": "album.create",
940 "description": "This endpoint requires the `album.create` permission."
941 }
942 },
943 "/albums/assets": {
944 "put": {
945 "operationId": "addAssetsToAlbums",
946 "parameters": [
947 {
948 "name": "key",
949 "required": false,
950 "in": "query",
951 "schema": {
952 "type": "string"
953 }
954 },
955 {
956 "name": "slug",
957 "required": false,
958 "in": "query",
959 "schema": {
960 "type": "string"
961 }
962 }
963 ],
964 "requestBody": {
965 "content": {
966 "application/json": {
967 "schema": {
968 "$ref": "#/components/schemas/AlbumsAddAssetsDto"
969 }
970 }
971 },
972 "required": true
973 },
974 "responses": {
975 "200": {
976 "content": {
977 "application/json": {
978 "schema": {
979 "$ref": "#/components/schemas/AlbumsAddAssetsResponseDto"
980 }
981 }
982 },
983 "description": ""
984 }
985 },
986 "security": [
987 {
988 "bearer": []
989 },
990 {
991 "cookie": []
992 },
993 {
994 "api_key": []
995 }
996 ],
997 "tags": [
998 "Albums"
999 ],
1000 "x-immich-permission": "albumAsset.create",
1001 "description": "This endpoint requires the `albumAsset.create` permission."
1002 }
1003 },
1004 "/albums/statistics": {
1005 "get": {
1006 "operationId": "getAlbumStatistics",
1007 "parameters": [],
1008 "responses": {
1009 "200": {
1010 "content": {
1011 "application/json": {
1012 "schema": {
1013 "$ref": "#/components/schemas/AlbumStatisticsResponseDto"
1014 }
1015 }
1016 },
1017 "description": ""
1018 }
1019 },
1020 "security": [
1021 {
1022 "bearer": []
1023 },
1024 {
1025 "cookie": []
1026 },
1027 {
1028 "api_key": []
1029 }
1030 ],
1031 "tags": [
1032 "Albums"
1033 ],
1034 "x-immich-permission": "album.statistics",
1035 "description": "This endpoint requires the `album.statistics` permission."
1036 }
1037 },
1038 "/albums/{id}": {
1039 "delete": {
1040 "operationId": "deleteAlbum",
1041 "parameters": [
1042 {
1043 "name": "id",
1044 "required": true,
1045 "in": "path",
1046 "schema": {
1047 "format": "uuid",
1048 "type": "string"
1049 }
1050 }
1051 ],
1052 "responses": {
1053 "204": {
1054 "description": ""
1055 }
1056 },
1057 "security": [
1058 {
1059 "bearer": []
1060 },
1061 {
1062 "cookie": []
1063 },
1064 {
1065 "api_key": []
1066 }
1067 ],
1068 "tags": [
1069 "Albums"
1070 ],
1071 "x-immich-permission": "album.delete",
1072 "description": "This endpoint requires the `album.delete` permission."
1073 },
1074 "get": {
1075 "operationId": "getAlbumInfo",
1076 "parameters": [
1077 {
1078 "name": "id",
1079 "required": true,
1080 "in": "path",
1081 "schema": {
1082 "format": "uuid",
1083 "type": "string"
1084 }
1085 },
1086 {
1087 "name": "key",
1088 "required": false,
1089 "in": "query",
1090 "schema": {
1091 "type": "string"
1092 }
1093 },
1094 {
1095 "name": "slug",
1096 "required": false,
1097 "in": "query",
1098 "schema": {
1099 "type": "string"
1100 }
1101 },
1102 {
1103 "name": "withoutAssets",
1104 "required": false,
1105 "in": "query",
1106 "schema": {
1107 "type": "boolean"
1108 }
1109 }
1110 ],
1111 "responses": {
1112 "200": {
1113 "content": {
1114 "application/json": {
1115 "schema": {
1116 "$ref": "#/components/schemas/AlbumResponseDto"
1117 }
1118 }
1119 },
1120 "description": ""
1121 }
1122 },
1123 "security": [
1124 {
1125 "bearer": []
1126 },
1127 {
1128 "cookie": []
1129 },
1130 {
1131 "api_key": []
1132 }
1133 ],
1134 "tags": [
1135 "Albums"
1136 ],
1137 "x-immich-permission": "album.read",
1138 "description": "This endpoint requires the `album.read` permission."
1139 },
1140 "patch": {
1141 "operationId": "updateAlbumInfo",
1142 "parameters": [
1143 {
1144 "name": "id",
1145 "required": true,
1146 "in": "path",
1147 "schema": {
1148 "format": "uuid",
1149 "type": "string"
1150 }
1151 }
1152 ],
1153 "requestBody": {
1154 "content": {
1155 "application/json": {
1156 "schema": {
1157 "$ref": "#/components/schemas/UpdateAlbumDto"
1158 }
1159 }
1160 },
1161 "required": true
1162 },
1163 "responses": {
1164 "200": {
1165 "content": {
1166 "application/json": {
1167 "schema": {
1168 "$ref": "#/components/schemas/AlbumResponseDto"
1169 }
1170 }
1171 },
1172 "description": ""
1173 }
1174 },
1175 "security": [
1176 {
1177 "bearer": []
1178 },
1179 {
1180 "cookie": []
1181 },
1182 {
1183 "api_key": []
1184 }
1185 ],
1186 "tags": [
1187 "Albums"
1188 ],
1189 "x-immich-permission": "album.update",
1190 "description": "This endpoint requires the `album.update` permission."
1191 }
1192 },
1193 "/albums/{id}/assets": {
1194 "delete": {
1195 "operationId": "removeAssetFromAlbum",
1196 "parameters": [
1197 {
1198 "name": "id",
1199 "required": true,
1200 "in": "path",
1201 "schema": {
1202 "format": "uuid",
1203 "type": "string"
1204 }
1205 }
1206 ],
1207 "requestBody": {
1208 "content": {
1209 "application/json": {
1210 "schema": {
1211 "$ref": "#/components/schemas/BulkIdsDto"
1212 }
1213 }
1214 },
1215 "required": true
1216 },
1217 "responses": {
1218 "200": {
1219 "content": {
1220 "application/json": {
1221 "schema": {
1222 "items": {
1223 "$ref": "#/components/schemas/BulkIdResponseDto"
1224 },
1225 "type": "array"
1226 }
1227 }
1228 },
1229 "description": ""
1230 }
1231 },
1232 "security": [
1233 {
1234 "bearer": []
1235 },
1236 {
1237 "cookie": []
1238 },
1239 {
1240 "api_key": []
1241 }
1242 ],
1243 "tags": [
1244 "Albums"
1245 ],
1246 "x-immich-permission": "albumAsset.delete",
1247 "description": "This endpoint requires the `albumAsset.delete` permission."
1248 },
1249 "put": {
1250 "operationId": "addAssetsToAlbum",
1251 "parameters": [
1252 {
1253 "name": "id",
1254 "required": true,
1255 "in": "path",
1256 "schema": {
1257 "format": "uuid",
1258 "type": "string"
1259 }
1260 },
1261 {
1262 "name": "key",
1263 "required": false,
1264 "in": "query",
1265 "schema": {
1266 "type": "string"
1267 }
1268 },
1269 {
1270 "name": "slug",
1271 "required": false,
1272 "in": "query",
1273 "schema": {
1274 "type": "string"
1275 }
1276 }
1277 ],
1278 "requestBody": {
1279 "content": {
1280 "application/json": {
1281 "schema": {
1282 "$ref": "#/components/schemas/BulkIdsDto"
1283 }
1284 }
1285 },
1286 "required": true
1287 },
1288 "responses": {
1289 "200": {
1290 "content": {
1291 "application/json": {
1292 "schema": {
1293 "items": {
1294 "$ref": "#/components/schemas/BulkIdResponseDto"
1295 },
1296 "type": "array"
1297 }
1298 }
1299 },
1300 "description": ""
1301 }
1302 },
1303 "security": [
1304 {
1305 "bearer": []
1306 },
1307 {
1308 "cookie": []
1309 },
1310 {
1311 "api_key": []
1312 }
1313 ],
1314 "tags": [
1315 "Albums"
1316 ],
1317 "x-immich-permission": "albumAsset.create",
1318 "description": "This endpoint requires the `albumAsset.create` permission."
1319 }
1320 },
1321 "/albums/{id}/user/{userId}": {
1322 "delete": {
1323 "operationId": "removeUserFromAlbum",
1324 "parameters": [
1325 {
1326 "name": "id",
1327 "required": true,
1328 "in": "path",
1329 "schema": {
1330 "format": "uuid",
1331 "type": "string"
1332 }
1333 },
1334 {
1335 "name": "userId",
1336 "required": true,
1337 "in": "path",
1338 "schema": {
1339 "type": "string"
1340 }
1341 }
1342 ],
1343 "responses": {
1344 "204": {
1345 "description": ""
1346 }
1347 },
1348 "security": [
1349 {
1350 "bearer": []
1351 },
1352 {
1353 "cookie": []
1354 },
1355 {
1356 "api_key": []
1357 }
1358 ],
1359 "tags": [
1360 "Albums"
1361 ],
1362 "x-immich-permission": "albumUser.delete",
1363 "description": "This endpoint requires the `albumUser.delete` permission."
1364 },
1365 "put": {
1366 "operationId": "updateAlbumUser",
1367 "parameters": [
1368 {
1369 "name": "id",
1370 "required": true,
1371 "in": "path",
1372 "schema": {
1373 "format": "uuid",
1374 "type": "string"
1375 }
1376 },
1377 {
1378 "name": "userId",
1379 "required": true,
1380 "in": "path",
1381 "schema": {
1382 "type": "string"
1383 }
1384 }
1385 ],
1386 "requestBody": {
1387 "content": {
1388 "application/json": {
1389 "schema": {
1390 "$ref": "#/components/schemas/UpdateAlbumUserDto"
1391 }
1392 }
1393 },
1394 "required": true
1395 },
1396 "responses": {
1397 "204": {
1398 "description": ""
1399 }
1400 },
1401 "security": [
1402 {
1403 "bearer": []
1404 },
1405 {
1406 "cookie": []
1407 },
1408 {
1409 "api_key": []
1410 }
1411 ],
1412 "tags": [
1413 "Albums"
1414 ],
1415 "x-immich-permission": "albumUser.update",
1416 "description": "This endpoint requires the `albumUser.update` permission."
1417 }
1418 },
1419 "/albums/{id}/users": {
1420 "put": {
1421 "operationId": "addUsersToAlbum",
1422 "parameters": [
1423 {
1424 "name": "id",
1425 "required": true,
1426 "in": "path",
1427 "schema": {
1428 "format": "uuid",
1429 "type": "string"
1430 }
1431 }
1432 ],
1433 "requestBody": {
1434 "content": {
1435 "application/json": {
1436 "schema": {
1437 "$ref": "#/components/schemas/AddUsersDto"
1438 }
1439 }
1440 },
1441 "required": true
1442 },
1443 "responses": {
1444 "200": {
1445 "content": {
1446 "application/json": {
1447 "schema": {
1448 "$ref": "#/components/schemas/AlbumResponseDto"
1449 }
1450 }
1451 },
1452 "description": ""
1453 }
1454 },
1455 "security": [
1456 {
1457 "bearer": []
1458 },
1459 {
1460 "cookie": []
1461 },
1462 {
1463 "api_key": []
1464 }
1465 ],
1466 "tags": [
1467 "Albums"
1468 ],
1469 "x-immich-permission": "albumUser.create",
1470 "description": "This endpoint requires the `albumUser.create` permission."
1471 }
1472 },
1473 "/api-keys": {
1474 "get": {
1475 "operationId": "getApiKeys",
1476 "parameters": [],
1477 "responses": {
1478 "200": {
1479 "content": {
1480 "application/json": {
1481 "schema": {
1482 "items": {
1483 "$ref": "#/components/schemas/APIKeyResponseDto"
1484 },
1485 "type": "array"
1486 }
1487 }
1488 },
1489 "description": ""
1490 }
1491 },
1492 "security": [
1493 {
1494 "bearer": []
1495 },
1496 {
1497 "cookie": []
1498 },
1499 {
1500 "api_key": []
1501 }
1502 ],
1503 "tags": [
1504 "API Keys"
1505 ],
1506 "x-immich-permission": "apiKey.read",
1507 "description": "This endpoint requires the `apiKey.read` permission."
1508 },
1509 "post": {
1510 "operationId": "createApiKey",
1511 "parameters": [],
1512 "requestBody": {
1513 "content": {
1514 "application/json": {
1515 "schema": {
1516 "$ref": "#/components/schemas/APIKeyCreateDto"
1517 }
1518 }
1519 },
1520 "required": true
1521 },
1522 "responses": {
1523 "201": {
1524 "content": {
1525 "application/json": {
1526 "schema": {
1527 "$ref": "#/components/schemas/APIKeyCreateResponseDto"
1528 }
1529 }
1530 },
1531 "description": ""
1532 }
1533 },
1534 "security": [
1535 {
1536 "bearer": []
1537 },
1538 {
1539 "cookie": []
1540 },
1541 {
1542 "api_key": []
1543 }
1544 ],
1545 "tags": [
1546 "API Keys"
1547 ],
1548 "x-immich-permission": "apiKey.create",
1549 "description": "This endpoint requires the `apiKey.create` permission."
1550 }
1551 },
1552 "/api-keys/me": {
1553 "get": {
1554 "operationId": "getMyApiKey",
1555 "parameters": [],
1556 "responses": {
1557 "200": {
1558 "content": {
1559 "application/json": {
1560 "schema": {
1561 "$ref": "#/components/schemas/APIKeyResponseDto"
1562 }
1563 }
1564 },
1565 "description": ""
1566 }
1567 },
1568 "security": [
1569 {
1570 "bearer": []
1571 },
1572 {
1573 "cookie": []
1574 },
1575 {
1576 "api_key": []
1577 }
1578 ],
1579 "tags": [
1580 "API Keys"
1581 ]
1582 }
1583 },
1584 "/api-keys/{id}": {
1585 "delete": {
1586 "operationId": "deleteApiKey",
1587 "parameters": [
1588 {
1589 "name": "id",
1590 "required": true,
1591 "in": "path",
1592 "schema": {
1593 "format": "uuid",
1594 "type": "string"
1595 }
1596 }
1597 ],
1598 "responses": {
1599 "204": {
1600 "description": ""
1601 }
1602 },
1603 "security": [
1604 {
1605 "bearer": []
1606 },
1607 {
1608 "cookie": []
1609 },
1610 {
1611 "api_key": []
1612 }
1613 ],
1614 "tags": [
1615 "API Keys"
1616 ],
1617 "x-immich-permission": "apiKey.delete",
1618 "description": "This endpoint requires the `apiKey.delete` permission."
1619 },
1620 "get": {
1621 "operationId": "getApiKey",
1622 "parameters": [
1623 {
1624 "name": "id",
1625 "required": true,
1626 "in": "path",
1627 "schema": {
1628 "format": "uuid",
1629 "type": "string"
1630 }
1631 }
1632 ],
1633 "responses": {
1634 "200": {
1635 "content": {
1636 "application/json": {
1637 "schema": {
1638 "$ref": "#/components/schemas/APIKeyResponseDto"
1639 }
1640 }
1641 },
1642 "description": ""
1643 }
1644 },
1645 "security": [
1646 {
1647 "bearer": []
1648 },
1649 {
1650 "cookie": []
1651 },
1652 {
1653 "api_key": []
1654 }
1655 ],
1656 "tags": [
1657 "API Keys"
1658 ],
1659 "x-immich-permission": "apiKey.read",
1660 "description": "This endpoint requires the `apiKey.read` permission."
1661 },
1662 "put": {
1663 "operationId": "updateApiKey",
1664 "parameters": [
1665 {
1666 "name": "id",
1667 "required": true,
1668 "in": "path",
1669 "schema": {
1670 "format": "uuid",
1671 "type": "string"
1672 }
1673 }
1674 ],
1675 "requestBody": {
1676 "content": {
1677 "application/json": {
1678 "schema": {
1679 "$ref": "#/components/schemas/APIKeyUpdateDto"
1680 }
1681 }
1682 },
1683 "required": true
1684 },
1685 "responses": {
1686 "200": {
1687 "content": {
1688 "application/json": {
1689 "schema": {
1690 "$ref": "#/components/schemas/APIKeyResponseDto"
1691 }
1692 }
1693 },
1694 "description": ""
1695 }
1696 },
1697 "security": [
1698 {
1699 "bearer": []
1700 },
1701 {
1702 "cookie": []
1703 },
1704 {
1705 "api_key": []
1706 }
1707 ],
1708 "tags": [
1709 "API Keys"
1710 ],
1711 "x-immich-permission": "apiKey.update",
1712 "description": "This endpoint requires the `apiKey.update` permission."
1713 }
1714 },
1715 "/assets": {
1716 "delete": {
1717 "operationId": "deleteAssets",
1718 "parameters": [],
1719 "requestBody": {
1720 "content": {
1721 "application/json": {
1722 "schema": {
1723 "$ref": "#/components/schemas/AssetBulkDeleteDto"
1724 }
1725 }
1726 },
1727 "required": true
1728 },
1729 "responses": {
1730 "204": {
1731 "description": ""
1732 }
1733 },
1734 "security": [
1735 {
1736 "bearer": []
1737 },
1738 {
1739 "cookie": []
1740 },
1741 {
1742 "api_key": []
1743 }
1744 ],
1745 "tags": [
1746 "Assets"
1747 ],
1748 "x-immich-permission": "asset.delete",
1749 "description": "This endpoint requires the `asset.delete` permission."
1750 },
1751 "post": {
1752 "operationId": "uploadAsset",
1753 "parameters": [
1754 {
1755 "name": "key",
1756 "required": false,
1757 "in": "query",
1758 "schema": {
1759 "type": "string"
1760 }
1761 },
1762 {
1763 "name": "slug",
1764 "required": false,
1765 "in": "query",
1766 "schema": {
1767 "type": "string"
1768 }
1769 },
1770 {
1771 "name": "x-immich-checksum",
1772 "in": "header",
1773 "description": "sha1 checksum that can be used for duplicate detection before the file is uploaded",
1774 "required": false,
1775 "schema": {
1776 "type": "string"
1777 }
1778 }
1779 ],
1780 "requestBody": {
1781 "content": {
1782 "multipart/form-data": {
1783 "schema": {
1784 "$ref": "#/components/schemas/AssetMediaCreateDto"
1785 }
1786 }
1787 },
1788 "description": "Asset Upload Information",
1789 "required": true
1790 },
1791 "responses": {
1792 "201": {
1793 "content": {
1794 "application/json": {
1795 "schema": {
1796 "$ref": "#/components/schemas/AssetMediaResponseDto"
1797 }
1798 }
1799 },
1800 "description": ""
1801 }
1802 },
1803 "security": [
1804 {
1805 "bearer": []
1806 },
1807 {
1808 "cookie": []
1809 },
1810 {
1811 "api_key": []
1812 }
1813 ],
1814 "tags": [
1815 "Assets"
1816 ],
1817 "x-immich-permission": "asset.upload",
1818 "description": "This endpoint requires the `asset.upload` permission."
1819 },
1820 "put": {
1821 "operationId": "updateAssets",
1822 "parameters": [],
1823 "requestBody": {
1824 "content": {
1825 "application/json": {
1826 "schema": {
1827 "$ref": "#/components/schemas/AssetBulkUpdateDto"
1828 }
1829 }
1830 },
1831 "required": true
1832 },
1833 "responses": {
1834 "204": {
1835 "description": ""
1836 }
1837 },
1838 "security": [
1839 {
1840 "bearer": []
1841 },
1842 {
1843 "cookie": []
1844 },
1845 {
1846 "api_key": []
1847 }
1848 ],
1849 "tags": [
1850 "Assets"
1851 ],
1852 "x-immich-permission": "asset.update",
1853 "description": "This endpoint requires the `asset.update` permission."
1854 }
1855 },
1856 "/assets/bulk-upload-check": {
1857 "post": {
1858 "description": "Checks if assets exist by checksums. This endpoint requires the `asset.upload` permission.",
1859 "operationId": "checkBulkUpload",
1860 "parameters": [],
1861 "requestBody": {
1862 "content": {
1863 "application/json": {
1864 "schema": {
1865 "$ref": "#/components/schemas/AssetBulkUploadCheckDto"
1866 }
1867 }
1868 },
1869 "required": true
1870 },
1871 "responses": {
1872 "200": {
1873 "content": {
1874 "application/json": {
1875 "schema": {
1876 "$ref": "#/components/schemas/AssetBulkUploadCheckResponseDto"
1877 }
1878 }
1879 },
1880 "description": ""
1881 }
1882 },
1883 "security": [
1884 {
1885 "bearer": []
1886 },
1887 {
1888 "cookie": []
1889 },
1890 {
1891 "api_key": []
1892 }
1893 ],
1894 "summary": "checkBulkUpload",
1895 "tags": [
1896 "Assets"
1897 ],
1898 "x-immich-permission": "asset.upload"
1899 }
1900 },
1901 "/assets/device/{deviceId}": {
1902 "get": {
1903 "description": "Get all asset of a device that are in the database, ID only.",
1904 "operationId": "getAllUserAssetsByDeviceId",
1905 "parameters": [
1906 {
1907 "name": "deviceId",
1908 "required": true,
1909 "in": "path",
1910 "schema": {
1911 "type": "string"
1912 }
1913 }
1914 ],
1915 "responses": {
1916 "200": {
1917 "content": {
1918 "application/json": {
1919 "schema": {
1920 "items": {
1921 "type": "string"
1922 },
1923 "type": "array"
1924 }
1925 }
1926 },
1927 "description": ""
1928 }
1929 },
1930 "security": [
1931 {
1932 "bearer": []
1933 },
1934 {
1935 "cookie": []
1936 },
1937 {
1938 "api_key": []
1939 }
1940 ],
1941 "summary": "getAllUserAssetsByDeviceId",
1942 "tags": [
1943 "Assets"
1944 ]
1945 }
1946 },
1947 "/assets/exist": {
1948 "post": {
1949 "description": "Checks if multiple assets exist on the server and returns all existing - used by background backup",
1950 "operationId": "checkExistingAssets",
1951 "parameters": [],
1952 "requestBody": {
1953 "content": {
1954 "application/json": {
1955 "schema": {
1956 "$ref": "#/components/schemas/CheckExistingAssetsDto"
1957 }
1958 }
1959 },
1960 "required": true
1961 },
1962 "responses": {
1963 "200": {
1964 "content": {
1965 "application/json": {
1966 "schema": {
1967 "$ref": "#/components/schemas/CheckExistingAssetsResponseDto"
1968 }
1969 }
1970 },
1971 "description": ""
1972 }
1973 },
1974 "security": [
1975 {
1976 "bearer": []
1977 },
1978 {
1979 "cookie": []
1980 },
1981 {
1982 "api_key": []
1983 }
1984 ],
1985 "summary": "checkExistingAssets",
1986 "tags": [
1987 "Assets"
1988 ]
1989 }
1990 },
1991 "/assets/jobs": {
1992 "post": {
1993 "operationId": "runAssetJobs",
1994 "parameters": [],
1995 "requestBody": {
1996 "content": {
1997 "application/json": {
1998 "schema": {
1999 "$ref": "#/components/schemas/AssetJobsDto"
2000 }
2001 }
2002 },
2003 "required": true
2004 },
2005 "responses": {
2006 "204": {
2007 "description": ""
2008 }
2009 },
2010 "security": [
2011 {
2012 "bearer": []
2013 },
2014 {
2015 "cookie": []
2016 },
2017 {
2018 "api_key": []
2019 }
2020 ],
2021 "tags": [
2022 "Assets"
2023 ]
2024 }
2025 },
2026 "/assets/random": {
2027 "get": {
2028 "deprecated": true,
2029 "description": "This property was deprecated in v1.116.0. This endpoint requires the `asset.read` permission.",
2030 "operationId": "getRandom",
2031 "parameters": [
2032 {
2033 "name": "count",
2034 "required": false,
2035 "in": "query",
2036 "schema": {
2037 "minimum": 1,
2038 "type": "number"
2039 }
2040 }
2041 ],
2042 "responses": {
2043 "200": {
2044 "content": {
2045 "application/json": {
2046 "schema": {
2047 "items": {
2048 "$ref": "#/components/schemas/AssetResponseDto"
2049 },
2050 "type": "array"
2051 }
2052 }
2053 },
2054 "description": ""
2055 }
2056 },
2057 "security": [
2058 {
2059 "bearer": []
2060 },
2061 {
2062 "cookie": []
2063 },
2064 {
2065 "api_key": []
2066 }
2067 ],
2068 "tags": [
2069 "Assets",
2070 "Deprecated"
2071 ],
2072 "x-immich-lifecycle": {
2073 "deprecatedAt": "v1.116.0"
2074 },
2075 "x-immich-permission": "asset.read"
2076 }
2077 },
2078 "/assets/statistics": {
2079 "get": {
2080 "operationId": "getAssetStatistics",
2081 "parameters": [
2082 {
2083 "name": "isFavorite",
2084 "required": false,
2085 "in": "query",
2086 "schema": {
2087 "type": "boolean"
2088 }
2089 },
2090 {
2091 "name": "isTrashed",
2092 "required": false,
2093 "in": "query",
2094 "schema": {
2095 "type": "boolean"
2096 }
2097 },
2098 {
2099 "name": "visibility",
2100 "required": false,
2101 "in": "query",
2102 "schema": {
2103 "$ref": "#/components/schemas/AssetVisibility"
2104 }
2105 }
2106 ],
2107 "responses": {
2108 "200": {
2109 "content": {
2110 "application/json": {
2111 "schema": {
2112 "$ref": "#/components/schemas/AssetStatsResponseDto"
2113 }
2114 }
2115 },
2116 "description": ""
2117 }
2118 },
2119 "security": [
2120 {
2121 "bearer": []
2122 },
2123 {
2124 "cookie": []
2125 },
2126 {
2127 "api_key": []
2128 }
2129 ],
2130 "tags": [
2131 "Assets"
2132 ],
2133 "x-immich-permission": "asset.statistics",
2134 "description": "This endpoint requires the `asset.statistics` permission."
2135 }
2136 },
2137 "/assets/{id}": {
2138 "get": {
2139 "operationId": "getAssetInfo",
2140 "parameters": [
2141 {
2142 "name": "id",
2143 "required": true,
2144 "in": "path",
2145 "schema": {
2146 "format": "uuid",
2147 "type": "string"
2148 }
2149 },
2150 {
2151 "name": "key",
2152 "required": false,
2153 "in": "query",
2154 "schema": {
2155 "type": "string"
2156 }
2157 },
2158 {
2159 "name": "slug",
2160 "required": false,
2161 "in": "query",
2162 "schema": {
2163 "type": "string"
2164 }
2165 }
2166 ],
2167 "responses": {
2168 "200": {
2169 "content": {
2170 "application/json": {
2171 "schema": {
2172 "$ref": "#/components/schemas/AssetResponseDto"
2173 }
2174 }
2175 },
2176 "description": ""
2177 }
2178 },
2179 "security": [
2180 {
2181 "bearer": []
2182 },
2183 {
2184 "cookie": []
2185 },
2186 {
2187 "api_key": []
2188 }
2189 ],
2190 "tags": [
2191 "Assets"
2192 ],
2193 "x-immich-permission": "asset.read",
2194 "description": "This endpoint requires the `asset.read` permission."
2195 },
2196 "put": {
2197 "operationId": "updateAsset",
2198 "parameters": [
2199 {
2200 "name": "id",
2201 "required": true,
2202 "in": "path",
2203 "schema": {
2204 "format": "uuid",
2205 "type": "string"
2206 }
2207 }
2208 ],
2209 "requestBody": {
2210 "content": {
2211 "application/json": {
2212 "schema": {
2213 "$ref": "#/components/schemas/UpdateAssetDto"
2214 }
2215 }
2216 },
2217 "required": true
2218 },
2219 "responses": {
2220 "200": {
2221 "content": {
2222 "application/json": {
2223 "schema": {
2224 "$ref": "#/components/schemas/AssetResponseDto"
2225 }
2226 }
2227 },
2228 "description": ""
2229 }
2230 },
2231 "security": [
2232 {
2233 "bearer": []
2234 },
2235 {
2236 "cookie": []
2237 },
2238 {
2239 "api_key": []
2240 }
2241 ],
2242 "tags": [
2243 "Assets"
2244 ],
2245 "x-immich-permission": "asset.update",
2246 "description": "This endpoint requires the `asset.update` permission."
2247 }
2248 },
2249 "/assets/{id}/metadata": {
2250 "get": {
2251 "operationId": "getAssetMetadata",
2252 "parameters": [
2253 {
2254 "name": "id",
2255 "required": true,
2256 "in": "path",
2257 "schema": {
2258 "format": "uuid",
2259 "type": "string"
2260 }
2261 }
2262 ],
2263 "responses": {
2264 "200": {
2265 "content": {
2266 "application/json": {
2267 "schema": {
2268 "items": {
2269 "$ref": "#/components/schemas/AssetMetadataResponseDto"
2270 },
2271 "type": "array"
2272 }
2273 }
2274 },
2275 "description": ""
2276 }
2277 },
2278 "security": [
2279 {
2280 "bearer": []
2281 },
2282 {
2283 "cookie": []
2284 },
2285 {
2286 "api_key": []
2287 }
2288 ],
2289 "tags": [
2290 "Assets"
2291 ],
2292 "x-immich-permission": "asset.read",
2293 "description": "This endpoint requires the `asset.read` permission."
2294 },
2295 "put": {
2296 "operationId": "updateAssetMetadata",
2297 "parameters": [
2298 {
2299 "name": "id",
2300 "required": true,
2301 "in": "path",
2302 "schema": {
2303 "format": "uuid",
2304 "type": "string"
2305 }
2306 }
2307 ],
2308 "requestBody": {
2309 "content": {
2310 "application/json": {
2311 "schema": {
2312 "$ref": "#/components/schemas/AssetMetadataUpsertDto"
2313 }
2314 }
2315 },
2316 "required": true
2317 },
2318 "responses": {
2319 "200": {
2320 "content": {
2321 "application/json": {
2322 "schema": {
2323 "items": {
2324 "$ref": "#/components/schemas/AssetMetadataResponseDto"
2325 },
2326 "type": "array"
2327 }
2328 }
2329 },
2330 "description": ""
2331 }
2332 },
2333 "security": [
2334 {
2335 "bearer": []
2336 },
2337 {
2338 "cookie": []
2339 },
2340 {
2341 "api_key": []
2342 }
2343 ],
2344 "tags": [
2345 "Assets"
2346 ],
2347 "x-immich-permission": "asset.update",
2348 "description": "This endpoint requires the `asset.update` permission."
2349 }
2350 },
2351 "/assets/{id}/metadata/{key}": {
2352 "delete": {
2353 "operationId": "deleteAssetMetadata",
2354 "parameters": [
2355 {
2356 "name": "id",
2357 "required": true,
2358 "in": "path",
2359 "schema": {
2360 "format": "uuid",
2361 "type": "string"
2362 }
2363 },
2364 {
2365 "name": "key",
2366 "required": true,
2367 "in": "path",
2368 "schema": {
2369 "$ref": "#/components/schemas/AssetMetadataKey"
2370 }
2371 }
2372 ],
2373 "responses": {
2374 "204": {
2375 "description": ""
2376 }
2377 },
2378 "security": [
2379 {
2380 "bearer": []
2381 },
2382 {
2383 "cookie": []
2384 },
2385 {
2386 "api_key": []
2387 }
2388 ],
2389 "tags": [
2390 "Assets"
2391 ],
2392 "x-immich-permission": "asset.update",
2393 "description": "This endpoint requires the `asset.update` permission."
2394 },
2395 "get": {
2396 "operationId": "getAssetMetadataByKey",
2397 "parameters": [
2398 {
2399 "name": "id",
2400 "required": true,
2401 "in": "path",
2402 "schema": {
2403 "format": "uuid",
2404 "type": "string"
2405 }
2406 },
2407 {
2408 "name": "key",
2409 "required": true,
2410 "in": "path",
2411 "schema": {
2412 "$ref": "#/components/schemas/AssetMetadataKey"
2413 }
2414 }
2415 ],
2416 "responses": {
2417 "200": {
2418 "content": {
2419 "application/json": {
2420 "schema": {
2421 "$ref": "#/components/schemas/AssetMetadataResponseDto"
2422 }
2423 }
2424 },
2425 "description": ""
2426 }
2427 },
2428 "security": [
2429 {
2430 "bearer": []
2431 },
2432 {
2433 "cookie": []
2434 },
2435 {
2436 "api_key": []
2437 }
2438 ],
2439 "tags": [
2440 "Assets"
2441 ],
2442 "x-immich-permission": "asset.read",
2443 "description": "This endpoint requires the `asset.read` permission."
2444 }
2445 },
2446 "/assets/{id}/original": {
2447 "get": {
2448 "operationId": "downloadAsset",
2449 "parameters": [
2450 {
2451 "name": "id",
2452 "required": true,
2453 "in": "path",
2454 "schema": {
2455 "format": "uuid",
2456 "type": "string"
2457 }
2458 },
2459 {
2460 "name": "key",
2461 "required": false,
2462 "in": "query",
2463 "schema": {
2464 "type": "string"
2465 }
2466 },
2467 {
2468 "name": "slug",
2469 "required": false,
2470 "in": "query",
2471 "schema": {
2472 "type": "string"
2473 }
2474 }
2475 ],
2476 "responses": {
2477 "200": {
2478 "content": {
2479 "application/octet-stream": {
2480 "schema": {
2481 "format": "binary",
2482 "type": "string"
2483 }
2484 }
2485 },
2486 "description": ""
2487 }
2488 },
2489 "security": [
2490 {
2491 "bearer": []
2492 },
2493 {
2494 "cookie": []
2495 },
2496 {
2497 "api_key": []
2498 }
2499 ],
2500 "tags": [
2501 "Assets"
2502 ],
2503 "x-immich-permission": "asset.download",
2504 "description": "This endpoint requires the `asset.download` permission."
2505 },
2506 "put": {
2507 "deprecated": true,
2508 "description": "This property was deprecated in v1.142.0. Replace the asset with new file, without changing its id. This endpoint requires the `asset.replace` permission.",
2509 "operationId": "replaceAsset",
2510 "parameters": [
2511 {
2512 "name": "id",
2513 "required": true,
2514 "in": "path",
2515 "schema": {
2516 "format": "uuid",
2517 "type": "string"
2518 }
2519 },
2520 {
2521 "name": "key",
2522 "required": false,
2523 "in": "query",
2524 "schema": {
2525 "type": "string"
2526 }
2527 },
2528 {
2529 "name": "slug",
2530 "required": false,
2531 "in": "query",
2532 "schema": {
2533 "type": "string"
2534 }
2535 }
2536 ],
2537 "requestBody": {
2538 "content": {
2539 "multipart/form-data": {
2540 "schema": {
2541 "$ref": "#/components/schemas/AssetMediaReplaceDto"
2542 }
2543 }
2544 },
2545 "required": true
2546 },
2547 "responses": {
2548 "200": {
2549 "content": {
2550 "application/json": {
2551 "schema": {
2552 "$ref": "#/components/schemas/AssetMediaResponseDto"
2553 }
2554 }
2555 },
2556 "description": ""
2557 }
2558 },
2559 "security": [
2560 {
2561 "bearer": []
2562 },
2563 {
2564 "cookie": []
2565 },
2566 {
2567 "api_key": []
2568 }
2569 ],
2570 "summary": "Replace the asset with new file, without changing its id",
2571 "tags": [
2572 "Assets",
2573 "Deprecated"
2574 ],
2575 "x-immich-lifecycle": {
2576 "addedAt": "v1.106.0",
2577 "deprecatedAt": "v1.142.0"
2578 },
2579 "x-immich-permission": "asset.replace"
2580 }
2581 },
2582 "/assets/{id}/thumbnail": {
2583 "get": {
2584 "operationId": "viewAsset",
2585 "parameters": [
2586 {
2587 "name": "id",
2588 "required": true,
2589 "in": "path",
2590 "schema": {
2591 "format": "uuid",
2592 "type": "string"
2593 }
2594 },
2595 {
2596 "name": "key",
2597 "required": false,
2598 "in": "query",
2599 "schema": {
2600 "type": "string"
2601 }
2602 },
2603 {
2604 "name": "size",
2605 "required": false,
2606 "in": "query",
2607 "schema": {
2608 "$ref": "#/components/schemas/AssetMediaSize"
2609 }
2610 },
2611 {
2612 "name": "slug",
2613 "required": false,
2614 "in": "query",
2615 "schema": {
2616 "type": "string"
2617 }
2618 }
2619 ],
2620 "responses": {
2621 "200": {
2622 "content": {
2623 "application/octet-stream": {
2624 "schema": {
2625 "format": "binary",
2626 "type": "string"
2627 }
2628 }
2629 },
2630 "description": ""
2631 }
2632 },
2633 "security": [
2634 {
2635 "bearer": []
2636 },
2637 {
2638 "cookie": []
2639 },
2640 {
2641 "api_key": []
2642 }
2643 ],
2644 "tags": [
2645 "Assets"
2646 ],
2647 "x-immich-permission": "asset.view",
2648 "description": "This endpoint requires the `asset.view` permission."
2649 }
2650 },
2651 "/assets/{id}/video/playback": {
2652 "get": {
2653 "operationId": "playAssetVideo",
2654 "parameters": [
2655 {
2656 "name": "id",
2657 "required": true,
2658 "in": "path",
2659 "schema": {
2660 "format": "uuid",
2661 "type": "string"
2662 }
2663 },
2664 {
2665 "name": "key",
2666 "required": false,
2667 "in": "query",
2668 "schema": {
2669 "type": "string"
2670 }
2671 },
2672 {
2673 "name": "slug",
2674 "required": false,
2675 "in": "query",
2676 "schema": {
2677 "type": "string"
2678 }
2679 }
2680 ],
2681 "responses": {
2682 "200": {
2683 "content": {
2684 "application/octet-stream": {
2685 "schema": {
2686 "format": "binary",
2687 "type": "string"
2688 }
2689 }
2690 },
2691 "description": ""
2692 }
2693 },
2694 "security": [
2695 {
2696 "bearer": []
2697 },
2698 {
2699 "cookie": []
2700 },
2701 {
2702 "api_key": []
2703 }
2704 ],
2705 "tags": [
2706 "Assets"
2707 ],
2708 "x-immich-permission": "asset.view",
2709 "description": "This endpoint requires the `asset.view` permission."
2710 }
2711 },
2712 "/auth/admin-sign-up": {
2713 "post": {
2714 "operationId": "signUpAdmin",
2715 "parameters": [],
2716 "requestBody": {
2717 "content": {
2718 "application/json": {
2719 "schema": {
2720 "$ref": "#/components/schemas/SignUpDto"
2721 }
2722 }
2723 },
2724 "required": true
2725 },
2726 "responses": {
2727 "201": {
2728 "content": {
2729 "application/json": {
2730 "schema": {
2731 "$ref": "#/components/schemas/UserAdminResponseDto"
2732 }
2733 }
2734 },
2735 "description": ""
2736 }
2737 },
2738 "tags": [
2739 "Authentication"
2740 ]
2741 }
2742 },
2743 "/auth/change-password": {
2744 "post": {
2745 "operationId": "changePassword",
2746 "parameters": [],
2747 "requestBody": {
2748 "content": {
2749 "application/json": {
2750 "schema": {
2751 "$ref": "#/components/schemas/ChangePasswordDto"
2752 }
2753 }
2754 },
2755 "required": true
2756 },
2757 "responses": {
2758 "200": {
2759 "content": {
2760 "application/json": {
2761 "schema": {
2762 "$ref": "#/components/schemas/UserAdminResponseDto"
2763 }
2764 }
2765 },
2766 "description": ""
2767 }
2768 },
2769 "security": [
2770 {
2771 "bearer": []
2772 },
2773 {
2774 "cookie": []
2775 },
2776 {
2777 "api_key": []
2778 }
2779 ],
2780 "tags": [
2781 "Authentication"
2782 ],
2783 "x-immich-permission": "auth.changePassword",
2784 "description": "This endpoint requires the `auth.changePassword` permission."
2785 }
2786 },
2787 "/auth/login": {
2788 "post": {
2789 "operationId": "login",
2790 "parameters": [],
2791 "requestBody": {
2792 "content": {
2793 "application/json": {
2794 "schema": {
2795 "$ref": "#/components/schemas/LoginCredentialDto"
2796 }
2797 }
2798 },
2799 "required": true
2800 },
2801 "responses": {
2802 "201": {
2803 "content": {
2804 "application/json": {
2805 "schema": {
2806 "$ref": "#/components/schemas/LoginResponseDto"
2807 }
2808 }
2809 },
2810 "description": ""
2811 }
2812 },
2813 "tags": [
2814 "Authentication"
2815 ]
2816 }
2817 },
2818 "/auth/logout": {
2819 "post": {
2820 "operationId": "logout",
2821 "parameters": [],
2822 "responses": {
2823 "200": {
2824 "content": {
2825 "application/json": {
2826 "schema": {
2827 "$ref": "#/components/schemas/LogoutResponseDto"
2828 }
2829 }
2830 },
2831 "description": ""
2832 }
2833 },
2834 "security": [
2835 {
2836 "bearer": []
2837 },
2838 {
2839 "cookie": []
2840 },
2841 {
2842 "api_key": []
2843 }
2844 ],
2845 "tags": [
2846 "Authentication"
2847 ]
2848 }
2849 },
2850 "/auth/pin-code": {
2851 "delete": {
2852 "operationId": "resetPinCode",
2853 "parameters": [],
2854 "requestBody": {
2855 "content": {
2856 "application/json": {
2857 "schema": {
2858 "$ref": "#/components/schemas/PinCodeResetDto"
2859 }
2860 }
2861 },
2862 "required": true
2863 },
2864 "responses": {
2865 "204": {
2866 "description": ""
2867 }
2868 },
2869 "security": [
2870 {
2871 "bearer": []
2872 },
2873 {
2874 "cookie": []
2875 },
2876 {
2877 "api_key": []
2878 }
2879 ],
2880 "tags": [
2881 "Authentication"
2882 ],
2883 "x-immich-permission": "pinCode.delete",
2884 "description": "This endpoint requires the `pinCode.delete` permission."
2885 },
2886 "post": {
2887 "operationId": "setupPinCode",
2888 "parameters": [],
2889 "requestBody": {
2890 "content": {
2891 "application/json": {
2892 "schema": {
2893 "$ref": "#/components/schemas/PinCodeSetupDto"
2894 }
2895 }
2896 },
2897 "required": true
2898 },
2899 "responses": {
2900 "204": {
2901 "description": ""
2902 }
2903 },
2904 "security": [
2905 {
2906 "bearer": []
2907 },
2908 {
2909 "cookie": []
2910 },
2911 {
2912 "api_key": []
2913 }
2914 ],
2915 "tags": [
2916 "Authentication"
2917 ],
2918 "x-immich-permission": "pinCode.create",
2919 "description": "This endpoint requires the `pinCode.create` permission."
2920 },
2921 "put": {
2922 "operationId": "changePinCode",
2923 "parameters": [],
2924 "requestBody": {
2925 "content": {
2926 "application/json": {
2927 "schema": {
2928 "$ref": "#/components/schemas/PinCodeChangeDto"
2929 }
2930 }
2931 },
2932 "required": true
2933 },
2934 "responses": {
2935 "204": {
2936 "description": ""
2937 }
2938 },
2939 "security": [
2940 {
2941 "bearer": []
2942 },
2943 {
2944 "cookie": []
2945 },
2946 {
2947 "api_key": []
2948 }
2949 ],
2950 "tags": [
2951 "Authentication"
2952 ],
2953 "x-immich-permission": "pinCode.update",
2954 "description": "This endpoint requires the `pinCode.update` permission."
2955 }
2956 },
2957 "/auth/session/lock": {
2958 "post": {
2959 "operationId": "lockAuthSession",
2960 "parameters": [],
2961 "responses": {
2962 "204": {
2963 "description": ""
2964 }
2965 },
2966 "security": [
2967 {
2968 "bearer": []
2969 },
2970 {
2971 "cookie": []
2972 },
2973 {
2974 "api_key": []
2975 }
2976 ],
2977 "tags": [
2978 "Authentication"
2979 ]
2980 }
2981 },
2982 "/auth/session/unlock": {
2983 "post": {
2984 "operationId": "unlockAuthSession",
2985 "parameters": [],
2986 "requestBody": {
2987 "content": {
2988 "application/json": {
2989 "schema": {
2990 "$ref": "#/components/schemas/SessionUnlockDto"
2991 }
2992 }
2993 },
2994 "required": true
2995 },
2996 "responses": {
2997 "204": {
2998 "description": ""
2999 }
3000 },
3001 "security": [
3002 {
3003 "bearer": []
3004 },
3005 {
3006 "cookie": []
3007 },
3008 {
3009 "api_key": []
3010 }
3011 ],
3012 "tags": [
3013 "Authentication"
3014 ]
3015 }
3016 },
3017 "/auth/status": {
3018 "get": {
3019 "operationId": "getAuthStatus",
3020 "parameters": [],
3021 "responses": {
3022 "200": {
3023 "content": {
3024 "application/json": {
3025 "schema": {
3026 "$ref": "#/components/schemas/AuthStatusResponseDto"
3027 }
3028 }
3029 },
3030 "description": ""
3031 }
3032 },
3033 "security": [
3034 {
3035 "bearer": []
3036 },
3037 {
3038 "cookie": []
3039 },
3040 {
3041 "api_key": []
3042 }
3043 ],
3044 "tags": [
3045 "Authentication"
3046 ]
3047 }
3048 },
3049 "/auth/validateToken": {
3050 "post": {
3051 "operationId": "validateAccessToken",
3052 "parameters": [],
3053 "responses": {
3054 "200": {
3055 "content": {
3056 "application/json": {
3057 "schema": {
3058 "$ref": "#/components/schemas/ValidateAccessTokenResponseDto"
3059 }
3060 }
3061 },
3062 "description": ""
3063 }
3064 },
3065 "security": [
3066 {
3067 "bearer": []
3068 },
3069 {
3070 "cookie": []
3071 },
3072 {
3073 "api_key": []
3074 }
3075 ],
3076 "tags": [
3077 "Authentication"
3078 ]
3079 }
3080 },
3081 "/download/archive": {
3082 "post": {
3083 "operationId": "downloadArchive",
3084 "parameters": [
3085 {
3086 "name": "key",
3087 "required": false,
3088 "in": "query",
3089 "schema": {
3090 "type": "string"
3091 }
3092 },
3093 {
3094 "name": "slug",
3095 "required": false,
3096 "in": "query",
3097 "schema": {
3098 "type": "string"
3099 }
3100 }
3101 ],
3102 "requestBody": {
3103 "content": {
3104 "application/json": {
3105 "schema": {
3106 "$ref": "#/components/schemas/AssetIdsDto"
3107 }
3108 }
3109 },
3110 "required": true
3111 },
3112 "responses": {
3113 "200": {
3114 "content": {
3115 "application/octet-stream": {
3116 "schema": {
3117 "format": "binary",
3118 "type": "string"
3119 }
3120 }
3121 },
3122 "description": ""
3123 }
3124 },
3125 "security": [
3126 {
3127 "bearer": []
3128 },
3129 {
3130 "cookie": []
3131 },
3132 {
3133 "api_key": []
3134 }
3135 ],
3136 "tags": [
3137 "Download"
3138 ],
3139 "x-immich-permission": "asset.download",
3140 "description": "This endpoint requires the `asset.download` permission."
3141 }
3142 },
3143 "/download/info": {
3144 "post": {
3145 "operationId": "getDownloadInfo",
3146 "parameters": [
3147 {
3148 "name": "key",
3149 "required": false,
3150 "in": "query",
3151 "schema": {
3152 "type": "string"
3153 }
3154 },
3155 {
3156 "name": "slug",
3157 "required": false,
3158 "in": "query",
3159 "schema": {
3160 "type": "string"
3161 }
3162 }
3163 ],
3164 "requestBody": {
3165 "content": {
3166 "application/json": {
3167 "schema": {
3168 "$ref": "#/components/schemas/DownloadInfoDto"
3169 }
3170 }
3171 },
3172 "required": true
3173 },
3174 "responses": {
3175 "201": {
3176 "content": {
3177 "application/json": {
3178 "schema": {
3179 "$ref": "#/components/schemas/DownloadResponseDto"
3180 }
3181 }
3182 },
3183 "description": ""
3184 }
3185 },
3186 "security": [
3187 {
3188 "bearer": []
3189 },
3190 {
3191 "cookie": []
3192 },
3193 {
3194 "api_key": []
3195 }
3196 ],
3197 "tags": [
3198 "Download"
3199 ],
3200 "x-immich-permission": "asset.download",
3201 "description": "This endpoint requires the `asset.download` permission."
3202 }
3203 },
3204 "/duplicates": {
3205 "delete": {
3206 "operationId": "deleteDuplicates",
3207 "parameters": [],
3208 "requestBody": {
3209 "content": {
3210 "application/json": {
3211 "schema": {
3212 "$ref": "#/components/schemas/BulkIdsDto"
3213 }
3214 }
3215 },
3216 "required": true
3217 },
3218 "responses": {
3219 "204": {
3220 "description": ""
3221 }
3222 },
3223 "security": [
3224 {
3225 "bearer": []
3226 },
3227 {
3228 "cookie": []
3229 },
3230 {
3231 "api_key": []
3232 }
3233 ],
3234 "tags": [
3235 "Duplicates"
3236 ],
3237 "x-immich-permission": "duplicate.delete",
3238 "description": "This endpoint requires the `duplicate.delete` permission."
3239 },
3240 "get": {
3241 "operationId": "getAssetDuplicates",
3242 "parameters": [],
3243 "responses": {
3244 "200": {
3245 "content": {
3246 "application/json": {
3247 "schema": {
3248 "items": {
3249 "$ref": "#/components/schemas/DuplicateResponseDto"
3250 },
3251 "type": "array"
3252 }
3253 }
3254 },
3255 "description": ""
3256 }
3257 },
3258 "security": [
3259 {
3260 "bearer": []
3261 },
3262 {
3263 "cookie": []
3264 },
3265 {
3266 "api_key": []
3267 }
3268 ],
3269 "tags": [
3270 "Duplicates"
3271 ],
3272 "x-immich-permission": "duplicate.read",
3273 "description": "This endpoint requires the `duplicate.read` permission."
3274 }
3275 },
3276 "/duplicates/{id}": {
3277 "delete": {
3278 "operationId": "deleteDuplicate",
3279 "parameters": [
3280 {
3281 "name": "id",
3282 "required": true,
3283 "in": "path",
3284 "schema": {
3285 "format": "uuid",
3286 "type": "string"
3287 }
3288 }
3289 ],
3290 "responses": {
3291 "204": {
3292 "description": ""
3293 }
3294 },
3295 "security": [
3296 {
3297 "bearer": []
3298 },
3299 {
3300 "cookie": []
3301 },
3302 {
3303 "api_key": []
3304 }
3305 ],
3306 "tags": [
3307 "Duplicates"
3308 ],
3309 "x-immich-permission": "duplicate.delete",
3310 "description": "This endpoint requires the `duplicate.delete` permission."
3311 }
3312 },
3313 "/faces": {
3314 "get": {
3315 "operationId": "getFaces",
3316 "parameters": [
3317 {
3318 "name": "id",
3319 "required": true,
3320 "in": "query",
3321 "schema": {
3322 "format": "uuid",
3323 "type": "string"
3324 }
3325 }
3326 ],
3327 "responses": {
3328 "200": {
3329 "content": {
3330 "application/json": {
3331 "schema": {
3332 "items": {
3333 "$ref": "#/components/schemas/AssetFaceResponseDto"
3334 },
3335 "type": "array"
3336 }
3337 }
3338 },
3339 "description": ""
3340 }
3341 },
3342 "security": [
3343 {
3344 "bearer": []
3345 },
3346 {
3347 "cookie": []
3348 },
3349 {
3350 "api_key": []
3351 }
3352 ],
3353 "tags": [
3354 "Faces"
3355 ],
3356 "x-immich-permission": "face.read",
3357 "description": "This endpoint requires the `face.read` permission."
3358 },
3359 "post": {
3360 "operationId": "createFace",
3361 "parameters": [],
3362 "requestBody": {
3363 "content": {
3364 "application/json": {
3365 "schema": {
3366 "$ref": "#/components/schemas/AssetFaceCreateDto"
3367 }
3368 }
3369 },
3370 "required": true
3371 },
3372 "responses": {
3373 "201": {
3374 "description": ""
3375 }
3376 },
3377 "security": [
3378 {
3379 "bearer": []
3380 },
3381 {
3382 "cookie": []
3383 },
3384 {
3385 "api_key": []
3386 }
3387 ],
3388 "tags": [
3389 "Faces"
3390 ],
3391 "x-immich-permission": "face.create",
3392 "description": "This endpoint requires the `face.create` permission."
3393 }
3394 },
3395 "/faces/{id}": {
3396 "delete": {
3397 "operationId": "deleteFace",
3398 "parameters": [
3399 {
3400 "name": "id",
3401 "required": true,
3402 "in": "path",
3403 "schema": {
3404 "format": "uuid",
3405 "type": "string"
3406 }
3407 }
3408 ],
3409 "requestBody": {
3410 "content": {
3411 "application/json": {
3412 "schema": {
3413 "$ref": "#/components/schemas/AssetFaceDeleteDto"
3414 }
3415 }
3416 },
3417 "required": true
3418 },
3419 "responses": {
3420 "204": {
3421 "description": ""
3422 }
3423 },
3424 "security": [
3425 {
3426 "bearer": []
3427 },
3428 {
3429 "cookie": []
3430 },
3431 {
3432 "api_key": []
3433 }
3434 ],
3435 "tags": [
3436 "Faces"
3437 ],
3438 "x-immich-permission": "face.delete",
3439 "description": "This endpoint requires the `face.delete` permission."
3440 },
3441 "put": {
3442 "operationId": "reassignFacesById",
3443 "parameters": [
3444 {
3445 "name": "id",
3446 "required": true,
3447 "in": "path",
3448 "schema": {
3449 "format": "uuid",
3450 "type": "string"
3451 }
3452 }
3453 ],
3454 "requestBody": {
3455 "content": {
3456 "application/json": {
3457 "schema": {
3458 "$ref": "#/components/schemas/FaceDto"
3459 }
3460 }
3461 },
3462 "required": true
3463 },
3464 "responses": {
3465 "200": {
3466 "content": {
3467 "application/json": {
3468 "schema": {
3469 "$ref": "#/components/schemas/PersonResponseDto"
3470 }
3471 }
3472 },
3473 "description": ""
3474 }
3475 },
3476 "security": [
3477 {
3478 "bearer": []
3479 },
3480 {
3481 "cookie": []
3482 },
3483 {
3484 "api_key": []
3485 }
3486 ],
3487 "tags": [
3488 "Faces"
3489 ],
3490 "x-immich-permission": "face.update",
3491 "description": "This endpoint requires the `face.update` permission."
3492 }
3493 },
3494 "/jobs": {
3495 "get": {
3496 "operationId": "getAllJobsStatus",
3497 "parameters": [],
3498 "responses": {
3499 "200": {
3500 "content": {
3501 "application/json": {
3502 "schema": {
3503 "$ref": "#/components/schemas/AllJobStatusResponseDto"
3504 }
3505 }
3506 },
3507 "description": ""
3508 }
3509 },
3510 "security": [
3511 {
3512 "bearer": []
3513 },
3514 {
3515 "cookie": []
3516 },
3517 {
3518 "api_key": []
3519 }
3520 ],
3521 "tags": [
3522 "Jobs"
3523 ],
3524 "x-immich-admin-only": true,
3525 "x-immich-permission": "job.read",
3526 "description": "This endpoint is an admin-only route, and requires the `job.read` permission."
3527 },
3528 "post": {
3529 "operationId": "createJob",
3530 "parameters": [],
3531 "requestBody": {
3532 "content": {
3533 "application/json": {
3534 "schema": {
3535 "$ref": "#/components/schemas/JobCreateDto"
3536 }
3537 }
3538 },
3539 "required": true
3540 },
3541 "responses": {
3542 "204": {
3543 "description": ""
3544 }
3545 },
3546 "security": [
3547 {
3548 "bearer": []
3549 },
3550 {
3551 "cookie": []
3552 },
3553 {
3554 "api_key": []
3555 }
3556 ],
3557 "tags": [
3558 "Jobs"
3559 ],
3560 "x-immich-admin-only": true,
3561 "x-immich-permission": "job.create",
3562 "description": "This endpoint is an admin-only route, and requires the `job.create` permission."
3563 }
3564 },
3565 "/jobs/{id}": {
3566 "put": {
3567 "operationId": "sendJobCommand",
3568 "parameters": [
3569 {
3570 "name": "id",
3571 "required": true,
3572 "in": "path",
3573 "schema": {
3574 "$ref": "#/components/schemas/JobName"
3575 }
3576 }
3577 ],
3578 "requestBody": {
3579 "content": {
3580 "application/json": {
3581 "schema": {
3582 "$ref": "#/components/schemas/JobCommandDto"
3583 }
3584 }
3585 },
3586 "required": true
3587 },
3588 "responses": {
3589 "200": {
3590 "content": {
3591 "application/json": {
3592 "schema": {
3593 "$ref": "#/components/schemas/JobStatusDto"
3594 }
3595 }
3596 },
3597 "description": ""
3598 }
3599 },
3600 "security": [
3601 {
3602 "bearer": []
3603 },
3604 {
3605 "cookie": []
3606 },
3607 {
3608 "api_key": []
3609 }
3610 ],
3611 "tags": [
3612 "Jobs"
3613 ],
3614 "x-immich-admin-only": true,
3615 "x-immich-permission": "job.create",
3616 "description": "This endpoint is an admin-only route, and requires the `job.create` permission."
3617 }
3618 },
3619 "/libraries": {
3620 "get": {
3621 "operationId": "getAllLibraries",
3622 "parameters": [],
3623 "responses": {
3624 "200": {
3625 "content": {
3626 "application/json": {
3627 "schema": {
3628 "items": {
3629 "$ref": "#/components/schemas/LibraryResponseDto"
3630 },
3631 "type": "array"
3632 }
3633 }
3634 },
3635 "description": ""
3636 }
3637 },
3638 "security": [
3639 {
3640 "bearer": []
3641 },
3642 {
3643 "cookie": []
3644 },
3645 {
3646 "api_key": []
3647 }
3648 ],
3649 "tags": [
3650 "Libraries"
3651 ],
3652 "x-immich-admin-only": true,
3653 "x-immich-permission": "library.read",
3654 "description": "This endpoint is an admin-only route, and requires the `library.read` permission."
3655 },
3656 "post": {
3657 "operationId": "createLibrary",
3658 "parameters": [],
3659 "requestBody": {
3660 "content": {
3661 "application/json": {
3662 "schema": {
3663 "$ref": "#/components/schemas/CreateLibraryDto"
3664 }
3665 }
3666 },
3667 "required": true
3668 },
3669 "responses": {
3670 "201": {
3671 "content": {
3672 "application/json": {
3673 "schema": {
3674 "$ref": "#/components/schemas/LibraryResponseDto"
3675 }
3676 }
3677 },
3678 "description": ""
3679 }
3680 },
3681 "security": [
3682 {
3683 "bearer": []
3684 },
3685 {
3686 "cookie": []
3687 },
3688 {
3689 "api_key": []
3690 }
3691 ],
3692 "tags": [
3693 "Libraries"
3694 ],
3695 "x-immich-admin-only": true,
3696 "x-immich-permission": "library.create",
3697 "description": "This endpoint is an admin-only route, and requires the `library.create` permission."
3698 }
3699 },
3700 "/libraries/{id}": {
3701 "delete": {
3702 "operationId": "deleteLibrary",
3703 "parameters": [
3704 {
3705 "name": "id",
3706 "required": true,
3707 "in": "path",
3708 "schema": {
3709 "format": "uuid",
3710 "type": "string"
3711 }
3712 }
3713 ],
3714 "responses": {
3715 "204": {
3716 "description": ""
3717 }
3718 },
3719 "security": [
3720 {
3721 "bearer": []
3722 },
3723 {
3724 "cookie": []
3725 },
3726 {
3727 "api_key": []
3728 }
3729 ],
3730 "tags": [
3731 "Libraries"
3732 ],
3733 "x-immich-admin-only": true,
3734 "x-immich-permission": "library.delete",
3735 "description": "This endpoint is an admin-only route, and requires the `library.delete` permission."
3736 },
3737 "get": {
3738 "operationId": "getLibrary",
3739 "parameters": [
3740 {
3741 "name": "id",
3742 "required": true,
3743 "in": "path",
3744 "schema": {
3745 "format": "uuid",
3746 "type": "string"
3747 }
3748 }
3749 ],
3750 "responses": {
3751 "200": {
3752 "content": {
3753 "application/json": {
3754 "schema": {
3755 "$ref": "#/components/schemas/LibraryResponseDto"
3756 }
3757 }
3758 },
3759 "description": ""
3760 }
3761 },
3762 "security": [
3763 {
3764 "bearer": []
3765 },
3766 {
3767 "cookie": []
3768 },
3769 {
3770 "api_key": []
3771 }
3772 ],
3773 "tags": [
3774 "Libraries"
3775 ],
3776 "x-immich-admin-only": true,
3777 "x-immich-permission": "library.read",
3778 "description": "This endpoint is an admin-only route, and requires the `library.read` permission."
3779 },
3780 "put": {
3781 "operationId": "updateLibrary",
3782 "parameters": [
3783 {
3784 "name": "id",
3785 "required": true,
3786 "in": "path",
3787 "schema": {
3788 "format": "uuid",
3789 "type": "string"
3790 }
3791 }
3792 ],
3793 "requestBody": {
3794 "content": {
3795 "application/json": {
3796 "schema": {
3797 "$ref": "#/components/schemas/UpdateLibraryDto"
3798 }
3799 }
3800 },
3801 "required": true
3802 },
3803 "responses": {
3804 "200": {
3805 "content": {
3806 "application/json": {
3807 "schema": {
3808 "$ref": "#/components/schemas/LibraryResponseDto"
3809 }
3810 }
3811 },
3812 "description": ""
3813 }
3814 },
3815 "security": [
3816 {
3817 "bearer": []
3818 },
3819 {
3820 "cookie": []
3821 },
3822 {
3823 "api_key": []
3824 }
3825 ],
3826 "tags": [
3827 "Libraries"
3828 ],
3829 "x-immich-admin-only": true,
3830 "x-immich-permission": "library.update",
3831 "description": "This endpoint is an admin-only route, and requires the `library.update` permission."
3832 }
3833 },
3834 "/libraries/{id}/scan": {
3835 "post": {
3836 "operationId": "scanLibrary",
3837 "parameters": [
3838 {
3839 "name": "id",
3840 "required": true,
3841 "in": "path",
3842 "schema": {
3843 "format": "uuid",
3844 "type": "string"
3845 }
3846 }
3847 ],
3848 "responses": {
3849 "204": {
3850 "description": ""
3851 }
3852 },
3853 "security": [
3854 {
3855 "bearer": []
3856 },
3857 {
3858 "cookie": []
3859 },
3860 {
3861 "api_key": []
3862 }
3863 ],
3864 "tags": [
3865 "Libraries"
3866 ],
3867 "x-immich-admin-only": true,
3868 "x-immich-permission": "library.update",
3869 "description": "This endpoint is an admin-only route, and requires the `library.update` permission."
3870 }
3871 },
3872 "/libraries/{id}/statistics": {
3873 "get": {
3874 "operationId": "getLibraryStatistics",
3875 "parameters": [
3876 {
3877 "name": "id",
3878 "required": true,
3879 "in": "path",
3880 "schema": {
3881 "format": "uuid",
3882 "type": "string"
3883 }
3884 }
3885 ],
3886 "responses": {
3887 "200": {
3888 "content": {
3889 "application/json": {
3890 "schema": {
3891 "$ref": "#/components/schemas/LibraryStatsResponseDto"
3892 }
3893 }
3894 },
3895 "description": ""
3896 }
3897 },
3898 "security": [
3899 {
3900 "bearer": []
3901 },
3902 {
3903 "cookie": []
3904 },
3905 {
3906 "api_key": []
3907 }
3908 ],
3909 "tags": [
3910 "Libraries"
3911 ],
3912 "x-immich-admin-only": true,
3913 "x-immich-permission": "library.statistics",
3914 "description": "This endpoint is an admin-only route, and requires the `library.statistics` permission."
3915 }
3916 },
3917 "/libraries/{id}/validate": {
3918 "post": {
3919 "operationId": "validate",
3920 "parameters": [
3921 {
3922 "name": "id",
3923 "required": true,
3924 "in": "path",
3925 "schema": {
3926 "format": "uuid",
3927 "type": "string"
3928 }
3929 }
3930 ],
3931 "requestBody": {
3932 "content": {
3933 "application/json": {
3934 "schema": {
3935 "$ref": "#/components/schemas/ValidateLibraryDto"
3936 }
3937 }
3938 },
3939 "required": true
3940 },
3941 "responses": {
3942 "200": {
3943 "content": {
3944 "application/json": {
3945 "schema": {
3946 "$ref": "#/components/schemas/ValidateLibraryResponseDto"
3947 }
3948 }
3949 },
3950 "description": ""
3951 }
3952 },
3953 "security": [
3954 {
3955 "bearer": []
3956 },
3957 {
3958 "cookie": []
3959 },
3960 {
3961 "api_key": []
3962 }
3963 ],
3964 "tags": [
3965 "Libraries"
3966 ],
3967 "x-immich-admin-only": true
3968 }
3969 },
3970 "/map/markers": {
3971 "get": {
3972 "operationId": "getMapMarkers",
3973 "parameters": [
3974 {
3975 "name": "isArchived",
3976 "required": false,
3977 "in": "query",
3978 "schema": {
3979 "type": "boolean"
3980 }
3981 },
3982 {
3983 "name": "isFavorite",
3984 "required": false,
3985 "in": "query",
3986 "schema": {
3987 "type": "boolean"
3988 }
3989 },
3990 {
3991 "name": "fileCreatedAfter",
3992 "required": false,
3993 "in": "query",
3994 "schema": {
3995 "format": "date-time",
3996 "type": "string"
3997 }
3998 },
3999 {
4000 "name": "fileCreatedBefore",
4001 "required": false,
4002 "in": "query",
4003 "schema": {
4004 "format": "date-time",
4005 "type": "string"
4006 }
4007 },
4008 {
4009 "name": "withPartners",
4010 "required": false,
4011 "in": "query",
4012 "schema": {
4013 "type": "boolean"
4014 }
4015 },
4016 {
4017 "name": "withSharedAlbums",
4018 "required": false,
4019 "in": "query",
4020 "schema": {
4021 "type": "boolean"
4022 }
4023 }
4024 ],
4025 "responses": {
4026 "200": {
4027 "content": {
4028 "application/json": {
4029 "schema": {
4030 "items": {
4031 "$ref": "#/components/schemas/MapMarkerResponseDto"
4032 },
4033 "type": "array"
4034 }
4035 }
4036 },
4037 "description": ""
4038 }
4039 },
4040 "security": [
4041 {
4042 "bearer": []
4043 },
4044 {
4045 "cookie": []
4046 },
4047 {
4048 "api_key": []
4049 }
4050 ],
4051 "tags": [
4052 "Map"
4053 ]
4054 }
4055 },
4056 "/map/reverse-geocode": {
4057 "get": {
4058 "operationId": "reverseGeocode",
4059 "parameters": [
4060 {
4061 "name": "lat",
4062 "required": true,
4063 "in": "query",
4064 "schema": {
4065 "format": "double",
4066 "type": "number"
4067 }
4068 },
4069 {
4070 "name": "lon",
4071 "required": true,
4072 "in": "query",
4073 "schema": {
4074 "format": "double",
4075 "type": "number"
4076 }
4077 }
4078 ],
4079 "responses": {
4080 "200": {
4081 "content": {
4082 "application/json": {
4083 "schema": {
4084 "items": {
4085 "$ref": "#/components/schemas/MapReverseGeocodeResponseDto"
4086 },
4087 "type": "array"
4088 }
4089 }
4090 },
4091 "description": ""
4092 }
4093 },
4094 "security": [
4095 {
4096 "bearer": []
4097 },
4098 {
4099 "cookie": []
4100 },
4101 {
4102 "api_key": []
4103 }
4104 ],
4105 "tags": [
4106 "Map"
4107 ]
4108 }
4109 },
4110 "/memories": {
4111 "get": {
4112 "operationId": "searchMemories",
4113 "parameters": [
4114 {
4115 "name": "for",
4116 "required": false,
4117 "in": "query",
4118 "schema": {
4119 "format": "date-time",
4120 "type": "string"
4121 }
4122 },
4123 {
4124 "name": "isSaved",
4125 "required": false,
4126 "in": "query",
4127 "schema": {
4128 "type": "boolean"
4129 }
4130 },
4131 {
4132 "name": "isTrashed",
4133 "required": false,
4134 "in": "query",
4135 "schema": {
4136 "type": "boolean"
4137 }
4138 },
4139 {
4140 "name": "type",
4141 "required": false,
4142 "in": "query",
4143 "schema": {
4144 "$ref": "#/components/schemas/MemoryType"
4145 }
4146 }
4147 ],
4148 "responses": {
4149 "200": {
4150 "content": {
4151 "application/json": {
4152 "schema": {
4153 "items": {
4154 "$ref": "#/components/schemas/MemoryResponseDto"
4155 },
4156 "type": "array"
4157 }
4158 }
4159 },
4160 "description": ""
4161 }
4162 },
4163 "security": [
4164 {
4165 "bearer": []
4166 },
4167 {
4168 "cookie": []
4169 },
4170 {
4171 "api_key": []
4172 }
4173 ],
4174 "tags": [
4175 "Memories"
4176 ],
4177 "x-immich-permission": "memory.read",
4178 "description": "This endpoint requires the `memory.read` permission."
4179 },
4180 "post": {
4181 "operationId": "createMemory",
4182 "parameters": [],
4183 "requestBody": {
4184 "content": {
4185 "application/json": {
4186 "schema": {
4187 "$ref": "#/components/schemas/MemoryCreateDto"
4188 }
4189 }
4190 },
4191 "required": true
4192 },
4193 "responses": {
4194 "201": {
4195 "content": {
4196 "application/json": {
4197 "schema": {
4198 "$ref": "#/components/schemas/MemoryResponseDto"
4199 }
4200 }
4201 },
4202 "description": ""
4203 }
4204 },
4205 "security": [
4206 {
4207 "bearer": []
4208 },
4209 {
4210 "cookie": []
4211 },
4212 {
4213 "api_key": []
4214 }
4215 ],
4216 "tags": [
4217 "Memories"
4218 ],
4219 "x-immich-permission": "memory.create",
4220 "description": "This endpoint requires the `memory.create` permission."
4221 }
4222 },
4223 "/memories/statistics": {
4224 "get": {
4225 "operationId": "memoriesStatistics",
4226 "parameters": [
4227 {
4228 "name": "for",
4229 "required": false,
4230 "in": "query",
4231 "schema": {
4232 "format": "date-time",
4233 "type": "string"
4234 }
4235 },
4236 {
4237 "name": "isSaved",
4238 "required": false,
4239 "in": "query",
4240 "schema": {
4241 "type": "boolean"
4242 }
4243 },
4244 {
4245 "name": "isTrashed",
4246 "required": false,
4247 "in": "query",
4248 "schema": {
4249 "type": "boolean"
4250 }
4251 },
4252 {
4253 "name": "type",
4254 "required": false,
4255 "in": "query",
4256 "schema": {
4257 "$ref": "#/components/schemas/MemoryType"
4258 }
4259 }
4260 ],
4261 "responses": {
4262 "200": {
4263 "content": {
4264 "application/json": {
4265 "schema": {
4266 "$ref": "#/components/schemas/MemoryStatisticsResponseDto"
4267 }
4268 }
4269 },
4270 "description": ""
4271 }
4272 },
4273 "security": [
4274 {
4275 "bearer": []
4276 },
4277 {
4278 "cookie": []
4279 },
4280 {
4281 "api_key": []
4282 }
4283 ],
4284 "tags": [
4285 "Memories"
4286 ],
4287 "x-immich-permission": "memory.statistics",
4288 "description": "This endpoint requires the `memory.statistics` permission."
4289 }
4290 },
4291 "/memories/{id}": {
4292 "delete": {
4293 "operationId": "deleteMemory",
4294 "parameters": [
4295 {
4296 "name": "id",
4297 "required": true,
4298 "in": "path",
4299 "schema": {
4300 "format": "uuid",
4301 "type": "string"
4302 }
4303 }
4304 ],
4305 "responses": {
4306 "204": {
4307 "description": ""
4308 }
4309 },
4310 "security": [
4311 {
4312 "bearer": []
4313 },
4314 {
4315 "cookie": []
4316 },
4317 {
4318 "api_key": []
4319 }
4320 ],
4321 "tags": [
4322 "Memories"
4323 ],
4324 "x-immich-permission": "memory.delete",
4325 "description": "This endpoint requires the `memory.delete` permission."
4326 },
4327 "get": {
4328 "operationId": "getMemory",
4329 "parameters": [
4330 {
4331 "name": "id",
4332 "required": true,
4333 "in": "path",
4334 "schema": {
4335 "format": "uuid",
4336 "type": "string"
4337 }
4338 }
4339 ],
4340 "responses": {
4341 "200": {
4342 "content": {
4343 "application/json": {
4344 "schema": {
4345 "$ref": "#/components/schemas/MemoryResponseDto"
4346 }
4347 }
4348 },
4349 "description": ""
4350 }
4351 },
4352 "security": [
4353 {
4354 "bearer": []
4355 },
4356 {
4357 "cookie": []
4358 },
4359 {
4360 "api_key": []
4361 }
4362 ],
4363 "tags": [
4364 "Memories"
4365 ],
4366 "x-immich-permission": "memory.read",
4367 "description": "This endpoint requires the `memory.read` permission."
4368 },
4369 "put": {
4370 "operationId": "updateMemory",
4371 "parameters": [
4372 {
4373 "name": "id",
4374 "required": true,
4375 "in": "path",
4376 "schema": {
4377 "format": "uuid",
4378 "type": "string"
4379 }
4380 }
4381 ],
4382 "requestBody": {
4383 "content": {
4384 "application/json": {
4385 "schema": {
4386 "$ref": "#/components/schemas/MemoryUpdateDto"
4387 }
4388 }
4389 },
4390 "required": true
4391 },
4392 "responses": {
4393 "200": {
4394 "content": {
4395 "application/json": {
4396 "schema": {
4397 "$ref": "#/components/schemas/MemoryResponseDto"
4398 }
4399 }
4400 },
4401 "description": ""
4402 }
4403 },
4404 "security": [
4405 {
4406 "bearer": []
4407 },
4408 {
4409 "cookie": []
4410 },
4411 {
4412 "api_key": []
4413 }
4414 ],
4415 "tags": [
4416 "Memories"
4417 ],
4418 "x-immich-permission": "memory.update",
4419 "description": "This endpoint requires the `memory.update` permission."
4420 }
4421 },
4422 "/memories/{id}/assets": {
4423 "delete": {
4424 "operationId": "removeMemoryAssets",
4425 "parameters": [
4426 {
4427 "name": "id",
4428 "required": true,
4429 "in": "path",
4430 "schema": {
4431 "format": "uuid",
4432 "type": "string"
4433 }
4434 }
4435 ],
4436 "requestBody": {
4437 "content": {
4438 "application/json": {
4439 "schema": {
4440 "$ref": "#/components/schemas/BulkIdsDto"
4441 }
4442 }
4443 },
4444 "required": true
4445 },
4446 "responses": {
4447 "200": {
4448 "content": {
4449 "application/json": {
4450 "schema": {
4451 "items": {
4452 "$ref": "#/components/schemas/BulkIdResponseDto"
4453 },
4454 "type": "array"
4455 }
4456 }
4457 },
4458 "description": ""
4459 }
4460 },
4461 "security": [
4462 {
4463 "bearer": []
4464 },
4465 {
4466 "cookie": []
4467 },
4468 {
4469 "api_key": []
4470 }
4471 ],
4472 "tags": [
4473 "Memories"
4474 ],
4475 "x-immich-permission": "memoryAsset.delete",
4476 "description": "This endpoint requires the `memoryAsset.delete` permission."
4477 },
4478 "put": {
4479 "operationId": "addMemoryAssets",
4480 "parameters": [
4481 {
4482 "name": "id",
4483 "required": true,
4484 "in": "path",
4485 "schema": {
4486 "format": "uuid",
4487 "type": "string"
4488 }
4489 }
4490 ],
4491 "requestBody": {
4492 "content": {
4493 "application/json": {
4494 "schema": {
4495 "$ref": "#/components/schemas/BulkIdsDto"
4496 }
4497 }
4498 },
4499 "required": true
4500 },
4501 "responses": {
4502 "200": {
4503 "content": {
4504 "application/json": {
4505 "schema": {
4506 "items": {
4507 "$ref": "#/components/schemas/BulkIdResponseDto"
4508 },
4509 "type": "array"
4510 }
4511 }
4512 },
4513 "description": ""
4514 }
4515 },
4516 "security": [
4517 {
4518 "bearer": []
4519 },
4520 {
4521 "cookie": []
4522 },
4523 {
4524 "api_key": []
4525 }
4526 ],
4527 "tags": [
4528 "Memories"
4529 ],
4530 "x-immich-permission": "memoryAsset.create",
4531 "description": "This endpoint requires the `memoryAsset.create` permission."
4532 }
4533 },
4534 "/notifications": {
4535 "delete": {
4536 "operationId": "deleteNotifications",
4537 "parameters": [],
4538 "requestBody": {
4539 "content": {
4540 "application/json": {
4541 "schema": {
4542 "$ref": "#/components/schemas/NotificationDeleteAllDto"
4543 }
4544 }
4545 },
4546 "required": true
4547 },
4548 "responses": {
4549 "204": {
4550 "description": ""
4551 }
4552 },
4553 "security": [
4554 {
4555 "bearer": []
4556 },
4557 {
4558 "cookie": []
4559 },
4560 {
4561 "api_key": []
4562 }
4563 ],
4564 "tags": [
4565 "Notifications"
4566 ],
4567 "x-immich-permission": "notification.delete",
4568 "description": "This endpoint requires the `notification.delete` permission."
4569 },
4570 "get": {
4571 "operationId": "getNotifications",
4572 "parameters": [
4573 {
4574 "name": "id",
4575 "required": false,
4576 "in": "query",
4577 "schema": {
4578 "format": "uuid",
4579 "type": "string"
4580 }
4581 },
4582 {
4583 "name": "level",
4584 "required": false,
4585 "in": "query",
4586 "schema": {
4587 "$ref": "#/components/schemas/NotificationLevel"
4588 }
4589 },
4590 {
4591 "name": "type",
4592 "required": false,
4593 "in": "query",
4594 "schema": {
4595 "$ref": "#/components/schemas/NotificationType"
4596 }
4597 },
4598 {
4599 "name": "unread",
4600 "required": false,
4601 "in": "query",
4602 "schema": {
4603 "type": "boolean"
4604 }
4605 }
4606 ],
4607 "responses": {
4608 "200": {
4609 "content": {
4610 "application/json": {
4611 "schema": {
4612 "items": {
4613 "$ref": "#/components/schemas/NotificationDto"
4614 },
4615 "type": "array"
4616 }
4617 }
4618 },
4619 "description": ""
4620 }
4621 },
4622 "security": [
4623 {
4624 "bearer": []
4625 },
4626 {
4627 "cookie": []
4628 },
4629 {
4630 "api_key": []
4631 }
4632 ],
4633 "tags": [
4634 "Notifications"
4635 ],
4636 "x-immich-permission": "notification.read",
4637 "description": "This endpoint requires the `notification.read` permission."
4638 },
4639 "put": {
4640 "operationId": "updateNotifications",
4641 "parameters": [],
4642 "requestBody": {
4643 "content": {
4644 "application/json": {
4645 "schema": {
4646 "$ref": "#/components/schemas/NotificationUpdateAllDto"
4647 }
4648 }
4649 },
4650 "required": true
4651 },
4652 "responses": {
4653 "204": {
4654 "description": ""
4655 }
4656 },
4657 "security": [
4658 {
4659 "bearer": []
4660 },
4661 {
4662 "cookie": []
4663 },
4664 {
4665 "api_key": []
4666 }
4667 ],
4668 "tags": [
4669 "Notifications"
4670 ],
4671 "x-immich-permission": "notification.update",
4672 "description": "This endpoint requires the `notification.update` permission."
4673 }
4674 },
4675 "/notifications/{id}": {
4676 "delete": {
4677 "operationId": "deleteNotification",
4678 "parameters": [
4679 {
4680 "name": "id",
4681 "required": true,
4682 "in": "path",
4683 "schema": {
4684 "format": "uuid",
4685 "type": "string"
4686 }
4687 }
4688 ],
4689 "responses": {
4690 "204": {
4691 "description": ""
4692 }
4693 },
4694 "security": [
4695 {
4696 "bearer": []
4697 },
4698 {
4699 "cookie": []
4700 },
4701 {
4702 "api_key": []
4703 }
4704 ],
4705 "tags": [
4706 "Notifications"
4707 ],
4708 "x-immich-permission": "notification.delete",
4709 "description": "This endpoint requires the `notification.delete` permission."
4710 },
4711 "get": {
4712 "operationId": "getNotification",
4713 "parameters": [
4714 {
4715 "name": "id",
4716 "required": true,
4717 "in": "path",
4718 "schema": {
4719 "format": "uuid",
4720 "type": "string"
4721 }
4722 }
4723 ],
4724 "responses": {
4725 "200": {
4726 "content": {
4727 "application/json": {
4728 "schema": {
4729 "$ref": "#/components/schemas/NotificationDto"
4730 }
4731 }
4732 },
4733 "description": ""
4734 }
4735 },
4736 "security": [
4737 {
4738 "bearer": []
4739 },
4740 {
4741 "cookie": []
4742 },
4743 {
4744 "api_key": []
4745 }
4746 ],
4747 "tags": [
4748 "Notifications"
4749 ],
4750 "x-immich-permission": "notification.read",
4751 "description": "This endpoint requires the `notification.read` permission."
4752 },
4753 "put": {
4754 "operationId": "updateNotification",
4755 "parameters": [
4756 {
4757 "name": "id",
4758 "required": true,
4759 "in": "path",
4760 "schema": {
4761 "format": "uuid",
4762 "type": "string"
4763 }
4764 }
4765 ],
4766 "requestBody": {
4767 "content": {
4768 "application/json": {
4769 "schema": {
4770 "$ref": "#/components/schemas/NotificationUpdateDto"
4771 }
4772 }
4773 },
4774 "required": true
4775 },
4776 "responses": {
4777 "200": {
4778 "content": {
4779 "application/json": {
4780 "schema": {
4781 "$ref": "#/components/schemas/NotificationDto"
4782 }
4783 }
4784 },
4785 "description": ""
4786 }
4787 },
4788 "security": [
4789 {
4790 "bearer": []
4791 },
4792 {
4793 "cookie": []
4794 },
4795 {
4796 "api_key": []
4797 }
4798 ],
4799 "tags": [
4800 "Notifications"
4801 ],
4802 "x-immich-permission": "notification.update",
4803 "description": "This endpoint requires the `notification.update` permission."
4804 }
4805 },
4806 "/oauth/authorize": {
4807 "post": {
4808 "operationId": "startOAuth",
4809 "parameters": [],
4810 "requestBody": {
4811 "content": {
4812 "application/json": {
4813 "schema": {
4814 "$ref": "#/components/schemas/OAuthConfigDto"
4815 }
4816 }
4817 },
4818 "required": true
4819 },
4820 "responses": {
4821 "201": {
4822 "content": {
4823 "application/json": {
4824 "schema": {
4825 "$ref": "#/components/schemas/OAuthAuthorizeResponseDto"
4826 }
4827 }
4828 },
4829 "description": ""
4830 }
4831 },
4832 "tags": [
4833 "OAuth"
4834 ]
4835 }
4836 },
4837 "/oauth/callback": {
4838 "post": {
4839 "operationId": "finishOAuth",
4840 "parameters": [],
4841 "requestBody": {
4842 "content": {
4843 "application/json": {
4844 "schema": {
4845 "$ref": "#/components/schemas/OAuthCallbackDto"
4846 }
4847 }
4848 },
4849 "required": true
4850 },
4851 "responses": {
4852 "201": {
4853 "content": {
4854 "application/json": {
4855 "schema": {
4856 "$ref": "#/components/schemas/LoginResponseDto"
4857 }
4858 }
4859 },
4860 "description": ""
4861 }
4862 },
4863 "tags": [
4864 "OAuth"
4865 ]
4866 }
4867 },
4868 "/oauth/link": {
4869 "post": {
4870 "operationId": "linkOAuthAccount",
4871 "parameters": [],
4872 "requestBody": {
4873 "content": {
4874 "application/json": {
4875 "schema": {
4876 "$ref": "#/components/schemas/OAuthCallbackDto"
4877 }
4878 }
4879 },
4880 "required": true
4881 },
4882 "responses": {
4883 "200": {
4884 "content": {
4885 "application/json": {
4886 "schema": {
4887 "$ref": "#/components/schemas/UserAdminResponseDto"
4888 }
4889 }
4890 },
4891 "description": ""
4892 }
4893 },
4894 "security": [
4895 {
4896 "bearer": []
4897 },
4898 {
4899 "cookie": []
4900 },
4901 {
4902 "api_key": []
4903 }
4904 ],
4905 "tags": [
4906 "OAuth"
4907 ]
4908 }
4909 },
4910 "/oauth/mobile-redirect": {
4911 "get": {
4912 "operationId": "redirectOAuthToMobile",
4913 "parameters": [],
4914 "responses": {
4915 "200": {
4916 "description": ""
4917 }
4918 },
4919 "tags": [
4920 "OAuth"
4921 ]
4922 }
4923 },
4924 "/oauth/unlink": {
4925 "post": {
4926 "operationId": "unlinkOAuthAccount",
4927 "parameters": [],
4928 "responses": {
4929 "200": {
4930 "content": {
4931 "application/json": {
4932 "schema": {
4933 "$ref": "#/components/schemas/UserAdminResponseDto"
4934 }
4935 }
4936 },
4937 "description": ""
4938 }
4939 },
4940 "security": [
4941 {
4942 "bearer": []
4943 },
4944 {
4945 "cookie": []
4946 },
4947 {
4948 "api_key": []
4949 }
4950 ],
4951 "tags": [
4952 "OAuth"
4953 ]
4954 }
4955 },
4956 "/partners": {
4957 "get": {
4958 "operationId": "getPartners",
4959 "parameters": [
4960 {
4961 "name": "direction",
4962 "required": true,
4963 "in": "query",
4964 "schema": {
4965 "$ref": "#/components/schemas/PartnerDirection"
4966 }
4967 }
4968 ],
4969 "responses": {
4970 "200": {
4971 "content": {
4972 "application/json": {
4973 "schema": {
4974 "items": {
4975 "$ref": "#/components/schemas/PartnerResponseDto"
4976 },
4977 "type": "array"
4978 }
4979 }
4980 },
4981 "description": ""
4982 }
4983 },
4984 "security": [
4985 {
4986 "bearer": []
4987 },
4988 {
4989 "cookie": []
4990 },
4991 {
4992 "api_key": []
4993 }
4994 ],
4995 "tags": [
4996 "Partners"
4997 ],
4998 "x-immich-permission": "partner.read",
4999 "description": "This endpoint requires the `partner.read` permission."
5000 },
5001 "post": {
5002 "operationId": "createPartner",
5003 "parameters": [],
5004 "requestBody": {
5005 "content": {
5006 "application/json": {
5007 "schema": {
5008 "$ref": "#/components/schemas/PartnerCreateDto"
5009 }
5010 }
5011 },
5012 "required": true
5013 },
5014 "responses": {
5015 "201": {
5016 "content": {
5017 "application/json": {
5018 "schema": {
5019 "$ref": "#/components/schemas/PartnerResponseDto"
5020 }
5021 }
5022 },
5023 "description": ""
5024 }
5025 },
5026 "security": [
5027 {
5028 "bearer": []
5029 },
5030 {
5031 "cookie": []
5032 },
5033 {
5034 "api_key": []
5035 }
5036 ],
5037 "tags": [
5038 "Partners"
5039 ],
5040 "x-immich-permission": "partner.create",
5041 "description": "This endpoint requires the `partner.create` permission."
5042 }
5043 },
5044 "/partners/{id}": {
5045 "delete": {
5046 "operationId": "removePartner",
5047 "parameters": [
5048 {
5049 "name": "id",
5050 "required": true,
5051 "in": "path",
5052 "schema": {
5053 "format": "uuid",
5054 "type": "string"
5055 }
5056 }
5057 ],
5058 "responses": {
5059 "204": {
5060 "description": ""
5061 }
5062 },
5063 "security": [
5064 {
5065 "bearer": []
5066 },
5067 {
5068 "cookie": []
5069 },
5070 {
5071 "api_key": []
5072 }
5073 ],
5074 "tags": [
5075 "Partners"
5076 ],
5077 "x-immich-permission": "partner.delete",
5078 "description": "This endpoint requires the `partner.delete` permission."
5079 },
5080 "post": {
5081 "deprecated": true,
5082 "description": "This property was deprecated in v1.141.0. This endpoint requires the `partner.create` permission.",
5083 "operationId": "createPartnerDeprecated",
5084 "parameters": [
5085 {
5086 "name": "id",
5087 "required": true,
5088 "in": "path",
5089 "schema": {
5090 "format": "uuid",
5091 "type": "string"
5092 }
5093 }
5094 ],
5095 "responses": {
5096 "201": {
5097 "content": {
5098 "application/json": {
5099 "schema": {
5100 "$ref": "#/components/schemas/PartnerResponseDto"
5101 }
5102 }
5103 },
5104 "description": ""
5105 }
5106 },
5107 "security": [
5108 {
5109 "bearer": []
5110 },
5111 {
5112 "cookie": []
5113 },
5114 {
5115 "api_key": []
5116 }
5117 ],
5118 "tags": [
5119 "Partners",
5120 "Deprecated"
5121 ],
5122 "x-immich-lifecycle": {
5123 "deprecatedAt": "v1.141.0"
5124 },
5125 "x-immich-permission": "partner.create"
5126 },
5127 "put": {
5128 "operationId": "updatePartner",
5129 "parameters": [
5130 {
5131 "name": "id",
5132 "required": true,
5133 "in": "path",
5134 "schema": {
5135 "format": "uuid",
5136 "type": "string"
5137 }
5138 }
5139 ],
5140 "requestBody": {
5141 "content": {
5142 "application/json": {
5143 "schema": {
5144 "$ref": "#/components/schemas/PartnerUpdateDto"
5145 }
5146 }
5147 },
5148 "required": true
5149 },
5150 "responses": {
5151 "200": {
5152 "content": {
5153 "application/json": {
5154 "schema": {
5155 "$ref": "#/components/schemas/PartnerResponseDto"
5156 }
5157 }
5158 },
5159 "description": ""
5160 }
5161 },
5162 "security": [
5163 {
5164 "bearer": []
5165 },
5166 {
5167 "cookie": []
5168 },
5169 {
5170 "api_key": []
5171 }
5172 ],
5173 "tags": [
5174 "Partners"
5175 ],
5176 "x-immich-permission": "partner.update",
5177 "description": "This endpoint requires the `partner.update` permission."
5178 }
5179 },
5180 "/people": {
5181 "delete": {
5182 "operationId": "deletePeople",
5183 "parameters": [],
5184 "requestBody": {
5185 "content": {
5186 "application/json": {
5187 "schema": {
5188 "$ref": "#/components/schemas/BulkIdsDto"
5189 }
5190 }
5191 },
5192 "required": true
5193 },
5194 "responses": {
5195 "204": {
5196 "description": ""
5197 }
5198 },
5199 "security": [
5200 {
5201 "bearer": []
5202 },
5203 {
5204 "cookie": []
5205 },
5206 {
5207 "api_key": []
5208 }
5209 ],
5210 "tags": [
5211 "People"
5212 ],
5213 "x-immich-permission": "person.delete",
5214 "description": "This endpoint requires the `person.delete` permission."
5215 },
5216 "get": {
5217 "operationId": "getAllPeople",
5218 "parameters": [
5219 {
5220 "name": "closestAssetId",
5221 "required": false,
5222 "in": "query",
5223 "schema": {
5224 "format": "uuid",
5225 "type": "string"
5226 }
5227 },
5228 {
5229 "name": "closestPersonId",
5230 "required": false,
5231 "in": "query",
5232 "schema": {
5233 "format": "uuid",
5234 "type": "string"
5235 }
5236 },
5237 {
5238 "name": "page",
5239 "required": false,
5240 "in": "query",
5241 "description": "Page number for pagination",
5242 "schema": {
5243 "minimum": 1,
5244 "default": 1,
5245 "type": "number"
5246 }
5247 },
5248 {
5249 "name": "size",
5250 "required": false,
5251 "in": "query",
5252 "description": "Number of items per page",
5253 "schema": {
5254 "minimum": 1,
5255 "maximum": 1000,
5256 "default": 500,
5257 "type": "number"
5258 }
5259 },
5260 {
5261 "name": "withHidden",
5262 "required": false,
5263 "in": "query",
5264 "schema": {
5265 "type": "boolean"
5266 }
5267 }
5268 ],
5269 "responses": {
5270 "200": {
5271 "content": {
5272 "application/json": {
5273 "schema": {
5274 "$ref": "#/components/schemas/PeopleResponseDto"
5275 }
5276 }
5277 },
5278 "description": ""
5279 }
5280 },
5281 "security": [
5282 {
5283 "bearer": []
5284 },
5285 {
5286 "cookie": []
5287 },
5288 {
5289 "api_key": []
5290 }
5291 ],
5292 "tags": [
5293 "People"
5294 ],
5295 "x-immich-permission": "person.read",
5296 "description": "This endpoint requires the `person.read` permission."
5297 },
5298 "post": {
5299 "operationId": "createPerson",
5300 "parameters": [],
5301 "requestBody": {
5302 "content": {
5303 "application/json": {
5304 "schema": {
5305 "$ref": "#/components/schemas/PersonCreateDto"
5306 }
5307 }
5308 },
5309 "required": true
5310 },
5311 "responses": {
5312 "201": {
5313 "content": {
5314 "application/json": {
5315 "schema": {
5316 "$ref": "#/components/schemas/PersonResponseDto"
5317 }
5318 }
5319 },
5320 "description": ""
5321 }
5322 },
5323 "security": [
5324 {
5325 "bearer": []
5326 },
5327 {
5328 "cookie": []
5329 },
5330 {
5331 "api_key": []
5332 }
5333 ],
5334 "tags": [
5335 "People"
5336 ],
5337 "x-immich-permission": "person.create",
5338 "description": "This endpoint requires the `person.create` permission."
5339 },
5340 "put": {
5341 "operationId": "updatePeople",
5342 "parameters": [],
5343 "requestBody": {
5344 "content": {
5345 "application/json": {
5346 "schema": {
5347 "$ref": "#/components/schemas/PeopleUpdateDto"
5348 }
5349 }
5350 },
5351 "required": true
5352 },
5353 "responses": {
5354 "200": {
5355 "content": {
5356 "application/json": {
5357 "schema": {
5358 "items": {
5359 "$ref": "#/components/schemas/BulkIdResponseDto"
5360 },
5361 "type": "array"
5362 }
5363 }
5364 },
5365 "description": ""
5366 }
5367 },
5368 "security": [
5369 {
5370 "bearer": []
5371 },
5372 {
5373 "cookie": []
5374 },
5375 {
5376 "api_key": []
5377 }
5378 ],
5379 "tags": [
5380 "People"
5381 ],
5382 "x-immich-permission": "person.update",
5383 "description": "This endpoint requires the `person.update` permission."
5384 }
5385 },
5386 "/people/{id}": {
5387 "delete": {
5388 "operationId": "deletePerson",
5389 "parameters": [
5390 {
5391 "name": "id",
5392 "required": true,
5393 "in": "path",
5394 "schema": {
5395 "format": "uuid",
5396 "type": "string"
5397 }
5398 }
5399 ],
5400 "responses": {
5401 "204": {
5402 "description": ""
5403 }
5404 },
5405 "security": [
5406 {
5407 "bearer": []
5408 },
5409 {
5410 "cookie": []
5411 },
5412 {
5413 "api_key": []
5414 }
5415 ],
5416 "tags": [
5417 "People"
5418 ],
5419 "x-immich-permission": "person.delete",
5420 "description": "This endpoint requires the `person.delete` permission."
5421 },
5422 "get": {
5423 "operationId": "getPerson",
5424 "parameters": [
5425 {
5426 "name": "id",
5427 "required": true,
5428 "in": "path",
5429 "schema": {
5430 "format": "uuid",
5431 "type": "string"
5432 }
5433 }
5434 ],
5435 "responses": {
5436 "200": {
5437 "content": {
5438 "application/json": {
5439 "schema": {
5440 "$ref": "#/components/schemas/PersonResponseDto"
5441 }
5442 }
5443 },
5444 "description": ""
5445 }
5446 },
5447 "security": [
5448 {
5449 "bearer": []
5450 },
5451 {
5452 "cookie": []
5453 },
5454 {
5455 "api_key": []
5456 }
5457 ],
5458 "tags": [
5459 "People"
5460 ],
5461 "x-immich-permission": "person.read",
5462 "description": "This endpoint requires the `person.read` permission."
5463 },
5464 "put": {
5465 "operationId": "updatePerson",
5466 "parameters": [
5467 {
5468 "name": "id",
5469 "required": true,
5470 "in": "path",
5471 "schema": {
5472 "format": "uuid",
5473 "type": "string"
5474 }
5475 }
5476 ],
5477 "requestBody": {
5478 "content": {
5479 "application/json": {
5480 "schema": {
5481 "$ref": "#/components/schemas/PersonUpdateDto"
5482 }
5483 }
5484 },
5485 "required": true
5486 },
5487 "responses": {
5488 "200": {
5489 "content": {
5490 "application/json": {
5491 "schema": {
5492 "$ref": "#/components/schemas/PersonResponseDto"
5493 }
5494 }
5495 },
5496 "description": ""
5497 }
5498 },
5499 "security": [
5500 {
5501 "bearer": []
5502 },
5503 {
5504 "cookie": []
5505 },
5506 {
5507 "api_key": []
5508 }
5509 ],
5510 "tags": [
5511 "People"
5512 ],
5513 "x-immich-permission": "person.update",
5514 "description": "This endpoint requires the `person.update` permission."
5515 }
5516 },
5517 "/people/{id}/merge": {
5518 "post": {
5519 "operationId": "mergePerson",
5520 "parameters": [
5521 {
5522 "name": "id",
5523 "required": true,
5524 "in": "path",
5525 "schema": {
5526 "format": "uuid",
5527 "type": "string"
5528 }
5529 }
5530 ],
5531 "requestBody": {
5532 "content": {
5533 "application/json": {
5534 "schema": {
5535 "$ref": "#/components/schemas/MergePersonDto"
5536 }
5537 }
5538 },
5539 "required": true
5540 },
5541 "responses": {
5542 "200": {
5543 "content": {
5544 "application/json": {
5545 "schema": {
5546 "items": {
5547 "$ref": "#/components/schemas/BulkIdResponseDto"
5548 },
5549 "type": "array"
5550 }
5551 }
5552 },
5553 "description": ""
5554 }
5555 },
5556 "security": [
5557 {
5558 "bearer": []
5559 },
5560 {
5561 "cookie": []
5562 },
5563 {
5564 "api_key": []
5565 }
5566 ],
5567 "tags": [
5568 "People"
5569 ],
5570 "x-immich-permission": "person.merge",
5571 "description": "This endpoint requires the `person.merge` permission."
5572 }
5573 },
5574 "/people/{id}/reassign": {
5575 "put": {
5576 "operationId": "reassignFaces",
5577 "parameters": [
5578 {
5579 "name": "id",
5580 "required": true,
5581 "in": "path",
5582 "schema": {
5583 "format": "uuid",
5584 "type": "string"
5585 }
5586 }
5587 ],
5588 "requestBody": {
5589 "content": {
5590 "application/json": {
5591 "schema": {
5592 "$ref": "#/components/schemas/AssetFaceUpdateDto"
5593 }
5594 }
5595 },
5596 "required": true
5597 },
5598 "responses": {
5599 "200": {
5600 "content": {
5601 "application/json": {
5602 "schema": {
5603 "items": {
5604 "$ref": "#/components/schemas/PersonResponseDto"
5605 },
5606 "type": "array"
5607 }
5608 }
5609 },
5610 "description": ""
5611 }
5612 },
5613 "security": [
5614 {
5615 "bearer": []
5616 },
5617 {
5618 "cookie": []
5619 },
5620 {
5621 "api_key": []
5622 }
5623 ],
5624 "tags": [
5625 "People"
5626 ],
5627 "x-immich-permission": "person.reassign",
5628 "description": "This endpoint requires the `person.reassign` permission."
5629 }
5630 },
5631 "/people/{id}/statistics": {
5632 "get": {
5633 "operationId": "getPersonStatistics",
5634 "parameters": [
5635 {
5636 "name": "id",
5637 "required": true,
5638 "in": "path",
5639 "schema": {
5640 "format": "uuid",
5641 "type": "string"
5642 }
5643 }
5644 ],
5645 "responses": {
5646 "200": {
5647 "content": {
5648 "application/json": {
5649 "schema": {
5650 "$ref": "#/components/schemas/PersonStatisticsResponseDto"
5651 }
5652 }
5653 },
5654 "description": ""
5655 }
5656 },
5657 "security": [
5658 {
5659 "bearer": []
5660 },
5661 {
5662 "cookie": []
5663 },
5664 {
5665 "api_key": []
5666 }
5667 ],
5668 "tags": [
5669 "People"
5670 ],
5671 "x-immich-permission": "person.statistics",
5672 "description": "This endpoint requires the `person.statistics` permission."
5673 }
5674 },
5675 "/people/{id}/thumbnail": {
5676 "get": {
5677 "operationId": "getPersonThumbnail",
5678 "parameters": [
5679 {
5680 "name": "id",
5681 "required": true,
5682 "in": "path",
5683 "schema": {
5684 "format": "uuid",
5685 "type": "string"
5686 }
5687 }
5688 ],
5689 "responses": {
5690 "200": {
5691 "content": {
5692 "application/octet-stream": {
5693 "schema": {
5694 "format": "binary",
5695 "type": "string"
5696 }
5697 }
5698 },
5699 "description": ""
5700 }
5701 },
5702 "security": [
5703 {
5704 "bearer": []
5705 },
5706 {
5707 "cookie": []
5708 },
5709 {
5710 "api_key": []
5711 }
5712 ],
5713 "tags": [
5714 "People"
5715 ],
5716 "x-immich-permission": "person.read",
5717 "description": "This endpoint requires the `person.read` permission."
5718 }
5719 },
5720 "/search/cities": {
5721 "get": {
5722 "operationId": "getAssetsByCity",
5723 "parameters": [],
5724 "responses": {
5725 "200": {
5726 "content": {
5727 "application/json": {
5728 "schema": {
5729 "items": {
5730 "$ref": "#/components/schemas/AssetResponseDto"
5731 },
5732 "type": "array"
5733 }
5734 }
5735 },
5736 "description": ""
5737 }
5738 },
5739 "security": [
5740 {
5741 "bearer": []
5742 },
5743 {
5744 "cookie": []
5745 },
5746 {
5747 "api_key": []
5748 }
5749 ],
5750 "tags": [
5751 "Search"
5752 ],
5753 "x-immich-permission": "asset.read",
5754 "description": "This endpoint requires the `asset.read` permission."
5755 }
5756 },
5757 "/search/explore": {
5758 "get": {
5759 "operationId": "getExploreData",
5760 "parameters": [],
5761 "responses": {
5762 "200": {
5763 "content": {
5764 "application/json": {
5765 "schema": {
5766 "items": {
5767 "$ref": "#/components/schemas/SearchExploreResponseDto"
5768 },
5769 "type": "array"
5770 }
5771 }
5772 },
5773 "description": ""
5774 }
5775 },
5776 "security": [
5777 {
5778 "bearer": []
5779 },
5780 {
5781 "cookie": []
5782 },
5783 {
5784 "api_key": []
5785 }
5786 ],
5787 "tags": [
5788 "Search"
5789 ],
5790 "x-immich-permission": "asset.read",
5791 "description": "This endpoint requires the `asset.read` permission."
5792 }
5793 },
5794 "/search/large-assets": {
5795 "post": {
5796 "operationId": "searchLargeAssets",
5797 "parameters": [
5798 {
5799 "name": "albumIds",
5800 "required": false,
5801 "in": "query",
5802 "schema": {
5803 "type": "array",
5804 "items": {
5805 "type": "string",
5806 "format": "uuid"
5807 }
5808 }
5809 },
5810 {
5811 "name": "city",
5812 "required": false,
5813 "in": "query",
5814 "schema": {
5815 "nullable": true,
5816 "type": "string"
5817 }
5818 },
5819 {
5820 "name": "country",
5821 "required": false,
5822 "in": "query",
5823 "schema": {
5824 "nullable": true,
5825 "type": "string"
5826 }
5827 },
5828 {
5829 "name": "createdAfter",
5830 "required": false,
5831 "in": "query",
5832 "schema": {
5833 "format": "date-time",
5834 "type": "string"
5835 }
5836 },
5837 {
5838 "name": "createdBefore",
5839 "required": false,
5840 "in": "query",
5841 "schema": {
5842 "format": "date-time",
5843 "type": "string"
5844 }
5845 },
5846 {
5847 "name": "deviceId",
5848 "required": false,
5849 "in": "query",
5850 "schema": {
5851 "type": "string"
5852 }
5853 },
5854 {
5855 "name": "isEncoded",
5856 "required": false,
5857 "in": "query",
5858 "schema": {
5859 "type": "boolean"
5860 }
5861 },
5862 {
5863 "name": "isFavorite",
5864 "required": false,
5865 "in": "query",
5866 "schema": {
5867 "type": "boolean"
5868 }
5869 },
5870 {
5871 "name": "isMotion",
5872 "required": false,
5873 "in": "query",
5874 "schema": {
5875 "type": "boolean"
5876 }
5877 },
5878 {
5879 "name": "isNotInAlbum",
5880 "required": false,
5881 "in": "query",
5882 "schema": {
5883 "type": "boolean"
5884 }
5885 },
5886 {
5887 "name": "isOffline",
5888 "required": false,
5889 "in": "query",
5890 "schema": {
5891 "type": "boolean"
5892 }
5893 },
5894 {
5895 "name": "lensModel",
5896 "required": false,
5897 "in": "query",
5898 "schema": {
5899 "nullable": true,
5900 "type": "string"
5901 }
5902 },
5903 {
5904 "name": "libraryId",
5905 "required": false,
5906 "in": "query",
5907 "schema": {
5908 "format": "uuid",
5909 "nullable": true,
5910 "type": "string"
5911 }
5912 },
5913 {
5914 "name": "make",
5915 "required": false,
5916 "in": "query",
5917 "schema": {
5918 "type": "string"
5919 }
5920 },
5921 {
5922 "name": "minFileSize",
5923 "required": false,
5924 "in": "query",
5925 "schema": {
5926 "minimum": 0,
5927 "type": "integer"
5928 }
5929 },
5930 {
5931 "name": "model",
5932 "required": false,
5933 "in": "query",
5934 "schema": {
5935 "nullable": true,
5936 "type": "string"
5937 }
5938 },
5939 {
5940 "name": "personIds",
5941 "required": false,
5942 "in": "query",
5943 "schema": {
5944 "type": "array",
5945 "items": {
5946 "type": "string",
5947 "format": "uuid"
5948 }
5949 }
5950 },
5951 {
5952 "name": "rating",
5953 "required": false,
5954 "in": "query",
5955 "schema": {
5956 "minimum": -1,
5957 "maximum": 5,
5958 "type": "number"
5959 }
5960 },
5961 {
5962 "name": "size",
5963 "required": false,
5964 "in": "query",
5965 "schema": {
5966 "minimum": 1,
5967 "maximum": 1000,
5968 "type": "number"
5969 }
5970 },
5971 {
5972 "name": "state",
5973 "required": false,
5974 "in": "query",
5975 "schema": {
5976 "nullable": true,
5977 "type": "string"
5978 }
5979 },
5980 {
5981 "name": "tagIds",
5982 "required": false,
5983 "in": "query",
5984 "schema": {
5985 "nullable": true,
5986 "type": "array",
5987 "items": {
5988 "type": "string",
5989 "format": "uuid"
5990 }
5991 }
5992 },
5993 {
5994 "name": "takenAfter",
5995 "required": false,
5996 "in": "query",
5997 "schema": {
5998 "format": "date-time",
5999 "type": "string"
6000 }
6001 },
6002 {
6003 "name": "takenBefore",
6004 "required": false,
6005 "in": "query",
6006 "schema": {
6007 "format": "date-time",
6008 "type": "string"
6009 }
6010 },
6011 {
6012 "name": "trashedAfter",
6013 "required": false,
6014 "in": "query",
6015 "schema": {
6016 "format": "date-time",
6017 "type": "string"
6018 }
6019 },
6020 {
6021 "name": "trashedBefore",
6022 "required": false,
6023 "in": "query",
6024 "schema": {
6025 "format": "date-time",
6026 "type": "string"
6027 }
6028 },
6029 {
6030 "name": "type",
6031 "required": false,
6032 "in": "query",
6033 "schema": {
6034 "$ref": "#/components/schemas/AssetTypeEnum"
6035 }
6036 },
6037 {
6038 "name": "updatedAfter",
6039 "required": false,
6040 "in": "query",
6041 "schema": {
6042 "format": "date-time",
6043 "type": "string"
6044 }
6045 },
6046 {
6047 "name": "updatedBefore",
6048 "required": false,
6049 "in": "query",
6050 "schema": {
6051 "format": "date-time",
6052 "type": "string"
6053 }
6054 },
6055 {
6056 "name": "visibility",
6057 "required": false,
6058 "in": "query",
6059 "schema": {
6060 "$ref": "#/components/schemas/AssetVisibility"
6061 }
6062 },
6063 {
6064 "name": "withDeleted",
6065 "required": false,
6066 "in": "query",
6067 "schema": {
6068 "type": "boolean"
6069 }
6070 },
6071 {
6072 "name": "withExif",
6073 "required": false,
6074 "in": "query",
6075 "schema": {
6076 "type": "boolean"
6077 }
6078 }
6079 ],
6080 "responses": {
6081 "200": {
6082 "content": {
6083 "application/json": {
6084 "schema": {
6085 "items": {
6086 "$ref": "#/components/schemas/AssetResponseDto"
6087 },
6088 "type": "array"
6089 }
6090 }
6091 },
6092 "description": ""
6093 }
6094 },
6095 "security": [
6096 {
6097 "bearer": []
6098 },
6099 {
6100 "cookie": []
6101 },
6102 {
6103 "api_key": []
6104 }
6105 ],
6106 "tags": [
6107 "Search"
6108 ],
6109 "x-immich-permission": "asset.read",
6110 "description": "This endpoint requires the `asset.read` permission."
6111 }
6112 },
6113 "/search/metadata": {
6114 "post": {
6115 "operationId": "searchAssets",
6116 "parameters": [],
6117 "requestBody": {
6118 "content": {
6119 "application/json": {
6120 "schema": {
6121 "$ref": "#/components/schemas/MetadataSearchDto"
6122 }
6123 }
6124 },
6125 "required": true
6126 },
6127 "responses": {
6128 "200": {
6129 "content": {
6130 "application/json": {
6131 "schema": {
6132 "$ref": "#/components/schemas/SearchResponseDto"
6133 }
6134 }
6135 },
6136 "description": ""
6137 }
6138 },
6139 "security": [
6140 {
6141 "bearer": []
6142 },
6143 {
6144 "cookie": []
6145 },
6146 {
6147 "api_key": []
6148 }
6149 ],
6150 "tags": [
6151 "Search"
6152 ],
6153 "x-immich-permission": "asset.read",
6154 "description": "This endpoint requires the `asset.read` permission."
6155 }
6156 },
6157 "/search/person": {
6158 "get": {
6159 "operationId": "searchPerson",
6160 "parameters": [
6161 {
6162 "name": "name",
6163 "required": true,
6164 "in": "query",
6165 "schema": {
6166 "type": "string"
6167 }
6168 },
6169 {
6170 "name": "withHidden",
6171 "required": false,
6172 "in": "query",
6173 "schema": {
6174 "type": "boolean"
6175 }
6176 }
6177 ],
6178 "responses": {
6179 "200": {
6180 "content": {
6181 "application/json": {
6182 "schema": {
6183 "items": {
6184 "$ref": "#/components/schemas/PersonResponseDto"
6185 },
6186 "type": "array"
6187 }
6188 }
6189 },
6190 "description": ""
6191 }
6192 },
6193 "security": [
6194 {
6195 "bearer": []
6196 },
6197 {
6198 "cookie": []
6199 },
6200 {
6201 "api_key": []
6202 }
6203 ],
6204 "tags": [
6205 "Search"
6206 ],
6207 "x-immich-permission": "person.read",
6208 "description": "This endpoint requires the `person.read` permission."
6209 }
6210 },
6211 "/search/places": {
6212 "get": {
6213 "operationId": "searchPlaces",
6214 "parameters": [
6215 {
6216 "name": "name",
6217 "required": true,
6218 "in": "query",
6219 "schema": {
6220 "type": "string"
6221 }
6222 }
6223 ],
6224 "responses": {
6225 "200": {
6226 "content": {
6227 "application/json": {
6228 "schema": {
6229 "items": {
6230 "$ref": "#/components/schemas/PlacesResponseDto"
6231 },
6232 "type": "array"
6233 }
6234 }
6235 },
6236 "description": ""
6237 }
6238 },
6239 "security": [
6240 {
6241 "bearer": []
6242 },
6243 {
6244 "cookie": []
6245 },
6246 {
6247 "api_key": []
6248 }
6249 ],
6250 "tags": [
6251 "Search"
6252 ],
6253 "x-immich-permission": "asset.read",
6254 "description": "This endpoint requires the `asset.read` permission."
6255 }
6256 },
6257 "/search/random": {
6258 "post": {
6259 "operationId": "searchRandom",
6260 "parameters": [],
6261 "requestBody": {
6262 "content": {
6263 "application/json": {
6264 "schema": {
6265 "$ref": "#/components/schemas/RandomSearchDto"
6266 }
6267 }
6268 },
6269 "required": true
6270 },
6271 "responses": {
6272 "200": {
6273 "content": {
6274 "application/json": {
6275 "schema": {
6276 "items": {
6277 "$ref": "#/components/schemas/AssetResponseDto"
6278 },
6279 "type": "array"
6280 }
6281 }
6282 },
6283 "description": ""
6284 }
6285 },
6286 "security": [
6287 {
6288 "bearer": []
6289 },
6290 {
6291 "cookie": []
6292 },
6293 {
6294 "api_key": []
6295 }
6296 ],
6297 "tags": [
6298 "Search"
6299 ],
6300 "x-immich-permission": "asset.read",
6301 "description": "This endpoint requires the `asset.read` permission."
6302 }
6303 },
6304 "/search/smart": {
6305 "post": {
6306 "operationId": "searchSmart",
6307 "parameters": [],
6308 "requestBody": {
6309 "content": {
6310 "application/json": {
6311 "schema": {
6312 "$ref": "#/components/schemas/SmartSearchDto"
6313 }
6314 }
6315 },
6316 "required": true
6317 },
6318 "responses": {
6319 "200": {
6320 "content": {
6321 "application/json": {
6322 "schema": {
6323 "$ref": "#/components/schemas/SearchResponseDto"
6324 }
6325 }
6326 },
6327 "description": ""
6328 }
6329 },
6330 "security": [
6331 {
6332 "bearer": []
6333 },
6334 {
6335 "cookie": []
6336 },
6337 {
6338 "api_key": []
6339 }
6340 ],
6341 "tags": [
6342 "Search"
6343 ],
6344 "x-immich-permission": "asset.read",
6345 "description": "This endpoint requires the `asset.read` permission."
6346 }
6347 },
6348 "/search/statistics": {
6349 "post": {
6350 "operationId": "searchAssetStatistics",
6351 "parameters": [],
6352 "requestBody": {
6353 "content": {
6354 "application/json": {
6355 "schema": {
6356 "$ref": "#/components/schemas/StatisticsSearchDto"
6357 }
6358 }
6359 },
6360 "required": true
6361 },
6362 "responses": {
6363 "200": {
6364 "content": {
6365 "application/json": {
6366 "schema": {
6367 "$ref": "#/components/schemas/SearchStatisticsResponseDto"
6368 }
6369 }
6370 },
6371 "description": ""
6372 }
6373 },
6374 "security": [
6375 {
6376 "bearer": []
6377 },
6378 {
6379 "cookie": []
6380 },
6381 {
6382 "api_key": []
6383 }
6384 ],
6385 "tags": [
6386 "Search"
6387 ],
6388 "x-immich-permission": "asset.statistics",
6389 "description": "This endpoint requires the `asset.statistics` permission."
6390 }
6391 },
6392 "/search/suggestions": {
6393 "get": {
6394 "operationId": "getSearchSuggestions",
6395 "parameters": [
6396 {
6397 "name": "country",
6398 "required": false,
6399 "in": "query",
6400 "schema": {
6401 "type": "string"
6402 }
6403 },
6404 {
6405 "name": "includeNull",
6406 "required": false,
6407 "in": "query",
6408 "description": "This property was added in v111.0.0",
6409 "schema": {
6410 "type": "boolean"
6411 }
6412 },
6413 {
6414 "name": "make",
6415 "required": false,
6416 "in": "query",
6417 "schema": {
6418 "type": "string"
6419 }
6420 },
6421 {
6422 "name": "model",
6423 "required": false,
6424 "in": "query",
6425 "schema": {
6426 "type": "string"
6427 }
6428 },
6429 {
6430 "name": "state",
6431 "required": false,
6432 "in": "query",
6433 "schema": {
6434 "type": "string"
6435 }
6436 },
6437 {
6438 "name": "type",
6439 "required": true,
6440 "in": "query",
6441 "schema": {
6442 "$ref": "#/components/schemas/SearchSuggestionType"
6443 }
6444 }
6445 ],
6446 "responses": {
6447 "200": {
6448 "content": {
6449 "application/json": {
6450 "schema": {
6451 "items": {
6452 "type": "string"
6453 },
6454 "type": "array"
6455 }
6456 }
6457 },
6458 "description": ""
6459 }
6460 },
6461 "security": [
6462 {
6463 "bearer": []
6464 },
6465 {
6466 "cookie": []
6467 },
6468 {
6469 "api_key": []
6470 }
6471 ],
6472 "tags": [
6473 "Search"
6474 ],
6475 "x-immich-permission": "asset.read",
6476 "description": "This endpoint requires the `asset.read` permission."
6477 }
6478 },
6479 "/server/about": {
6480 "get": {
6481 "operationId": "getAboutInfo",
6482 "parameters": [],
6483 "responses": {
6484 "200": {
6485 "content": {
6486 "application/json": {
6487 "schema": {
6488 "$ref": "#/components/schemas/ServerAboutResponseDto"
6489 }
6490 }
6491 },
6492 "description": ""
6493 }
6494 },
6495 "security": [
6496 {
6497 "bearer": []
6498 },
6499 {
6500 "cookie": []
6501 },
6502 {
6503 "api_key": []
6504 }
6505 ],
6506 "tags": [
6507 "Server"
6508 ],
6509 "x-immich-permission": "server.about",
6510 "description": "This endpoint requires the `server.about` permission."
6511 }
6512 },
6513 "/server/apk-links": {
6514 "get": {
6515 "operationId": "getApkLinks",
6516 "parameters": [],
6517 "responses": {
6518 "200": {
6519 "content": {
6520 "application/json": {
6521 "schema": {
6522 "$ref": "#/components/schemas/ServerApkLinksDto"
6523 }
6524 }
6525 },
6526 "description": ""
6527 }
6528 },
6529 "security": [
6530 {
6531 "bearer": []
6532 },
6533 {
6534 "cookie": []
6535 },
6536 {
6537 "api_key": []
6538 }
6539 ],
6540 "tags": [
6541 "Server"
6542 ],
6543 "x-immich-permission": "server.apkLinks",
6544 "description": "This endpoint requires the `server.apkLinks` permission."
6545 }
6546 },
6547 "/server/config": {
6548 "get": {
6549 "operationId": "getServerConfig",
6550 "parameters": [],
6551 "responses": {
6552 "200": {
6553 "content": {
6554 "application/json": {
6555 "schema": {
6556 "$ref": "#/components/schemas/ServerConfigDto"
6557 }
6558 }
6559 },
6560 "description": ""
6561 }
6562 },
6563 "tags": [
6564 "Server"
6565 ]
6566 }
6567 },
6568 "/server/features": {
6569 "get": {
6570 "operationId": "getServerFeatures",
6571 "parameters": [],
6572 "responses": {
6573 "200": {
6574 "content": {
6575 "application/json": {
6576 "schema": {
6577 "$ref": "#/components/schemas/ServerFeaturesDto"
6578 }
6579 }
6580 },
6581 "description": ""
6582 }
6583 },
6584 "tags": [
6585 "Server"
6586 ]
6587 }
6588 },
6589 "/server/license": {
6590 "delete": {
6591 "operationId": "deleteServerLicense",
6592 "parameters": [],
6593 "responses": {
6594 "204": {
6595 "description": ""
6596 }
6597 },
6598 "security": [
6599 {
6600 "bearer": []
6601 },
6602 {
6603 "cookie": []
6604 },
6605 {
6606 "api_key": []
6607 }
6608 ],
6609 "tags": [
6610 "Server"
6611 ],
6612 "x-immich-admin-only": true,
6613 "x-immich-permission": "serverLicense.delete",
6614 "description": "This endpoint is an admin-only route, and requires the `serverLicense.delete` permission."
6615 },
6616 "get": {
6617 "operationId": "getServerLicense",
6618 "parameters": [],
6619 "responses": {
6620 "200": {
6621 "content": {
6622 "application/json": {
6623 "schema": {
6624 "$ref": "#/components/schemas/LicenseResponseDto"
6625 }
6626 }
6627 },
6628 "description": ""
6629 },
6630 "404": {
6631 "description": ""
6632 }
6633 },
6634 "security": [
6635 {
6636 "bearer": []
6637 },
6638 {
6639 "cookie": []
6640 },
6641 {
6642 "api_key": []
6643 }
6644 ],
6645 "tags": [
6646 "Server"
6647 ],
6648 "x-immich-admin-only": true,
6649 "x-immich-permission": "serverLicense.read",
6650 "description": "This endpoint is an admin-only route, and requires the `serverLicense.read` permission."
6651 },
6652 "put": {
6653 "operationId": "setServerLicense",
6654 "parameters": [],
6655 "requestBody": {
6656 "content": {
6657 "application/json": {
6658 "schema": {
6659 "$ref": "#/components/schemas/LicenseKeyDto"
6660 }
6661 }
6662 },
6663 "required": true
6664 },
6665 "responses": {
6666 "200": {
6667 "content": {
6668 "application/json": {
6669 "schema": {
6670 "$ref": "#/components/schemas/LicenseResponseDto"
6671 }
6672 }
6673 },
6674 "description": ""
6675 }
6676 },
6677 "security": [
6678 {
6679 "bearer": []
6680 },
6681 {
6682 "cookie": []
6683 },
6684 {
6685 "api_key": []
6686 }
6687 ],
6688 "tags": [
6689 "Server"
6690 ],
6691 "x-immich-admin-only": true,
6692 "x-immich-permission": "serverLicense.update",
6693 "description": "This endpoint is an admin-only route, and requires the `serverLicense.update` permission."
6694 }
6695 },
6696 "/server/media-types": {
6697 "get": {
6698 "operationId": "getSupportedMediaTypes",
6699 "parameters": [],
6700 "responses": {
6701 "200": {
6702 "content": {
6703 "application/json": {
6704 "schema": {
6705 "$ref": "#/components/schemas/ServerMediaTypesResponseDto"
6706 }
6707 }
6708 },
6709 "description": ""
6710 }
6711 },
6712 "tags": [
6713 "Server"
6714 ]
6715 }
6716 },
6717 "/server/ping": {
6718 "get": {
6719 "operationId": "pingServer",
6720 "parameters": [],
6721 "responses": {
6722 "200": {
6723 "content": {
6724 "application/json": {
6725 "schema": {
6726 "$ref": "#/components/schemas/ServerPingResponse"
6727 }
6728 }
6729 },
6730 "description": ""
6731 }
6732 },
6733 "tags": [
6734 "Server"
6735 ]
6736 }
6737 },
6738 "/server/statistics": {
6739 "get": {
6740 "operationId": "getServerStatistics",
6741 "parameters": [],
6742 "responses": {
6743 "200": {
6744 "content": {
6745 "application/json": {
6746 "schema": {
6747 "$ref": "#/components/schemas/ServerStatsResponseDto"
6748 }
6749 }
6750 },
6751 "description": ""
6752 }
6753 },
6754 "security": [
6755 {
6756 "bearer": []
6757 },
6758 {
6759 "cookie": []
6760 },
6761 {
6762 "api_key": []
6763 }
6764 ],
6765 "tags": [
6766 "Server"
6767 ],
6768 "x-immich-admin-only": true,
6769 "x-immich-permission": "server.statistics",
6770 "description": "This endpoint is an admin-only route, and requires the `server.statistics` permission."
6771 }
6772 },
6773 "/server/storage": {
6774 "get": {
6775 "operationId": "getStorage",
6776 "parameters": [],
6777 "responses": {
6778 "200": {
6779 "content": {
6780 "application/json": {
6781 "schema": {
6782 "$ref": "#/components/schemas/ServerStorageResponseDto"
6783 }
6784 }
6785 },
6786 "description": ""
6787 }
6788 },
6789 "security": [
6790 {
6791 "bearer": []
6792 },
6793 {
6794 "cookie": []
6795 },
6796 {
6797 "api_key": []
6798 }
6799 ],
6800 "tags": [
6801 "Server"
6802 ],
6803 "x-immich-permission": "server.storage",
6804 "description": "This endpoint requires the `server.storage` permission."
6805 }
6806 },
6807 "/server/theme": {
6808 "get": {
6809 "operationId": "getTheme",
6810 "parameters": [],
6811 "responses": {
6812 "200": {
6813 "content": {
6814 "application/json": {
6815 "schema": {
6816 "$ref": "#/components/schemas/ServerThemeDto"
6817 }
6818 }
6819 },
6820 "description": ""
6821 }
6822 },
6823 "tags": [
6824 "Server"
6825 ]
6826 }
6827 },
6828 "/server/version": {
6829 "get": {
6830 "operationId": "getServerVersion",
6831 "parameters": [],
6832 "responses": {
6833 "200": {
6834 "content": {
6835 "application/json": {
6836 "schema": {
6837 "$ref": "#/components/schemas/ServerVersionResponseDto"
6838 }
6839 }
6840 },
6841 "description": ""
6842 }
6843 },
6844 "tags": [
6845 "Server"
6846 ]
6847 }
6848 },
6849 "/server/version-check": {
6850 "get": {
6851 "operationId": "getVersionCheck",
6852 "parameters": [],
6853 "responses": {
6854 "200": {
6855 "content": {
6856 "application/json": {
6857 "schema": {
6858 "$ref": "#/components/schemas/VersionCheckStateResponseDto"
6859 }
6860 }
6861 },
6862 "description": ""
6863 }
6864 },
6865 "security": [
6866 {
6867 "bearer": []
6868 },
6869 {
6870 "cookie": []
6871 },
6872 {
6873 "api_key": []
6874 }
6875 ],
6876 "tags": [
6877 "Server"
6878 ],
6879 "x-immich-permission": "server.versionCheck",
6880 "description": "This endpoint requires the `server.versionCheck` permission."
6881 }
6882 },
6883 "/server/version-history": {
6884 "get": {
6885 "operationId": "getVersionHistory",
6886 "parameters": [],
6887 "responses": {
6888 "200": {
6889 "content": {
6890 "application/json": {
6891 "schema": {
6892 "items": {
6893 "$ref": "#/components/schemas/ServerVersionHistoryResponseDto"
6894 },
6895 "type": "array"
6896 }
6897 }
6898 },
6899 "description": ""
6900 }
6901 },
6902 "tags": [
6903 "Server"
6904 ]
6905 }
6906 },
6907 "/sessions": {
6908 "delete": {
6909 "operationId": "deleteAllSessions",
6910 "parameters": [],
6911 "responses": {
6912 "204": {
6913 "description": ""
6914 }
6915 },
6916 "security": [
6917 {
6918 "bearer": []
6919 },
6920 {
6921 "cookie": []
6922 },
6923 {
6924 "api_key": []
6925 }
6926 ],
6927 "tags": [
6928 "Sessions"
6929 ],
6930 "x-immich-permission": "session.delete",
6931 "description": "This endpoint requires the `session.delete` permission."
6932 },
6933 "get": {
6934 "operationId": "getSessions",
6935 "parameters": [],
6936 "responses": {
6937 "200": {
6938 "content": {
6939 "application/json": {
6940 "schema": {
6941 "items": {
6942 "$ref": "#/components/schemas/SessionResponseDto"
6943 },
6944 "type": "array"
6945 }
6946 }
6947 },
6948 "description": ""
6949 }
6950 },
6951 "security": [
6952 {
6953 "bearer": []
6954 },
6955 {
6956 "cookie": []
6957 },
6958 {
6959 "api_key": []
6960 }
6961 ],
6962 "tags": [
6963 "Sessions"
6964 ],
6965 "x-immich-permission": "session.read",
6966 "description": "This endpoint requires the `session.read` permission."
6967 },
6968 "post": {
6969 "operationId": "createSession",
6970 "parameters": [],
6971 "requestBody": {
6972 "content": {
6973 "application/json": {
6974 "schema": {
6975 "$ref": "#/components/schemas/SessionCreateDto"
6976 }
6977 }
6978 },
6979 "required": true
6980 },
6981 "responses": {
6982 "201": {
6983 "content": {
6984 "application/json": {
6985 "schema": {
6986 "$ref": "#/components/schemas/SessionCreateResponseDto"
6987 }
6988 }
6989 },
6990 "description": ""
6991 }
6992 },
6993 "security": [
6994 {
6995 "bearer": []
6996 },
6997 {
6998 "cookie": []
6999 },
7000 {
7001 "api_key": []
7002 }
7003 ],
7004 "tags": [
7005 "Sessions"
7006 ],
7007 "x-immich-permission": "session.create",
7008 "description": "This endpoint requires the `session.create` permission."
7009 }
7010 },
7011 "/sessions/{id}": {
7012 "delete": {
7013 "operationId": "deleteSession",
7014 "parameters": [
7015 {
7016 "name": "id",
7017 "required": true,
7018 "in": "path",
7019 "schema": {
7020 "format": "uuid",
7021 "type": "string"
7022 }
7023 }
7024 ],
7025 "responses": {
7026 "204": {
7027 "description": ""
7028 }
7029 },
7030 "security": [
7031 {
7032 "bearer": []
7033 },
7034 {
7035 "cookie": []
7036 },
7037 {
7038 "api_key": []
7039 }
7040 ],
7041 "tags": [
7042 "Sessions"
7043 ],
7044 "x-immich-permission": "session.delete",
7045 "description": "This endpoint requires the `session.delete` permission."
7046 },
7047 "put": {
7048 "operationId": "updateSession",
7049 "parameters": [
7050 {
7051 "name": "id",
7052 "required": true,
7053 "in": "path",
7054 "schema": {
7055 "format": "uuid",
7056 "type": "string"
7057 }
7058 }
7059 ],
7060 "requestBody": {
7061 "content": {
7062 "application/json": {
7063 "schema": {
7064 "$ref": "#/components/schemas/SessionUpdateDto"
7065 }
7066 }
7067 },
7068 "required": true
7069 },
7070 "responses": {
7071 "200": {
7072 "content": {
7073 "application/json": {
7074 "schema": {
7075 "$ref": "#/components/schemas/SessionResponseDto"
7076 }
7077 }
7078 },
7079 "description": ""
7080 }
7081 },
7082 "security": [
7083 {
7084 "bearer": []
7085 },
7086 {
7087 "cookie": []
7088 },
7089 {
7090 "api_key": []
7091 }
7092 ],
7093 "tags": [
7094 "Sessions"
7095 ],
7096 "x-immich-permission": "session.update",
7097 "description": "This endpoint requires the `session.update` permission."
7098 }
7099 },
7100 "/sessions/{id}/lock": {
7101 "post": {
7102 "operationId": "lockSession",
7103 "parameters": [
7104 {
7105 "name": "id",
7106 "required": true,
7107 "in": "path",
7108 "schema": {
7109 "format": "uuid",
7110 "type": "string"
7111 }
7112 }
7113 ],
7114 "responses": {
7115 "204": {
7116 "description": ""
7117 }
7118 },
7119 "security": [
7120 {
7121 "bearer": []
7122 },
7123 {
7124 "cookie": []
7125 },
7126 {
7127 "api_key": []
7128 }
7129 ],
7130 "tags": [
7131 "Sessions"
7132 ],
7133 "x-immich-permission": "session.lock",
7134 "description": "This endpoint requires the `session.lock` permission."
7135 }
7136 },
7137 "/shared-links": {
7138 "get": {
7139 "operationId": "getAllSharedLinks",
7140 "parameters": [
7141 {
7142 "name": "albumId",
7143 "required": false,
7144 "in": "query",
7145 "schema": {
7146 "format": "uuid",
7147 "type": "string"
7148 }
7149 }
7150 ],
7151 "responses": {
7152 "200": {
7153 "content": {
7154 "application/json": {
7155 "schema": {
7156 "items": {
7157 "$ref": "#/components/schemas/SharedLinkResponseDto"
7158 },
7159 "type": "array"
7160 }
7161 }
7162 },
7163 "description": ""
7164 }
7165 },
7166 "security": [
7167 {
7168 "bearer": []
7169 },
7170 {
7171 "cookie": []
7172 },
7173 {
7174 "api_key": []
7175 }
7176 ],
7177 "tags": [
7178 "Shared Links"
7179 ],
7180 "x-immich-permission": "sharedLink.read",
7181 "description": "This endpoint requires the `sharedLink.read` permission."
7182 },
7183 "post": {
7184 "operationId": "createSharedLink",
7185 "parameters": [],
7186 "requestBody": {
7187 "content": {
7188 "application/json": {
7189 "schema": {
7190 "$ref": "#/components/schemas/SharedLinkCreateDto"
7191 }
7192 }
7193 },
7194 "required": true
7195 },
7196 "responses": {
7197 "201": {
7198 "content": {
7199 "application/json": {
7200 "schema": {
7201 "$ref": "#/components/schemas/SharedLinkResponseDto"
7202 }
7203 }
7204 },
7205 "description": ""
7206 }
7207 },
7208 "security": [
7209 {
7210 "bearer": []
7211 },
7212 {
7213 "cookie": []
7214 },
7215 {
7216 "api_key": []
7217 }
7218 ],
7219 "tags": [
7220 "Shared Links"
7221 ],
7222 "x-immich-permission": "sharedLink.create",
7223 "description": "This endpoint requires the `sharedLink.create` permission."
7224 }
7225 },
7226 "/shared-links/me": {
7227 "get": {
7228 "operationId": "getMySharedLink",
7229 "parameters": [
7230 {
7231 "name": "password",
7232 "required": false,
7233 "in": "query",
7234 "schema": {
7235 "example": "password",
7236 "type": "string"
7237 }
7238 },
7239 {
7240 "name": "token",
7241 "required": false,
7242 "in": "query",
7243 "schema": {
7244 "type": "string"
7245 }
7246 },
7247 {
7248 "name": "key",
7249 "required": false,
7250 "in": "query",
7251 "schema": {
7252 "type": "string"
7253 }
7254 },
7255 {
7256 "name": "slug",
7257 "required": false,
7258 "in": "query",
7259 "schema": {
7260 "type": "string"
7261 }
7262 }
7263 ],
7264 "responses": {
7265 "200": {
7266 "content": {
7267 "application/json": {
7268 "schema": {
7269 "$ref": "#/components/schemas/SharedLinkResponseDto"
7270 }
7271 }
7272 },
7273 "description": ""
7274 }
7275 },
7276 "security": [
7277 {
7278 "bearer": []
7279 },
7280 {
7281 "cookie": []
7282 },
7283 {
7284 "api_key": []
7285 }
7286 ],
7287 "tags": [
7288 "Shared Links"
7289 ]
7290 }
7291 },
7292 "/shared-links/{id}": {
7293 "delete": {
7294 "operationId": "removeSharedLink",
7295 "parameters": [
7296 {
7297 "name": "id",
7298 "required": true,
7299 "in": "path",
7300 "schema": {
7301 "format": "uuid",
7302 "type": "string"
7303 }
7304 }
7305 ],
7306 "responses": {
7307 "204": {
7308 "description": ""
7309 }
7310 },
7311 "security": [
7312 {
7313 "bearer": []
7314 },
7315 {
7316 "cookie": []
7317 },
7318 {
7319 "api_key": []
7320 }
7321 ],
7322 "tags": [
7323 "Shared Links"
7324 ],
7325 "x-immich-permission": "sharedLink.delete",
7326 "description": "This endpoint requires the `sharedLink.delete` permission."
7327 },
7328 "get": {
7329 "operationId": "getSharedLinkById",
7330 "parameters": [
7331 {
7332 "name": "id",
7333 "required": true,
7334 "in": "path",
7335 "schema": {
7336 "format": "uuid",
7337 "type": "string"
7338 }
7339 }
7340 ],
7341 "responses": {
7342 "200": {
7343 "content": {
7344 "application/json": {
7345 "schema": {
7346 "$ref": "#/components/schemas/SharedLinkResponseDto"
7347 }
7348 }
7349 },
7350 "description": ""
7351 }
7352 },
7353 "security": [
7354 {
7355 "bearer": []
7356 },
7357 {
7358 "cookie": []
7359 },
7360 {
7361 "api_key": []
7362 }
7363 ],
7364 "tags": [
7365 "Shared Links"
7366 ],
7367 "x-immich-permission": "sharedLink.read",
7368 "description": "This endpoint requires the `sharedLink.read` permission."
7369 },
7370 "patch": {
7371 "operationId": "updateSharedLink",
7372 "parameters": [
7373 {
7374 "name": "id",
7375 "required": true,
7376 "in": "path",
7377 "schema": {
7378 "format": "uuid",
7379 "type": "string"
7380 }
7381 }
7382 ],
7383 "requestBody": {
7384 "content": {
7385 "application/json": {
7386 "schema": {
7387 "$ref": "#/components/schemas/SharedLinkEditDto"
7388 }
7389 }
7390 },
7391 "required": true
7392 },
7393 "responses": {
7394 "200": {
7395 "content": {
7396 "application/json": {
7397 "schema": {
7398 "$ref": "#/components/schemas/SharedLinkResponseDto"
7399 }
7400 }
7401 },
7402 "description": ""
7403 }
7404 },
7405 "security": [
7406 {
7407 "bearer": []
7408 },
7409 {
7410 "cookie": []
7411 },
7412 {
7413 "api_key": []
7414 }
7415 ],
7416 "tags": [
7417 "Shared Links"
7418 ],
7419 "x-immich-permission": "sharedLink.update",
7420 "description": "This endpoint requires the `sharedLink.update` permission."
7421 }
7422 },
7423 "/shared-links/{id}/assets": {
7424 "delete": {
7425 "operationId": "removeSharedLinkAssets",
7426 "parameters": [
7427 {
7428 "name": "id",
7429 "required": true,
7430 "in": "path",
7431 "schema": {
7432 "format": "uuid",
7433 "type": "string"
7434 }
7435 },
7436 {
7437 "name": "key",
7438 "required": false,
7439 "in": "query",
7440 "schema": {
7441 "type": "string"
7442 }
7443 },
7444 {
7445 "name": "slug",
7446 "required": false,
7447 "in": "query",
7448 "schema": {
7449 "type": "string"
7450 }
7451 }
7452 ],
7453 "requestBody": {
7454 "content": {
7455 "application/json": {
7456 "schema": {
7457 "$ref": "#/components/schemas/AssetIdsDto"
7458 }
7459 }
7460 },
7461 "required": true
7462 },
7463 "responses": {
7464 "200": {
7465 "content": {
7466 "application/json": {
7467 "schema": {
7468 "items": {
7469 "$ref": "#/components/schemas/AssetIdsResponseDto"
7470 },
7471 "type": "array"
7472 }
7473 }
7474 },
7475 "description": ""
7476 }
7477 },
7478 "security": [
7479 {
7480 "bearer": []
7481 },
7482 {
7483 "cookie": []
7484 },
7485 {
7486 "api_key": []
7487 }
7488 ],
7489 "tags": [
7490 "Shared Links"
7491 ]
7492 },
7493 "put": {
7494 "operationId": "addSharedLinkAssets",
7495 "parameters": [
7496 {
7497 "name": "id",
7498 "required": true,
7499 "in": "path",
7500 "schema": {
7501 "format": "uuid",
7502 "type": "string"
7503 }
7504 },
7505 {
7506 "name": "key",
7507 "required": false,
7508 "in": "query",
7509 "schema": {
7510 "type": "string"
7511 }
7512 },
7513 {
7514 "name": "slug",
7515 "required": false,
7516 "in": "query",
7517 "schema": {
7518 "type": "string"
7519 }
7520 }
7521 ],
7522 "requestBody": {
7523 "content": {
7524 "application/json": {
7525 "schema": {
7526 "$ref": "#/components/schemas/AssetIdsDto"
7527 }
7528 }
7529 },
7530 "required": true
7531 },
7532 "responses": {
7533 "200": {
7534 "content": {
7535 "application/json": {
7536 "schema": {
7537 "items": {
7538 "$ref": "#/components/schemas/AssetIdsResponseDto"
7539 },
7540 "type": "array"
7541 }
7542 }
7543 },
7544 "description": ""
7545 }
7546 },
7547 "security": [
7548 {
7549 "bearer": []
7550 },
7551 {
7552 "cookie": []
7553 },
7554 {
7555 "api_key": []
7556 }
7557 ],
7558 "tags": [
7559 "Shared Links"
7560 ]
7561 }
7562 },
7563 "/stacks": {
7564 "delete": {
7565 "operationId": "deleteStacks",
7566 "parameters": [],
7567 "requestBody": {
7568 "content": {
7569 "application/json": {
7570 "schema": {
7571 "$ref": "#/components/schemas/BulkIdsDto"
7572 }
7573 }
7574 },
7575 "required": true
7576 },
7577 "responses": {
7578 "204": {
7579 "description": ""
7580 }
7581 },
7582 "security": [
7583 {
7584 "bearer": []
7585 },
7586 {
7587 "cookie": []
7588 },
7589 {
7590 "api_key": []
7591 }
7592 ],
7593 "tags": [
7594 "Stacks"
7595 ],
7596 "x-immich-permission": "stack.delete",
7597 "description": "This endpoint requires the `stack.delete` permission."
7598 },
7599 "get": {
7600 "operationId": "searchStacks",
7601 "parameters": [
7602 {
7603 "name": "primaryAssetId",
7604 "required": false,
7605 "in": "query",
7606 "schema": {
7607 "format": "uuid",
7608 "type": "string"
7609 }
7610 }
7611 ],
7612 "responses": {
7613 "200": {
7614 "content": {
7615 "application/json": {
7616 "schema": {
7617 "items": {
7618 "$ref": "#/components/schemas/StackResponseDto"
7619 },
7620 "type": "array"
7621 }
7622 }
7623 },
7624 "description": ""
7625 }
7626 },
7627 "security": [
7628 {
7629 "bearer": []
7630 },
7631 {
7632 "cookie": []
7633 },
7634 {
7635 "api_key": []
7636 }
7637 ],
7638 "tags": [
7639 "Stacks"
7640 ],
7641 "x-immich-permission": "stack.read",
7642 "description": "This endpoint requires the `stack.read` permission."
7643 },
7644 "post": {
7645 "operationId": "createStack",
7646 "parameters": [],
7647 "requestBody": {
7648 "content": {
7649 "application/json": {
7650 "schema": {
7651 "$ref": "#/components/schemas/StackCreateDto"
7652 }
7653 }
7654 },
7655 "required": true
7656 },
7657 "responses": {
7658 "201": {
7659 "content": {
7660 "application/json": {
7661 "schema": {
7662 "$ref": "#/components/schemas/StackResponseDto"
7663 }
7664 }
7665 },
7666 "description": ""
7667 }
7668 },
7669 "security": [
7670 {
7671 "bearer": []
7672 },
7673 {
7674 "cookie": []
7675 },
7676 {
7677 "api_key": []
7678 }
7679 ],
7680 "tags": [
7681 "Stacks"
7682 ],
7683 "x-immich-permission": "stack.create",
7684 "description": "This endpoint requires the `stack.create` permission."
7685 }
7686 },
7687 "/stacks/{id}": {
7688 "delete": {
7689 "operationId": "deleteStack",
7690 "parameters": [
7691 {
7692 "name": "id",
7693 "required": true,
7694 "in": "path",
7695 "schema": {
7696 "format": "uuid",
7697 "type": "string"
7698 }
7699 }
7700 ],
7701 "responses": {
7702 "204": {
7703 "description": ""
7704 }
7705 },
7706 "security": [
7707 {
7708 "bearer": []
7709 },
7710 {
7711 "cookie": []
7712 },
7713 {
7714 "api_key": []
7715 }
7716 ],
7717 "tags": [
7718 "Stacks"
7719 ],
7720 "x-immich-permission": "stack.delete",
7721 "description": "This endpoint requires the `stack.delete` permission."
7722 },
7723 "get": {
7724 "operationId": "getStack",
7725 "parameters": [
7726 {
7727 "name": "id",
7728 "required": true,
7729 "in": "path",
7730 "schema": {
7731 "format": "uuid",
7732 "type": "string"
7733 }
7734 }
7735 ],
7736 "responses": {
7737 "200": {
7738 "content": {
7739 "application/json": {
7740 "schema": {
7741 "$ref": "#/components/schemas/StackResponseDto"
7742 }
7743 }
7744 },
7745 "description": ""
7746 }
7747 },
7748 "security": [
7749 {
7750 "bearer": []
7751 },
7752 {
7753 "cookie": []
7754 },
7755 {
7756 "api_key": []
7757 }
7758 ],
7759 "tags": [
7760 "Stacks"
7761 ],
7762 "x-immich-permission": "stack.read",
7763 "description": "This endpoint requires the `stack.read` permission."
7764 },
7765 "put": {
7766 "operationId": "updateStack",
7767 "parameters": [
7768 {
7769 "name": "id",
7770 "required": true,
7771 "in": "path",
7772 "schema": {
7773 "format": "uuid",
7774 "type": "string"
7775 }
7776 }
7777 ],
7778 "requestBody": {
7779 "content": {
7780 "application/json": {
7781 "schema": {
7782 "$ref": "#/components/schemas/StackUpdateDto"
7783 }
7784 }
7785 },
7786 "required": true
7787 },
7788 "responses": {
7789 "200": {
7790 "content": {
7791 "application/json": {
7792 "schema": {
7793 "$ref": "#/components/schemas/StackResponseDto"
7794 }
7795 }
7796 },
7797 "description": ""
7798 }
7799 },
7800 "security": [
7801 {
7802 "bearer": []
7803 },
7804 {
7805 "cookie": []
7806 },
7807 {
7808 "api_key": []
7809 }
7810 ],
7811 "tags": [
7812 "Stacks"
7813 ],
7814 "x-immich-permission": "stack.update",
7815 "description": "This endpoint requires the `stack.update` permission."
7816 }
7817 },
7818 "/stacks/{id}/assets/{assetId}": {
7819 "delete": {
7820 "operationId": "removeAssetFromStack",
7821 "parameters": [
7822 {
7823 "name": "assetId",
7824 "required": true,
7825 "in": "path",
7826 "schema": {
7827 "format": "uuid",
7828 "type": "string"
7829 }
7830 },
7831 {
7832 "name": "id",
7833 "required": true,
7834 "in": "path",
7835 "schema": {
7836 "format": "uuid",
7837 "type": "string"
7838 }
7839 }
7840 ],
7841 "responses": {
7842 "204": {
7843 "description": ""
7844 }
7845 },
7846 "security": [
7847 {
7848 "bearer": []
7849 },
7850 {
7851 "cookie": []
7852 },
7853 {
7854 "api_key": []
7855 }
7856 ],
7857 "tags": [
7858 "Stacks"
7859 ],
7860 "x-immich-permission": "stack.update",
7861 "description": "This endpoint requires the `stack.update` permission."
7862 }
7863 },
7864 "/sync/ack": {
7865 "delete": {
7866 "operationId": "deleteSyncAck",
7867 "parameters": [],
7868 "requestBody": {
7869 "content": {
7870 "application/json": {
7871 "schema": {
7872 "$ref": "#/components/schemas/SyncAckDeleteDto"
7873 }
7874 }
7875 },
7876 "required": true
7877 },
7878 "responses": {
7879 "204": {
7880 "description": ""
7881 }
7882 },
7883 "security": [
7884 {
7885 "bearer": []
7886 },
7887 {
7888 "cookie": []
7889 },
7890 {
7891 "api_key": []
7892 }
7893 ],
7894 "tags": [
7895 "Sync"
7896 ],
7897 "x-immich-permission": "syncCheckpoint.delete",
7898 "description": "This endpoint requires the `syncCheckpoint.delete` permission."
7899 },
7900 "get": {
7901 "operationId": "getSyncAck",
7902 "parameters": [],
7903 "responses": {
7904 "200": {
7905 "content": {
7906 "application/json": {
7907 "schema": {
7908 "items": {
7909 "$ref": "#/components/schemas/SyncAckDto"
7910 },
7911 "type": "array"
7912 }
7913 }
7914 },
7915 "description": ""
7916 }
7917 },
7918 "security": [
7919 {
7920 "bearer": []
7921 },
7922 {
7923 "cookie": []
7924 },
7925 {
7926 "api_key": []
7927 }
7928 ],
7929 "tags": [
7930 "Sync"
7931 ],
7932 "x-immich-permission": "syncCheckpoint.read",
7933 "description": "This endpoint requires the `syncCheckpoint.read` permission."
7934 },
7935 "post": {
7936 "operationId": "sendSyncAck",
7937 "parameters": [],
7938 "requestBody": {
7939 "content": {
7940 "application/json": {
7941 "schema": {
7942 "$ref": "#/components/schemas/SyncAckSetDto"
7943 }
7944 }
7945 },
7946 "required": true
7947 },
7948 "responses": {
7949 "204": {
7950 "description": ""
7951 }
7952 },
7953 "security": [
7954 {
7955 "bearer": []
7956 },
7957 {
7958 "cookie": []
7959 },
7960 {
7961 "api_key": []
7962 }
7963 ],
7964 "tags": [
7965 "Sync"
7966 ],
7967 "x-immich-permission": "syncCheckpoint.update",
7968 "description": "This endpoint requires the `syncCheckpoint.update` permission."
7969 }
7970 },
7971 "/sync/delta-sync": {
7972 "post": {
7973 "operationId": "getDeltaSync",
7974 "parameters": [],
7975 "requestBody": {
7976 "content": {
7977 "application/json": {
7978 "schema": {
7979 "$ref": "#/components/schemas/AssetDeltaSyncDto"
7980 }
7981 }
7982 },
7983 "required": true
7984 },
7985 "responses": {
7986 "200": {
7987 "content": {
7988 "application/json": {
7989 "schema": {
7990 "$ref": "#/components/schemas/AssetDeltaSyncResponseDto"
7991 }
7992 }
7993 },
7994 "description": ""
7995 }
7996 },
7997 "security": [
7998 {
7999 "bearer": []
8000 },
8001 {
8002 "cookie": []
8003 },
8004 {
8005 "api_key": []
8006 }
8007 ],
8008 "tags": [
8009 "Sync"
8010 ]
8011 }
8012 },
8013 "/sync/full-sync": {
8014 "post": {
8015 "operationId": "getFullSyncForUser",
8016 "parameters": [],
8017 "requestBody": {
8018 "content": {
8019 "application/json": {
8020 "schema": {
8021 "$ref": "#/components/schemas/AssetFullSyncDto"
8022 }
8023 }
8024 },
8025 "required": true
8026 },
8027 "responses": {
8028 "200": {
8029 "content": {
8030 "application/json": {
8031 "schema": {
8032 "items": {
8033 "$ref": "#/components/schemas/AssetResponseDto"
8034 },
8035 "type": "array"
8036 }
8037 }
8038 },
8039 "description": ""
8040 }
8041 },
8042 "security": [
8043 {
8044 "bearer": []
8045 },
8046 {
8047 "cookie": []
8048 },
8049 {
8050 "api_key": []
8051 }
8052 ],
8053 "tags": [
8054 "Sync"
8055 ]
8056 }
8057 },
8058 "/sync/stream": {
8059 "post": {
8060 "operationId": "getSyncStream",
8061 "parameters": [],
8062 "requestBody": {
8063 "content": {
8064 "application/json": {
8065 "schema": {
8066 "$ref": "#/components/schemas/SyncStreamDto"
8067 }
8068 }
8069 },
8070 "required": true
8071 },
8072 "responses": {
8073 "200": {
8074 "description": ""
8075 }
8076 },
8077 "security": [
8078 {
8079 "bearer": []
8080 },
8081 {
8082 "cookie": []
8083 },
8084 {
8085 "api_key": []
8086 }
8087 ],
8088 "tags": [
8089 "Sync"
8090 ],
8091 "x-immich-permission": "sync.stream",
8092 "description": "This endpoint requires the `sync.stream` permission."
8093 }
8094 },
8095 "/system-config": {
8096 "get": {
8097 "operationId": "getConfig",
8098 "parameters": [],
8099 "responses": {
8100 "200": {
8101 "content": {
8102 "application/json": {
8103 "schema": {
8104 "$ref": "#/components/schemas/SystemConfigDto"
8105 }
8106 }
8107 },
8108 "description": ""
8109 }
8110 },
8111 "security": [
8112 {
8113 "bearer": []
8114 },
8115 {
8116 "cookie": []
8117 },
8118 {
8119 "api_key": []
8120 }
8121 ],
8122 "tags": [
8123 "System Config"
8124 ],
8125 "x-immich-admin-only": true,
8126 "x-immich-permission": "systemConfig.read",
8127 "description": "This endpoint is an admin-only route, and requires the `systemConfig.read` permission."
8128 },
8129 "put": {
8130 "operationId": "updateConfig",
8131 "parameters": [],
8132 "requestBody": {
8133 "content": {
8134 "application/json": {
8135 "schema": {
8136 "$ref": "#/components/schemas/SystemConfigDto"
8137 }
8138 }
8139 },
8140 "required": true
8141 },
8142 "responses": {
8143 "200": {
8144 "content": {
8145 "application/json": {
8146 "schema": {
8147 "$ref": "#/components/schemas/SystemConfigDto"
8148 }
8149 }
8150 },
8151 "description": ""
8152 }
8153 },
8154 "security": [
8155 {
8156 "bearer": []
8157 },
8158 {
8159 "cookie": []
8160 },
8161 {
8162 "api_key": []
8163 }
8164 ],
8165 "tags": [
8166 "System Config"
8167 ],
8168 "x-immich-admin-only": true,
8169 "x-immich-permission": "systemConfig.update",
8170 "description": "This endpoint is an admin-only route, and requires the `systemConfig.update` permission."
8171 }
8172 },
8173 "/system-config/defaults": {
8174 "get": {
8175 "operationId": "getConfigDefaults",
8176 "parameters": [],
8177 "responses": {
8178 "200": {
8179 "content": {
8180 "application/json": {
8181 "schema": {
8182 "$ref": "#/components/schemas/SystemConfigDto"
8183 }
8184 }
8185 },
8186 "description": ""
8187 }
8188 },
8189 "security": [
8190 {
8191 "bearer": []
8192 },
8193 {
8194 "cookie": []
8195 },
8196 {
8197 "api_key": []
8198 }
8199 ],
8200 "tags": [
8201 "System Config"
8202 ],
8203 "x-immich-admin-only": true,
8204 "x-immich-permission": "systemConfig.read",
8205 "description": "This endpoint is an admin-only route, and requires the `systemConfig.read` permission."
8206 }
8207 },
8208 "/system-config/storage-template-options": {
8209 "get": {
8210 "operationId": "getStorageTemplateOptions",
8211 "parameters": [],
8212 "responses": {
8213 "200": {
8214 "content": {
8215 "application/json": {
8216 "schema": {
8217 "$ref": "#/components/schemas/SystemConfigTemplateStorageOptionDto"
8218 }
8219 }
8220 },
8221 "description": ""
8222 }
8223 },
8224 "security": [
8225 {
8226 "bearer": []
8227 },
8228 {
8229 "cookie": []
8230 },
8231 {
8232 "api_key": []
8233 }
8234 ],
8235 "tags": [
8236 "System Config"
8237 ],
8238 "x-immich-admin-only": true,
8239 "x-immich-permission": "systemConfig.read",
8240 "description": "This endpoint is an admin-only route, and requires the `systemConfig.read` permission."
8241 }
8242 },
8243 "/system-metadata/admin-onboarding": {
8244 "get": {
8245 "operationId": "getAdminOnboarding",
8246 "parameters": [],
8247 "responses": {
8248 "200": {
8249 "content": {
8250 "application/json": {
8251 "schema": {
8252 "$ref": "#/components/schemas/AdminOnboardingUpdateDto"
8253 }
8254 }
8255 },
8256 "description": ""
8257 }
8258 },
8259 "security": [
8260 {
8261 "bearer": []
8262 },
8263 {
8264 "cookie": []
8265 },
8266 {
8267 "api_key": []
8268 }
8269 ],
8270 "tags": [
8271 "System Metadata"
8272 ],
8273 "x-immich-admin-only": true,
8274 "x-immich-permission": "systemMetadata.read",
8275 "description": "This endpoint is an admin-only route, and requires the `systemMetadata.read` permission."
8276 },
8277 "post": {
8278 "operationId": "updateAdminOnboarding",
8279 "parameters": [],
8280 "requestBody": {
8281 "content": {
8282 "application/json": {
8283 "schema": {
8284 "$ref": "#/components/schemas/AdminOnboardingUpdateDto"
8285 }
8286 }
8287 },
8288 "required": true
8289 },
8290 "responses": {
8291 "204": {
8292 "description": ""
8293 }
8294 },
8295 "security": [
8296 {
8297 "bearer": []
8298 },
8299 {
8300 "cookie": []
8301 },
8302 {
8303 "api_key": []
8304 }
8305 ],
8306 "tags": [
8307 "System Metadata"
8308 ],
8309 "x-immich-admin-only": true,
8310 "x-immich-permission": "systemMetadata.update",
8311 "description": "This endpoint is an admin-only route, and requires the `systemMetadata.update` permission."
8312 }
8313 },
8314 "/system-metadata/reverse-geocoding-state": {
8315 "get": {
8316 "operationId": "getReverseGeocodingState",
8317 "parameters": [],
8318 "responses": {
8319 "200": {
8320 "content": {
8321 "application/json": {
8322 "schema": {
8323 "$ref": "#/components/schemas/ReverseGeocodingStateResponseDto"
8324 }
8325 }
8326 },
8327 "description": ""
8328 }
8329 },
8330 "security": [
8331 {
8332 "bearer": []
8333 },
8334 {
8335 "cookie": []
8336 },
8337 {
8338 "api_key": []
8339 }
8340 ],
8341 "tags": [
8342 "System Metadata"
8343 ],
8344 "x-immich-admin-only": true,
8345 "x-immich-permission": "systemMetadata.read",
8346 "description": "This endpoint is an admin-only route, and requires the `systemMetadata.read` permission."
8347 }
8348 },
8349 "/system-metadata/version-check-state": {
8350 "get": {
8351 "operationId": "getVersionCheckState",
8352 "parameters": [],
8353 "responses": {
8354 "200": {
8355 "content": {
8356 "application/json": {
8357 "schema": {
8358 "$ref": "#/components/schemas/VersionCheckStateResponseDto"
8359 }
8360 }
8361 },
8362 "description": ""
8363 }
8364 },
8365 "security": [
8366 {
8367 "bearer": []
8368 },
8369 {
8370 "cookie": []
8371 },
8372 {
8373 "api_key": []
8374 }
8375 ],
8376 "tags": [
8377 "System Metadata"
8378 ],
8379 "x-immich-admin-only": true,
8380 "x-immich-permission": "systemMetadata.read",
8381 "description": "This endpoint is an admin-only route, and requires the `systemMetadata.read` permission."
8382 }
8383 },
8384 "/tags": {
8385 "get": {
8386 "operationId": "getAllTags",
8387 "parameters": [],
8388 "responses": {
8389 "200": {
8390 "content": {
8391 "application/json": {
8392 "schema": {
8393 "items": {
8394 "$ref": "#/components/schemas/TagResponseDto"
8395 },
8396 "type": "array"
8397 }
8398 }
8399 },
8400 "description": ""
8401 }
8402 },
8403 "security": [
8404 {
8405 "bearer": []
8406 },
8407 {
8408 "cookie": []
8409 },
8410 {
8411 "api_key": []
8412 }
8413 ],
8414 "tags": [
8415 "Tags"
8416 ],
8417 "x-immich-permission": "tag.read",
8418 "description": "This endpoint requires the `tag.read` permission."
8419 },
8420 "post": {
8421 "operationId": "createTag",
8422 "parameters": [],
8423 "requestBody": {
8424 "content": {
8425 "application/json": {
8426 "schema": {
8427 "$ref": "#/components/schemas/TagCreateDto"
8428 }
8429 }
8430 },
8431 "required": true
8432 },
8433 "responses": {
8434 "201": {
8435 "content": {
8436 "application/json": {
8437 "schema": {
8438 "$ref": "#/components/schemas/TagResponseDto"
8439 }
8440 }
8441 },
8442 "description": ""
8443 }
8444 },
8445 "security": [
8446 {
8447 "bearer": []
8448 },
8449 {
8450 "cookie": []
8451 },
8452 {
8453 "api_key": []
8454 }
8455 ],
8456 "tags": [
8457 "Tags"
8458 ],
8459 "x-immich-permission": "tag.create",
8460 "description": "This endpoint requires the `tag.create` permission."
8461 },
8462 "put": {
8463 "operationId": "upsertTags",
8464 "parameters": [],
8465 "requestBody": {
8466 "content": {
8467 "application/json": {
8468 "schema": {
8469 "$ref": "#/components/schemas/TagUpsertDto"
8470 }
8471 }
8472 },
8473 "required": true
8474 },
8475 "responses": {
8476 "200": {
8477 "content": {
8478 "application/json": {
8479 "schema": {
8480 "items": {
8481 "$ref": "#/components/schemas/TagResponseDto"
8482 },
8483 "type": "array"
8484 }
8485 }
8486 },
8487 "description": ""
8488 }
8489 },
8490 "security": [
8491 {
8492 "bearer": []
8493 },
8494 {
8495 "cookie": []
8496 },
8497 {
8498 "api_key": []
8499 }
8500 ],
8501 "tags": [
8502 "Tags"
8503 ],
8504 "x-immich-permission": "tag.create",
8505 "description": "This endpoint requires the `tag.create` permission."
8506 }
8507 },
8508 "/tags/assets": {
8509 "put": {
8510 "operationId": "bulkTagAssets",
8511 "parameters": [],
8512 "requestBody": {
8513 "content": {
8514 "application/json": {
8515 "schema": {
8516 "$ref": "#/components/schemas/TagBulkAssetsDto"
8517 }
8518 }
8519 },
8520 "required": true
8521 },
8522 "responses": {
8523 "200": {
8524 "content": {
8525 "application/json": {
8526 "schema": {
8527 "$ref": "#/components/schemas/TagBulkAssetsResponseDto"
8528 }
8529 }
8530 },
8531 "description": ""
8532 }
8533 },
8534 "security": [
8535 {
8536 "bearer": []
8537 },
8538 {
8539 "cookie": []
8540 },
8541 {
8542 "api_key": []
8543 }
8544 ],
8545 "tags": [
8546 "Tags"
8547 ],
8548 "x-immich-permission": "tag.asset",
8549 "description": "This endpoint requires the `tag.asset` permission."
8550 }
8551 },
8552 "/tags/{id}": {
8553 "delete": {
8554 "operationId": "deleteTag",
8555 "parameters": [
8556 {
8557 "name": "id",
8558 "required": true,
8559 "in": "path",
8560 "schema": {
8561 "format": "uuid",
8562 "type": "string"
8563 }
8564 }
8565 ],
8566 "responses": {
8567 "204": {
8568 "description": ""
8569 }
8570 },
8571 "security": [
8572 {
8573 "bearer": []
8574 },
8575 {
8576 "cookie": []
8577 },
8578 {
8579 "api_key": []
8580 }
8581 ],
8582 "tags": [
8583 "Tags"
8584 ],
8585 "x-immich-permission": "tag.delete",
8586 "description": "This endpoint requires the `tag.delete` permission."
8587 },
8588 "get": {
8589 "operationId": "getTagById",
8590 "parameters": [
8591 {
8592 "name": "id",
8593 "required": true,
8594 "in": "path",
8595 "schema": {
8596 "format": "uuid",
8597 "type": "string"
8598 }
8599 }
8600 ],
8601 "responses": {
8602 "200": {
8603 "content": {
8604 "application/json": {
8605 "schema": {
8606 "$ref": "#/components/schemas/TagResponseDto"
8607 }
8608 }
8609 },
8610 "description": ""
8611 }
8612 },
8613 "security": [
8614 {
8615 "bearer": []
8616 },
8617 {
8618 "cookie": []
8619 },
8620 {
8621 "api_key": []
8622 }
8623 ],
8624 "tags": [
8625 "Tags"
8626 ],
8627 "x-immich-permission": "tag.read",
8628 "description": "This endpoint requires the `tag.read` permission."
8629 },
8630 "put": {
8631 "operationId": "updateTag",
8632 "parameters": [
8633 {
8634 "name": "id",
8635 "required": true,
8636 "in": "path",
8637 "schema": {
8638 "format": "uuid",
8639 "type": "string"
8640 }
8641 }
8642 ],
8643 "requestBody": {
8644 "content": {
8645 "application/json": {
8646 "schema": {
8647 "$ref": "#/components/schemas/TagUpdateDto"
8648 }
8649 }
8650 },
8651 "required": true
8652 },
8653 "responses": {
8654 "200": {
8655 "content": {
8656 "application/json": {
8657 "schema": {
8658 "$ref": "#/components/schemas/TagResponseDto"
8659 }
8660 }
8661 },
8662 "description": ""
8663 }
8664 },
8665 "security": [
8666 {
8667 "bearer": []
8668 },
8669 {
8670 "cookie": []
8671 },
8672 {
8673 "api_key": []
8674 }
8675 ],
8676 "tags": [
8677 "Tags"
8678 ],
8679 "x-immich-permission": "tag.update",
8680 "description": "This endpoint requires the `tag.update` permission."
8681 }
8682 },
8683 "/tags/{id}/assets": {
8684 "delete": {
8685 "operationId": "untagAssets",
8686 "parameters": [
8687 {
8688 "name": "id",
8689 "required": true,
8690 "in": "path",
8691 "schema": {
8692 "format": "uuid",
8693 "type": "string"
8694 }
8695 }
8696 ],
8697 "requestBody": {
8698 "content": {
8699 "application/json": {
8700 "schema": {
8701 "$ref": "#/components/schemas/BulkIdsDto"
8702 }
8703 }
8704 },
8705 "required": true
8706 },
8707 "responses": {
8708 "200": {
8709 "content": {
8710 "application/json": {
8711 "schema": {
8712 "items": {
8713 "$ref": "#/components/schemas/BulkIdResponseDto"
8714 },
8715 "type": "array"
8716 }
8717 }
8718 },
8719 "description": ""
8720 }
8721 },
8722 "security": [
8723 {
8724 "bearer": []
8725 },
8726 {
8727 "cookie": []
8728 },
8729 {
8730 "api_key": []
8731 }
8732 ],
8733 "tags": [
8734 "Tags"
8735 ],
8736 "x-immich-permission": "tag.asset",
8737 "description": "This endpoint requires the `tag.asset` permission."
8738 },
8739 "put": {
8740 "operationId": "tagAssets",
8741 "parameters": [
8742 {
8743 "name": "id",
8744 "required": true,
8745 "in": "path",
8746 "schema": {
8747 "format": "uuid",
8748 "type": "string"
8749 }
8750 }
8751 ],
8752 "requestBody": {
8753 "content": {
8754 "application/json": {
8755 "schema": {
8756 "$ref": "#/components/schemas/BulkIdsDto"
8757 }
8758 }
8759 },
8760 "required": true
8761 },
8762 "responses": {
8763 "200": {
8764 "content": {
8765 "application/json": {
8766 "schema": {
8767 "items": {
8768 "$ref": "#/components/schemas/BulkIdResponseDto"
8769 },
8770 "type": "array"
8771 }
8772 }
8773 },
8774 "description": ""
8775 }
8776 },
8777 "security": [
8778 {
8779 "bearer": []
8780 },
8781 {
8782 "cookie": []
8783 },
8784 {
8785 "api_key": []
8786 }
8787 ],
8788 "tags": [
8789 "Tags"
8790 ],
8791 "x-immich-permission": "tag.asset",
8792 "description": "This endpoint requires the `tag.asset` permission."
8793 }
8794 },
8795 "/timeline/bucket": {
8796 "get": {
8797 "operationId": "getTimeBucket",
8798 "parameters": [
8799 {
8800 "name": "albumId",
8801 "required": false,
8802 "in": "query",
8803 "description": "Filter assets belonging to a specific album",
8804 "schema": {
8805 "format": "uuid",
8806 "type": "string"
8807 }
8808 },
8809 {
8810 "name": "isFavorite",
8811 "required": false,
8812 "in": "query",
8813 "description": "Filter by favorite status (true for favorites only, false for non-favorites only)",
8814 "schema": {
8815 "type": "boolean"
8816 }
8817 },
8818 {
8819 "name": "isTrashed",
8820 "required": false,
8821 "in": "query",
8822 "description": "Filter by trash status (true for trashed assets only, false for non-trashed only)",
8823 "schema": {
8824 "type": "boolean"
8825 }
8826 },
8827 {
8828 "name": "key",
8829 "required": false,
8830 "in": "query",
8831 "schema": {
8832 "type": "string"
8833 }
8834 },
8835 {
8836 "name": "order",
8837 "required": false,
8838 "in": "query",
8839 "description": "Sort order for assets within time buckets (ASC for oldest first, DESC for newest first)",
8840 "schema": {
8841 "$ref": "#/components/schemas/AssetOrder"
8842 }
8843 },
8844 {
8845 "name": "personId",
8846 "required": false,
8847 "in": "query",
8848 "description": "Filter assets containing a specific person (face recognition)",
8849 "schema": {
8850 "format": "uuid",
8851 "type": "string"
8852 }
8853 },
8854 {
8855 "name": "slug",
8856 "required": false,
8857 "in": "query",
8858 "schema": {
8859 "type": "string"
8860 }
8861 },
8862 {
8863 "name": "tagId",
8864 "required": false,
8865 "in": "query",
8866 "description": "Filter assets with a specific tag",
8867 "schema": {
8868 "format": "uuid",
8869 "type": "string"
8870 }
8871 },
8872 {
8873 "name": "timeBucket",
8874 "required": true,
8875 "in": "query",
8876 "description": "Time bucket identifier in YYYY-MM-DD format (e.g., \"2024-01-01\" for January 2024)",
8877 "schema": {
8878 "example": "2024-01-01",
8879 "type": "string"
8880 }
8881 },
8882 {
8883 "name": "userId",
8884 "required": false,
8885 "in": "query",
8886 "description": "Filter assets by specific user ID",
8887 "schema": {
8888 "format": "uuid",
8889 "type": "string"
8890 }
8891 },
8892 {
8893 "name": "visibility",
8894 "required": false,
8895 "in": "query",
8896 "description": "Filter by asset visibility status (ARCHIVE, TIMELINE, HIDDEN, LOCKED)",
8897 "schema": {
8898 "$ref": "#/components/schemas/AssetVisibility"
8899 }
8900 },
8901 {
8902 "name": "withCoordinates",
8903 "required": false,
8904 "in": "query",
8905 "description": "Include location data in the response",
8906 "schema": {
8907 "type": "boolean"
8908 }
8909 },
8910 {
8911 "name": "withPartners",
8912 "required": false,
8913 "in": "query",
8914 "description": "Include assets shared by partners",
8915 "schema": {
8916 "type": "boolean"
8917 }
8918 },
8919 {
8920 "name": "withStacked",
8921 "required": false,
8922 "in": "query",
8923 "description": "Include stacked assets in the response. When true, only primary assets from stacks are returned.",
8924 "schema": {
8925 "type": "boolean"
8926 }
8927 }
8928 ],
8929 "responses": {
8930 "200": {
8931 "content": {
8932 "application/json": {
8933 "schema": {
8934 "$ref": "#/components/schemas/TimeBucketAssetResponseDto"
8935 }
8936 }
8937 },
8938 "description": ""
8939 }
8940 },
8941 "security": [
8942 {
8943 "bearer": []
8944 },
8945 {
8946 "cookie": []
8947 },
8948 {
8949 "api_key": []
8950 }
8951 ],
8952 "tags": [
8953 "Timeline"
8954 ],
8955 "x-immich-permission": "asset.read",
8956 "description": "This endpoint requires the `asset.read` permission."
8957 }
8958 },
8959 "/timeline/buckets": {
8960 "get": {
8961 "operationId": "getTimeBuckets",
8962 "parameters": [
8963 {
8964 "name": "albumId",
8965 "required": false,
8966 "in": "query",
8967 "description": "Filter assets belonging to a specific album",
8968 "schema": {
8969 "format": "uuid",
8970 "type": "string"
8971 }
8972 },
8973 {
8974 "name": "isFavorite",
8975 "required": false,
8976 "in": "query",
8977 "description": "Filter by favorite status (true for favorites only, false for non-favorites only)",
8978 "schema": {
8979 "type": "boolean"
8980 }
8981 },
8982 {
8983 "name": "isTrashed",
8984 "required": false,
8985 "in": "query",
8986 "description": "Filter by trash status (true for trashed assets only, false for non-trashed only)",
8987 "schema": {
8988 "type": "boolean"
8989 }
8990 },
8991 {
8992 "name": "key",
8993 "required": false,
8994 "in": "query",
8995 "schema": {
8996 "type": "string"
8997 }
8998 },
8999 {
9000 "name": "order",
9001 "required": false,
9002 "in": "query",
9003 "description": "Sort order for assets within time buckets (ASC for oldest first, DESC for newest first)",
9004 "schema": {
9005 "$ref": "#/components/schemas/AssetOrder"
9006 }
9007 },
9008 {
9009 "name": "personId",
9010 "required": false,
9011 "in": "query",
9012 "description": "Filter assets containing a specific person (face recognition)",
9013 "schema": {
9014 "format": "uuid",
9015 "type": "string"
9016 }
9017 },
9018 {
9019 "name": "slug",
9020 "required": false,
9021 "in": "query",
9022 "schema": {
9023 "type": "string"
9024 }
9025 },
9026 {
9027 "name": "tagId",
9028 "required": false,
9029 "in": "query",
9030 "description": "Filter assets with a specific tag",
9031 "schema": {
9032 "format": "uuid",
9033 "type": "string"
9034 }
9035 },
9036 {
9037 "name": "userId",
9038 "required": false,
9039 "in": "query",
9040 "description": "Filter assets by specific user ID",
9041 "schema": {
9042 "format": "uuid",
9043 "type": "string"
9044 }
9045 },
9046 {
9047 "name": "visibility",
9048 "required": false,
9049 "in": "query",
9050 "description": "Filter by asset visibility status (ARCHIVE, TIMELINE, HIDDEN, LOCKED)",
9051 "schema": {
9052 "$ref": "#/components/schemas/AssetVisibility"
9053 }
9054 },
9055 {
9056 "name": "withCoordinates",
9057 "required": false,
9058 "in": "query",
9059 "description": "Include location data in the response",
9060 "schema": {
9061 "type": "boolean"
9062 }
9063 },
9064 {
9065 "name": "withPartners",
9066 "required": false,
9067 "in": "query",
9068 "description": "Include assets shared by partners",
9069 "schema": {
9070 "type": "boolean"
9071 }
9072 },
9073 {
9074 "name": "withStacked",
9075 "required": false,
9076 "in": "query",
9077 "description": "Include stacked assets in the response. When true, only primary assets from stacks are returned.",
9078 "schema": {
9079 "type": "boolean"
9080 }
9081 }
9082 ],
9083 "responses": {
9084 "200": {
9085 "content": {
9086 "application/json": {
9087 "schema": {
9088 "items": {
9089 "$ref": "#/components/schemas/TimeBucketsResponseDto"
9090 },
9091 "type": "array"
9092 }
9093 }
9094 },
9095 "description": ""
9096 }
9097 },
9098 "security": [
9099 {
9100 "bearer": []
9101 },
9102 {
9103 "cookie": []
9104 },
9105 {
9106 "api_key": []
9107 }
9108 ],
9109 "tags": [
9110 "Timeline"
9111 ],
9112 "x-immich-permission": "asset.read",
9113 "description": "This endpoint requires the `asset.read` permission."
9114 }
9115 },
9116 "/trash/empty": {
9117 "post": {
9118 "operationId": "emptyTrash",
9119 "parameters": [],
9120 "responses": {
9121 "200": {
9122 "content": {
9123 "application/json": {
9124 "schema": {
9125 "$ref": "#/components/schemas/TrashResponseDto"
9126 }
9127 }
9128 },
9129 "description": ""
9130 }
9131 },
9132 "security": [
9133 {
9134 "bearer": []
9135 },
9136 {
9137 "cookie": []
9138 },
9139 {
9140 "api_key": []
9141 }
9142 ],
9143 "tags": [
9144 "Trash"
9145 ],
9146 "x-immich-permission": "asset.delete",
9147 "description": "This endpoint requires the `asset.delete` permission."
9148 }
9149 },
9150 "/trash/restore": {
9151 "post": {
9152 "operationId": "restoreTrash",
9153 "parameters": [],
9154 "responses": {
9155 "200": {
9156 "content": {
9157 "application/json": {
9158 "schema": {
9159 "$ref": "#/components/schemas/TrashResponseDto"
9160 }
9161 }
9162 },
9163 "description": ""
9164 }
9165 },
9166 "security": [
9167 {
9168 "bearer": []
9169 },
9170 {
9171 "cookie": []
9172 },
9173 {
9174 "api_key": []
9175 }
9176 ],
9177 "tags": [
9178 "Trash"
9179 ],
9180 "x-immich-permission": "asset.delete",
9181 "description": "This endpoint requires the `asset.delete` permission."
9182 }
9183 },
9184 "/trash/restore/assets": {
9185 "post": {
9186 "operationId": "restoreAssets",
9187 "parameters": [],
9188 "requestBody": {
9189 "content": {
9190 "application/json": {
9191 "schema": {
9192 "$ref": "#/components/schemas/BulkIdsDto"
9193 }
9194 }
9195 },
9196 "required": true
9197 },
9198 "responses": {
9199 "200": {
9200 "content": {
9201 "application/json": {
9202 "schema": {
9203 "$ref": "#/components/schemas/TrashResponseDto"
9204 }
9205 }
9206 },
9207 "description": ""
9208 }
9209 },
9210 "security": [
9211 {
9212 "bearer": []
9213 },
9214 {
9215 "cookie": []
9216 },
9217 {
9218 "api_key": []
9219 }
9220 ],
9221 "tags": [
9222 "Trash"
9223 ],
9224 "x-immich-permission": "asset.delete",
9225 "description": "This endpoint requires the `asset.delete` permission."
9226 }
9227 },
9228 "/users": {
9229 "get": {
9230 "operationId": "searchUsers",
9231 "parameters": [],
9232 "responses": {
9233 "200": {
9234 "content": {
9235 "application/json": {
9236 "schema": {
9237 "items": {
9238 "$ref": "#/components/schemas/UserResponseDto"
9239 },
9240 "type": "array"
9241 }
9242 }
9243 },
9244 "description": ""
9245 }
9246 },
9247 "security": [
9248 {
9249 "bearer": []
9250 },
9251 {
9252 "cookie": []
9253 },
9254 {
9255 "api_key": []
9256 }
9257 ],
9258 "tags": [
9259 "Users"
9260 ],
9261 "x-immich-permission": "user.read",
9262 "description": "This endpoint requires the `user.read` permission."
9263 }
9264 },
9265 "/users/me": {
9266 "get": {
9267 "operationId": "getMyUser",
9268 "parameters": [],
9269 "responses": {
9270 "200": {
9271 "content": {
9272 "application/json": {
9273 "schema": {
9274 "$ref": "#/components/schemas/UserAdminResponseDto"
9275 }
9276 }
9277 },
9278 "description": ""
9279 }
9280 },
9281 "security": [
9282 {
9283 "bearer": []
9284 },
9285 {
9286 "cookie": []
9287 },
9288 {
9289 "api_key": []
9290 }
9291 ],
9292 "tags": [
9293 "Users"
9294 ],
9295 "x-immich-permission": "user.read",
9296 "description": "This endpoint requires the `user.read` permission."
9297 },
9298 "put": {
9299 "operationId": "updateMyUser",
9300 "parameters": [],
9301 "requestBody": {
9302 "content": {
9303 "application/json": {
9304 "schema": {
9305 "$ref": "#/components/schemas/UserUpdateMeDto"
9306 }
9307 }
9308 },
9309 "required": true
9310 },
9311 "responses": {
9312 "200": {
9313 "content": {
9314 "application/json": {
9315 "schema": {
9316 "$ref": "#/components/schemas/UserAdminResponseDto"
9317 }
9318 }
9319 },
9320 "description": ""
9321 }
9322 },
9323 "security": [
9324 {
9325 "bearer": []
9326 },
9327 {
9328 "cookie": []
9329 },
9330 {
9331 "api_key": []
9332 }
9333 ],
9334 "tags": [
9335 "Users"
9336 ],
9337 "x-immich-permission": "user.update",
9338 "description": "This endpoint requires the `user.update` permission."
9339 }
9340 },
9341 "/users/me/license": {
9342 "delete": {
9343 "operationId": "deleteUserLicense",
9344 "parameters": [],
9345 "responses": {
9346 "204": {
9347 "description": ""
9348 }
9349 },
9350 "security": [
9351 {
9352 "bearer": []
9353 },
9354 {
9355 "cookie": []
9356 },
9357 {
9358 "api_key": []
9359 }
9360 ],
9361 "tags": [
9362 "Users"
9363 ],
9364 "x-immich-permission": "userLicense.delete",
9365 "description": "This endpoint requires the `userLicense.delete` permission."
9366 },
9367 "get": {
9368 "operationId": "getUserLicense",
9369 "parameters": [],
9370 "responses": {
9371 "200": {
9372 "content": {
9373 "application/json": {
9374 "schema": {
9375 "$ref": "#/components/schemas/LicenseResponseDto"
9376 }
9377 }
9378 },
9379 "description": ""
9380 }
9381 },
9382 "security": [
9383 {
9384 "bearer": []
9385 },
9386 {
9387 "cookie": []
9388 },
9389 {
9390 "api_key": []
9391 }
9392 ],
9393 "tags": [
9394 "Users"
9395 ],
9396 "x-immich-permission": "userLicense.read",
9397 "description": "This endpoint requires the `userLicense.read` permission."
9398 },
9399 "put": {
9400 "operationId": "setUserLicense",
9401 "parameters": [],
9402 "requestBody": {
9403 "content": {
9404 "application/json": {
9405 "schema": {
9406 "$ref": "#/components/schemas/LicenseKeyDto"
9407 }
9408 }
9409 },
9410 "required": true
9411 },
9412 "responses": {
9413 "200": {
9414 "content": {
9415 "application/json": {
9416 "schema": {
9417 "$ref": "#/components/schemas/LicenseResponseDto"
9418 }
9419 }
9420 },
9421 "description": ""
9422 }
9423 },
9424 "security": [
9425 {
9426 "bearer": []
9427 },
9428 {
9429 "cookie": []
9430 },
9431 {
9432 "api_key": []
9433 }
9434 ],
9435 "tags": [
9436 "Users"
9437 ],
9438 "x-immich-permission": "userLicense.update",
9439 "description": "This endpoint requires the `userLicense.update` permission."
9440 }
9441 },
9442 "/users/me/onboarding": {
9443 "delete": {
9444 "operationId": "deleteUserOnboarding",
9445 "parameters": [],
9446 "responses": {
9447 "204": {
9448 "description": ""
9449 }
9450 },
9451 "security": [
9452 {
9453 "bearer": []
9454 },
9455 {
9456 "cookie": []
9457 },
9458 {
9459 "api_key": []
9460 }
9461 ],
9462 "tags": [
9463 "Users"
9464 ],
9465 "x-immich-permission": "userOnboarding.delete",
9466 "description": "This endpoint requires the `userOnboarding.delete` permission."
9467 },
9468 "get": {
9469 "operationId": "getUserOnboarding",
9470 "parameters": [],
9471 "responses": {
9472 "200": {
9473 "content": {
9474 "application/json": {
9475 "schema": {
9476 "$ref": "#/components/schemas/OnboardingResponseDto"
9477 }
9478 }
9479 },
9480 "description": ""
9481 }
9482 },
9483 "security": [
9484 {
9485 "bearer": []
9486 },
9487 {
9488 "cookie": []
9489 },
9490 {
9491 "api_key": []
9492 }
9493 ],
9494 "tags": [
9495 "Users"
9496 ],
9497 "x-immich-permission": "userOnboarding.read",
9498 "description": "This endpoint requires the `userOnboarding.read` permission."
9499 },
9500 "put": {
9501 "operationId": "setUserOnboarding",
9502 "parameters": [],
9503 "requestBody": {
9504 "content": {
9505 "application/json": {
9506 "schema": {
9507 "$ref": "#/components/schemas/OnboardingDto"
9508 }
9509 }
9510 },
9511 "required": true
9512 },
9513 "responses": {
9514 "200": {
9515 "content": {
9516 "application/json": {
9517 "schema": {
9518 "$ref": "#/components/schemas/OnboardingResponseDto"
9519 }
9520 }
9521 },
9522 "description": ""
9523 }
9524 },
9525 "security": [
9526 {
9527 "bearer": []
9528 },
9529 {
9530 "cookie": []
9531 },
9532 {
9533 "api_key": []
9534 }
9535 ],
9536 "tags": [
9537 "Users"
9538 ],
9539 "x-immich-permission": "userOnboarding.update",
9540 "description": "This endpoint requires the `userOnboarding.update` permission."
9541 }
9542 },
9543 "/users/me/preferences": {
9544 "get": {
9545 "operationId": "getMyPreferences",
9546 "parameters": [],
9547 "responses": {
9548 "200": {
9549 "content": {
9550 "application/json": {
9551 "schema": {
9552 "$ref": "#/components/schemas/UserPreferencesResponseDto"
9553 }
9554 }
9555 },
9556 "description": ""
9557 }
9558 },
9559 "security": [
9560 {
9561 "bearer": []
9562 },
9563 {
9564 "cookie": []
9565 },
9566 {
9567 "api_key": []
9568 }
9569 ],
9570 "tags": [
9571 "Users"
9572 ],
9573 "x-immich-permission": "userPreference.read",
9574 "description": "This endpoint requires the `userPreference.read` permission."
9575 },
9576 "put": {
9577 "operationId": "updateMyPreferences",
9578 "parameters": [],
9579 "requestBody": {
9580 "content": {
9581 "application/json": {
9582 "schema": {
9583 "$ref": "#/components/schemas/UserPreferencesUpdateDto"
9584 }
9585 }
9586 },
9587 "required": true
9588 },
9589 "responses": {
9590 "200": {
9591 "content": {
9592 "application/json": {
9593 "schema": {
9594 "$ref": "#/components/schemas/UserPreferencesResponseDto"
9595 }
9596 }
9597 },
9598 "description": ""
9599 }
9600 },
9601 "security": [
9602 {
9603 "bearer": []
9604 },
9605 {
9606 "cookie": []
9607 },
9608 {
9609 "api_key": []
9610 }
9611 ],
9612 "tags": [
9613 "Users"
9614 ],
9615 "x-immich-permission": "userPreference.update",
9616 "description": "This endpoint requires the `userPreference.update` permission."
9617 }
9618 },
9619 "/users/profile-image": {
9620 "delete": {
9621 "operationId": "deleteProfileImage",
9622 "parameters": [],
9623 "responses": {
9624 "204": {
9625 "description": ""
9626 }
9627 },
9628 "security": [
9629 {
9630 "bearer": []
9631 },
9632 {
9633 "cookie": []
9634 },
9635 {
9636 "api_key": []
9637 }
9638 ],
9639 "tags": [
9640 "Users"
9641 ],
9642 "x-immich-permission": "userProfileImage.delete",
9643 "description": "This endpoint requires the `userProfileImage.delete` permission."
9644 },
9645 "post": {
9646 "operationId": "createProfileImage",
9647 "parameters": [],
9648 "requestBody": {
9649 "content": {
9650 "multipart/form-data": {
9651 "schema": {
9652 "$ref": "#/components/schemas/CreateProfileImageDto"
9653 }
9654 }
9655 },
9656 "description": "A new avatar for the user",
9657 "required": true
9658 },
9659 "responses": {
9660 "201": {
9661 "content": {
9662 "application/json": {
9663 "schema": {
9664 "$ref": "#/components/schemas/CreateProfileImageResponseDto"
9665 }
9666 }
9667 },
9668 "description": ""
9669 }
9670 },
9671 "security": [
9672 {
9673 "bearer": []
9674 },
9675 {
9676 "cookie": []
9677 },
9678 {
9679 "api_key": []
9680 }
9681 ],
9682 "tags": [
9683 "Users"
9684 ],
9685 "x-immich-permission": "userProfileImage.update",
9686 "description": "This endpoint requires the `userProfileImage.update` permission."
9687 }
9688 },
9689 "/users/{id}": {
9690 "get": {
9691 "operationId": "getUser",
9692 "parameters": [
9693 {
9694 "name": "id",
9695 "required": true,
9696 "in": "path",
9697 "schema": {
9698 "format": "uuid",
9699 "type": "string"
9700 }
9701 }
9702 ],
9703 "responses": {
9704 "200": {
9705 "content": {
9706 "application/json": {
9707 "schema": {
9708 "$ref": "#/components/schemas/UserResponseDto"
9709 }
9710 }
9711 },
9712 "description": ""
9713 }
9714 },
9715 "security": [
9716 {
9717 "bearer": []
9718 },
9719 {
9720 "cookie": []
9721 },
9722 {
9723 "api_key": []
9724 }
9725 ],
9726 "tags": [
9727 "Users"
9728 ],
9729 "x-immich-permission": "user.read",
9730 "description": "This endpoint requires the `user.read` permission."
9731 }
9732 },
9733 "/users/{id}/profile-image": {
9734 "get": {
9735 "operationId": "getProfileImage",
9736 "parameters": [
9737 {
9738 "name": "id",
9739 "required": true,
9740 "in": "path",
9741 "schema": {
9742 "format": "uuid",
9743 "type": "string"
9744 }
9745 }
9746 ],
9747 "responses": {
9748 "200": {
9749 "content": {
9750 "application/octet-stream": {
9751 "schema": {
9752 "format": "binary",
9753 "type": "string"
9754 }
9755 }
9756 },
9757 "description": ""
9758 }
9759 },
9760 "security": [
9761 {
9762 "bearer": []
9763 },
9764 {
9765 "cookie": []
9766 },
9767 {
9768 "api_key": []
9769 }
9770 ],
9771 "tags": [
9772 "Users"
9773 ],
9774 "x-immich-permission": "userProfileImage.read",
9775 "description": "This endpoint requires the `userProfileImage.read` permission."
9776 }
9777 },
9778 "/view/folder": {
9779 "get": {
9780 "operationId": "getAssetsByOriginalPath",
9781 "parameters": [
9782 {
9783 "name": "path",
9784 "required": true,
9785 "in": "query",
9786 "schema": {
9787 "type": "string"
9788 }
9789 }
9790 ],
9791 "responses": {
9792 "200": {
9793 "content": {
9794 "application/json": {
9795 "schema": {
9796 "items": {
9797 "$ref": "#/components/schemas/AssetResponseDto"
9798 },
9799 "type": "array"
9800 }
9801 }
9802 },
9803 "description": ""
9804 }
9805 },
9806 "security": [
9807 {
9808 "bearer": []
9809 },
9810 {
9811 "cookie": []
9812 },
9813 {
9814 "api_key": []
9815 }
9816 ],
9817 "tags": [
9818 "View"
9819 ]
9820 }
9821 },
9822 "/view/folder/unique-paths": {
9823 "get": {
9824 "operationId": "getUniqueOriginalPaths",
9825 "parameters": [],
9826 "responses": {
9827 "200": {
9828 "content": {
9829 "application/json": {
9830 "schema": {
9831 "items": {
9832 "type": "string"
9833 },
9834 "type": "array"
9835 }
9836 }
9837 },
9838 "description": ""
9839 }
9840 },
9841 "security": [
9842 {
9843 "bearer": []
9844 },
9845 {
9846 "cookie": []
9847 },
9848 {
9849 "api_key": []
9850 }
9851 ],
9852 "tags": [
9853 "View"
9854 ]
9855 }
9856 }
9857 },
9858 "info": {
9859 "title": "Immich",
9860 "description": "Immich API",
9861 "version": "1.143.1",
9862 "contact": {}
9863 },
9864 "tags": [],
9865 "servers": [
9866 {
9867 "url": "/api"
9868 }
9869 ],
9870 "components": {
9871 "securitySchemes": {
9872 "bearer": {
9873 "scheme": "Bearer",
9874 "bearerFormat": "JWT",
9875 "type": "http",
9876 "in": "header"
9877 },
9878 "cookie": {
9879 "type": "apiKey",
9880 "in": "cookie",
9881 "name": "immich_access_token"
9882 },
9883 "api_key": {
9884 "type": "apiKey",
9885 "in": "header",
9886 "name": "x-api-key"
9887 }
9888 },
9889 "schemas": {
9890 "APIKeyCreateDto": {
9891 "properties": {
9892 "name": {
9893 "type": "string"
9894 },
9895 "permissions": {
9896 "items": {
9897 "$ref": "#/components/schemas/Permission"
9898 },
9899 "minItems": 1,
9900 "type": "array"
9901 }
9902 },
9903 "required": [
9904 "permissions"
9905 ],
9906 "type": "object"
9907 },
9908 "APIKeyCreateResponseDto": {
9909 "properties": {
9910 "apiKey": {
9911 "$ref": "#/components/schemas/APIKeyResponseDto"
9912 },
9913 "secret": {
9914 "type": "string"
9915 }
9916 },
9917 "required": [
9918 "apiKey",
9919 "secret"
9920 ],
9921 "type": "object"
9922 },
9923 "APIKeyResponseDto": {
9924 "properties": {
9925 "createdAt": {
9926 "format": "date-time",
9927 "type": "string"
9928 },
9929 "id": {
9930 "type": "string"
9931 },
9932 "name": {
9933 "type": "string"
9934 },
9935 "permissions": {
9936 "items": {
9937 "$ref": "#/components/schemas/Permission"
9938 },
9939 "type": "array"
9940 },
9941 "updatedAt": {
9942 "format": "date-time",
9943 "type": "string"
9944 }
9945 },
9946 "required": [
9947 "createdAt",
9948 "id",
9949 "name",
9950 "permissions",
9951 "updatedAt"
9952 ],
9953 "type": "object"
9954 },
9955 "APIKeyUpdateDto": {
9956 "properties": {
9957 "name": {
9958 "type": "string"
9959 },
9960 "permissions": {
9961 "items": {
9962 "$ref": "#/components/schemas/Permission"
9963 },
9964 "minItems": 1,
9965 "type": "array"
9966 }
9967 },
9968 "type": "object"
9969 },
9970 "ActivityCreateDto": {
9971 "properties": {
9972 "albumId": {
9973 "format": "uuid",
9974 "type": "string"
9975 },
9976 "assetId": {
9977 "format": "uuid",
9978 "type": "string"
9979 },
9980 "comment": {
9981 "type": "string"
9982 },
9983 "type": {
9984 "allOf": [
9985 {
9986 "$ref": "#/components/schemas/ReactionType"
9987 }
9988 ]
9989 }
9990 },
9991 "required": [
9992 "albumId",
9993 "type"
9994 ],
9995 "type": "object"
9996 },
9997 "ActivityResponseDto": {
9998 "properties": {
9999 "assetId": {
10000 "nullable": true,
10001 "type": "string"
10002 },
10003 "comment": {
10004 "nullable": true,
10005 "type": "string"
10006 },
10007 "createdAt": {
10008 "format": "date-time",
10009 "type": "string"
10010 },
10011 "id": {
10012 "type": "string"
10013 },
10014 "type": {
10015 "allOf": [
10016 {
10017 "$ref": "#/components/schemas/ReactionType"
10018 }
10019 ]
10020 },
10021 "user": {
10022 "$ref": "#/components/schemas/UserResponseDto"
10023 }
10024 },
10025 "required": [
10026 "assetId",
10027 "createdAt",
10028 "id",
10029 "type",
10030 "user"
10031 ],
10032 "type": "object"
10033 },
10034 "ActivityStatisticsResponseDto": {
10035 "properties": {
10036 "comments": {
10037 "type": "integer"
10038 },
10039 "likes": {
10040 "type": "integer"
10041 }
10042 },
10043 "required": [
10044 "comments",
10045 "likes"
10046 ],
10047 "type": "object"
10048 },
10049 "AddUsersDto": {
10050 "properties": {
10051 "albumUsers": {
10052 "items": {
10053 "$ref": "#/components/schemas/AlbumUserAddDto"
10054 },
10055 "minItems": 1,
10056 "type": "array"
10057 }
10058 },
10059 "required": [
10060 "albumUsers"
10061 ],
10062 "type": "object"
10063 },
10064 "AdminOnboardingUpdateDto": {
10065 "properties": {
10066 "isOnboarded": {
10067 "type": "boolean"
10068 }
10069 },
10070 "required": [
10071 "isOnboarded"
10072 ],
10073 "type": "object"
10074 },
10075 "AlbumResponseDto": {
10076 "properties": {
10077 "albumName": {
10078 "type": "string"
10079 },
10080 "albumThumbnailAssetId": {
10081 "nullable": true,
10082 "type": "string"
10083 },
10084 "albumUsers": {
10085 "items": {
10086 "$ref": "#/components/schemas/AlbumUserResponseDto"
10087 },
10088 "type": "array"
10089 },
10090 "assetCount": {
10091 "type": "integer"
10092 },
10093 "assets": {
10094 "items": {
10095 "$ref": "#/components/schemas/AssetResponseDto"
10096 },
10097 "type": "array"
10098 },
10099 "createdAt": {
10100 "format": "date-time",
10101 "type": "string"
10102 },
10103 "description": {
10104 "type": "string"
10105 },
10106 "endDate": {
10107 "format": "date-time",
10108 "type": "string"
10109 },
10110 "hasSharedLink": {
10111 "type": "boolean"
10112 },
10113 "id": {
10114 "type": "string"
10115 },
10116 "isActivityEnabled": {
10117 "type": "boolean"
10118 },
10119 "lastModifiedAssetTimestamp": {
10120 "format": "date-time",
10121 "type": "string"
10122 },
10123 "order": {
10124 "allOf": [
10125 {
10126 "$ref": "#/components/schemas/AssetOrder"
10127 }
10128 ]
10129 },
10130 "owner": {
10131 "$ref": "#/components/schemas/UserResponseDto"
10132 },
10133 "ownerId": {
10134 "type": "string"
10135 },
10136 "shared": {
10137 "type": "boolean"
10138 },
10139 "startDate": {
10140 "format": "date-time",
10141 "type": "string"
10142 },
10143 "updatedAt": {
10144 "format": "date-time",
10145 "type": "string"
10146 }
10147 },
10148 "required": [
10149 "albumName",
10150 "albumThumbnailAssetId",
10151 "albumUsers",
10152 "assetCount",
10153 "assets",
10154 "createdAt",
10155 "description",
10156 "hasSharedLink",
10157 "id",
10158 "isActivityEnabled",
10159 "owner",
10160 "ownerId",
10161 "shared",
10162 "updatedAt"
10163 ],
10164 "type": "object"
10165 },
10166 "AlbumStatisticsResponseDto": {
10167 "properties": {
10168 "notShared": {
10169 "type": "integer"
10170 },
10171 "owned": {
10172 "type": "integer"
10173 },
10174 "shared": {
10175 "type": "integer"
10176 }
10177 },
10178 "required": [
10179 "notShared",
10180 "owned",
10181 "shared"
10182 ],
10183 "type": "object"
10184 },
10185 "AlbumUserAddDto": {
10186 "properties": {
10187 "role": {
10188 "allOf": [
10189 {
10190 "$ref": "#/components/schemas/AlbumUserRole"
10191 }
10192 ],
10193 "default": "editor"
10194 },
10195 "userId": {
10196 "format": "uuid",
10197 "type": "string"
10198 }
10199 },
10200 "required": [
10201 "userId"
10202 ],
10203 "type": "object"
10204 },
10205 "AlbumUserCreateDto": {
10206 "properties": {
10207 "role": {
10208 "allOf": [
10209 {
10210 "$ref": "#/components/schemas/AlbumUserRole"
10211 }
10212 ]
10213 },
10214 "userId": {
10215 "format": "uuid",
10216 "type": "string"
10217 }
10218 },
10219 "required": [
10220 "role",
10221 "userId"
10222 ],
10223 "type": "object"
10224 },
10225 "AlbumUserResponseDto": {
10226 "properties": {
10227 "role": {
10228 "allOf": [
10229 {
10230 "$ref": "#/components/schemas/AlbumUserRole"
10231 }
10232 ]
10233 },
10234 "user": {
10235 "$ref": "#/components/schemas/UserResponseDto"
10236 }
10237 },
10238 "required": [
10239 "role",
10240 "user"
10241 ],
10242 "type": "object"
10243 },
10244 "AlbumUserRole": {
10245 "enum": [
10246 "editor",
10247 "viewer"
10248 ],
10249 "type": "string"
10250 },
10251 "AlbumsAddAssetsDto": {
10252 "properties": {
10253 "albumIds": {
10254 "items": {
10255 "format": "uuid",
10256 "type": "string"
10257 },
10258 "type": "array"
10259 },
10260 "assetIds": {
10261 "items": {
10262 "format": "uuid",
10263 "type": "string"
10264 },
10265 "type": "array"
10266 }
10267 },
10268 "required": [
10269 "albumIds",
10270 "assetIds"
10271 ],
10272 "type": "object"
10273 },
10274 "AlbumsAddAssetsResponseDto": {
10275 "properties": {
10276 "error": {
10277 "allOf": [
10278 {
10279 "$ref": "#/components/schemas/BulkIdErrorReason"
10280 }
10281 ]
10282 },
10283 "success": {
10284 "type": "boolean"
10285 }
10286 },
10287 "required": [
10288 "success"
10289 ],
10290 "type": "object"
10291 },
10292 "AlbumsResponse": {
10293 "properties": {
10294 "defaultAssetOrder": {
10295 "allOf": [
10296 {
10297 "$ref": "#/components/schemas/AssetOrder"
10298 }
10299 ],
10300 "default": "desc"
10301 }
10302 },
10303 "required": [
10304 "defaultAssetOrder"
10305 ],
10306 "type": "object"
10307 },
10308 "AlbumsUpdate": {
10309 "properties": {
10310 "defaultAssetOrder": {
10311 "allOf": [
10312 {
10313 "$ref": "#/components/schemas/AssetOrder"
10314 }
10315 ]
10316 }
10317 },
10318 "type": "object"
10319 },
10320 "AllJobStatusResponseDto": {
10321 "properties": {
10322 "backgroundTask": {
10323 "$ref": "#/components/schemas/JobStatusDto"
10324 },
10325 "backupDatabase": {
10326 "$ref": "#/components/schemas/JobStatusDto"
10327 },
10328 "duplicateDetection": {
10329 "$ref": "#/components/schemas/JobStatusDto"
10330 },
10331 "faceDetection": {
10332 "$ref": "#/components/schemas/JobStatusDto"
10333 },
10334 "facialRecognition": {
10335 "$ref": "#/components/schemas/JobStatusDto"
10336 },
10337 "library": {
10338 "$ref": "#/components/schemas/JobStatusDto"
10339 },
10340 "metadataExtraction": {
10341 "$ref": "#/components/schemas/JobStatusDto"
10342 },
10343 "migration": {
10344 "$ref": "#/components/schemas/JobStatusDto"
10345 },
10346 "notifications": {
10347 "$ref": "#/components/schemas/JobStatusDto"
10348 },
10349 "search": {
10350 "$ref": "#/components/schemas/JobStatusDto"
10351 },
10352 "sidecar": {
10353 "$ref": "#/components/schemas/JobStatusDto"
10354 },
10355 "smartSearch": {
10356 "$ref": "#/components/schemas/JobStatusDto"
10357 },
10358 "storageTemplateMigration": {
10359 "$ref": "#/components/schemas/JobStatusDto"
10360 },
10361 "thumbnailGeneration": {
10362 "$ref": "#/components/schemas/JobStatusDto"
10363 },
10364 "videoConversion": {
10365 "$ref": "#/components/schemas/JobStatusDto"
10366 }
10367 },
10368 "required": [
10369 "backgroundTask",
10370 "backupDatabase",
10371 "duplicateDetection",
10372 "faceDetection",
10373 "facialRecognition",
10374 "library",
10375 "metadataExtraction",
10376 "migration",
10377 "notifications",
10378 "search",
10379 "sidecar",
10380 "smartSearch",
10381 "storageTemplateMigration",
10382 "thumbnailGeneration",
10383 "videoConversion"
10384 ],
10385 "type": "object"
10386 },
10387 "AssetBulkDeleteDto": {
10388 "properties": {
10389 "force": {
10390 "type": "boolean"
10391 },
10392 "ids": {
10393 "items": {
10394 "format": "uuid",
10395 "type": "string"
10396 },
10397 "type": "array"
10398 }
10399 },
10400 "required": [
10401 "ids"
10402 ],
10403 "type": "object"
10404 },
10405 "AssetBulkUpdateDto": {
10406 "properties": {
10407 "dateTimeOriginal": {
10408 "type": "string"
10409 },
10410 "dateTimeRelative": {
10411 "type": "number"
10412 },
10413 "description": {
10414 "type": "string"
10415 },
10416 "duplicateId": {
10417 "nullable": true,
10418 "type": "string"
10419 },
10420 "ids": {
10421 "items": {
10422 "format": "uuid",
10423 "type": "string"
10424 },
10425 "type": "array"
10426 },
10427 "isFavorite": {
10428 "type": "boolean"
10429 },
10430 "latitude": {
10431 "type": "number"
10432 },
10433 "longitude": {
10434 "type": "number"
10435 },
10436 "rating": {
10437 "maximum": 5,
10438 "minimum": -1,
10439 "type": "number"
10440 },
10441 "timeZone": {
10442 "type": "string"
10443 },
10444 "visibility": {
10445 "allOf": [
10446 {
10447 "$ref": "#/components/schemas/AssetVisibility"
10448 }
10449 ]
10450 }
10451 },
10452 "required": [
10453 "ids"
10454 ],
10455 "type": "object"
10456 },
10457 "AssetBulkUploadCheckDto": {
10458 "properties": {
10459 "assets": {
10460 "items": {
10461 "$ref": "#/components/schemas/AssetBulkUploadCheckItem"
10462 },
10463 "type": "array"
10464 }
10465 },
10466 "required": [
10467 "assets"
10468 ],
10469 "type": "object"
10470 },
10471 "AssetBulkUploadCheckItem": {
10472 "properties": {
10473 "checksum": {
10474 "description": "base64 or hex encoded sha1 hash",
10475 "type": "string"
10476 },
10477 "id": {
10478 "type": "string"
10479 }
10480 },
10481 "required": [
10482 "checksum",
10483 "id"
10484 ],
10485 "type": "object"
10486 },
10487 "AssetBulkUploadCheckResponseDto": {
10488 "properties": {
10489 "results": {
10490 "items": {
10491 "$ref": "#/components/schemas/AssetBulkUploadCheckResult"
10492 },
10493 "type": "array"
10494 }
10495 },
10496 "required": [
10497 "results"
10498 ],
10499 "type": "object"
10500 },
10501 "AssetBulkUploadCheckResult": {
10502 "properties": {
10503 "action": {
10504 "enum": [
10505 "accept",
10506 "reject"
10507 ],
10508 "type": "string"
10509 },
10510 "assetId": {
10511 "type": "string"
10512 },
10513 "id": {
10514 "type": "string"
10515 },
10516 "isTrashed": {
10517 "type": "boolean"
10518 },
10519 "reason": {
10520 "enum": [
10521 "duplicate",
10522 "unsupported-format"
10523 ],
10524 "type": "string"
10525 }
10526 },
10527 "required": [
10528 "action",
10529 "id"
10530 ],
10531 "type": "object"
10532 },
10533 "AssetDeltaSyncDto": {
10534 "properties": {
10535 "updatedAfter": {
10536 "format": "date-time",
10537 "type": "string"
10538 },
10539 "userIds": {
10540 "items": {
10541 "format": "uuid",
10542 "type": "string"
10543 },
10544 "type": "array"
10545 }
10546 },
10547 "required": [
10548 "updatedAfter",
10549 "userIds"
10550 ],
10551 "type": "object"
10552 },
10553 "AssetDeltaSyncResponseDto": {
10554 "properties": {
10555 "deleted": {
10556 "items": {
10557 "type": "string"
10558 },
10559 "type": "array"
10560 },
10561 "needsFullSync": {
10562 "type": "boolean"
10563 },
10564 "upserted": {
10565 "items": {
10566 "$ref": "#/components/schemas/AssetResponseDto"
10567 },
10568 "type": "array"
10569 }
10570 },
10571 "required": [
10572 "deleted",
10573 "needsFullSync",
10574 "upserted"
10575 ],
10576 "type": "object"
10577 },
10578 "AssetFaceCreateDto": {
10579 "properties": {
10580 "assetId": {
10581 "format": "uuid",
10582 "type": "string"
10583 },
10584 "height": {
10585 "type": "integer"
10586 },
10587 "imageHeight": {
10588 "type": "integer"
10589 },
10590 "imageWidth": {
10591 "type": "integer"
10592 },
10593 "personId": {
10594 "format": "uuid",
10595 "type": "string"
10596 },
10597 "width": {
10598 "type": "integer"
10599 },
10600 "x": {
10601 "type": "integer"
10602 },
10603 "y": {
10604 "type": "integer"
10605 }
10606 },
10607 "required": [
10608 "assetId",
10609 "height",
10610 "imageHeight",
10611 "imageWidth",
10612 "personId",
10613 "width",
10614 "x",
10615 "y"
10616 ],
10617 "type": "object"
10618 },
10619 "AssetFaceDeleteDto": {
10620 "properties": {
10621 "force": {
10622 "type": "boolean"
10623 }
10624 },
10625 "required": [
10626 "force"
10627 ],
10628 "type": "object"
10629 },
10630 "AssetFaceResponseDto": {
10631 "properties": {
10632 "boundingBoxX1": {
10633 "type": "integer"
10634 },
10635 "boundingBoxX2": {
10636 "type": "integer"
10637 },
10638 "boundingBoxY1": {
10639 "type": "integer"
10640 },
10641 "boundingBoxY2": {
10642 "type": "integer"
10643 },
10644 "id": {
10645 "format": "uuid",
10646 "type": "string"
10647 },
10648 "imageHeight": {
10649 "type": "integer"
10650 },
10651 "imageWidth": {
10652 "type": "integer"
10653 },
10654 "person": {
10655 "allOf": [
10656 {
10657 "$ref": "#/components/schemas/PersonResponseDto"
10658 }
10659 ],
10660 "nullable": true
10661 },
10662 "sourceType": {
10663 "allOf": [
10664 {
10665 "$ref": "#/components/schemas/SourceType"
10666 }
10667 ]
10668 }
10669 },
10670 "required": [
10671 "boundingBoxX1",
10672 "boundingBoxX2",
10673 "boundingBoxY1",
10674 "boundingBoxY2",
10675 "id",
10676 "imageHeight",
10677 "imageWidth",
10678 "person"
10679 ],
10680 "type": "object"
10681 },
10682 "AssetFaceUpdateDto": {
10683 "properties": {
10684 "data": {
10685 "items": {
10686 "$ref": "#/components/schemas/AssetFaceUpdateItem"
10687 },
10688 "type": "array"
10689 }
10690 },
10691 "required": [
10692 "data"
10693 ],
10694 "type": "object"
10695 },
10696 "AssetFaceUpdateItem": {
10697 "properties": {
10698 "assetId": {
10699 "format": "uuid",
10700 "type": "string"
10701 },
10702 "personId": {
10703 "format": "uuid",
10704 "type": "string"
10705 }
10706 },
10707 "required": [
10708 "assetId",
10709 "personId"
10710 ],
10711 "type": "object"
10712 },
10713 "AssetFaceWithoutPersonResponseDto": {
10714 "properties": {
10715 "boundingBoxX1": {
10716 "type": "integer"
10717 },
10718 "boundingBoxX2": {
10719 "type": "integer"
10720 },
10721 "boundingBoxY1": {
10722 "type": "integer"
10723 },
10724 "boundingBoxY2": {
10725 "type": "integer"
10726 },
10727 "id": {
10728 "format": "uuid",
10729 "type": "string"
10730 },
10731 "imageHeight": {
10732 "type": "integer"
10733 },
10734 "imageWidth": {
10735 "type": "integer"
10736 },
10737 "sourceType": {
10738 "allOf": [
10739 {
10740 "$ref": "#/components/schemas/SourceType"
10741 }
10742 ]
10743 }
10744 },
10745 "required": [
10746 "boundingBoxX1",
10747 "boundingBoxX2",
10748 "boundingBoxY1",
10749 "boundingBoxY2",
10750 "id",
10751 "imageHeight",
10752 "imageWidth"
10753 ],
10754 "type": "object"
10755 },
10756 "AssetFullSyncDto": {
10757 "properties": {
10758 "lastId": {
10759 "format": "uuid",
10760 "type": "string"
10761 },
10762 "limit": {
10763 "minimum": 1,
10764 "type": "integer"
10765 },
10766 "updatedUntil": {
10767 "format": "date-time",
10768 "type": "string"
10769 },
10770 "userId": {
10771 "format": "uuid",
10772 "type": "string"
10773 }
10774 },
10775 "required": [
10776 "limit",
10777 "updatedUntil"
10778 ],
10779 "type": "object"
10780 },
10781 "AssetIdsDto": {
10782 "properties": {
10783 "assetIds": {
10784 "items": {
10785 "format": "uuid",
10786 "type": "string"
10787 },
10788 "type": "array"
10789 }
10790 },
10791 "required": [
10792 "assetIds"
10793 ],
10794 "type": "object"
10795 },
10796 "AssetIdsResponseDto": {
10797 "properties": {
10798 "assetId": {
10799 "type": "string"
10800 },
10801 "error": {
10802 "enum": [
10803 "duplicate",
10804 "no_permission",
10805 "not_found"
10806 ],
10807 "type": "string"
10808 },
10809 "success": {
10810 "type": "boolean"
10811 }
10812 },
10813 "required": [
10814 "assetId",
10815 "success"
10816 ],
10817 "type": "object"
10818 },
10819 "AssetJobName": {
10820 "enum": [
10821 "refresh-faces",
10822 "refresh-metadata",
10823 "regenerate-thumbnail",
10824 "transcode-video"
10825 ],
10826 "type": "string"
10827 },
10828 "AssetJobsDto": {
10829 "properties": {
10830 "assetIds": {
10831 "items": {
10832 "format": "uuid",
10833 "type": "string"
10834 },
10835 "type": "array"
10836 },
10837 "name": {
10838 "allOf": [
10839 {
10840 "$ref": "#/components/schemas/AssetJobName"
10841 }
10842 ]
10843 }
10844 },
10845 "required": [
10846 "assetIds",
10847 "name"
10848 ],
10849 "type": "object"
10850 },
10851 "AssetMediaCreateDto": {
10852 "properties": {
10853 "assetData": {
10854 "format": "binary",
10855 "type": "string"
10856 },
10857 "deviceAssetId": {
10858 "type": "string"
10859 },
10860 "deviceId": {
10861 "type": "string"
10862 },
10863 "duration": {
10864 "type": "string"
10865 },
10866 "fileCreatedAt": {
10867 "format": "date-time",
10868 "type": "string"
10869 },
10870 "fileModifiedAt": {
10871 "format": "date-time",
10872 "type": "string"
10873 },
10874 "filename": {
10875 "type": "string"
10876 },
10877 "isFavorite": {
10878 "type": "boolean"
10879 },
10880 "livePhotoVideoId": {
10881 "format": "uuid",
10882 "type": "string"
10883 },
10884 "metadata": {
10885 "items": {
10886 "$ref": "#/components/schemas/AssetMetadataUpsertItemDto"
10887 },
10888 "type": "array"
10889 },
10890 "sidecarData": {
10891 "format": "binary",
10892 "type": "string"
10893 },
10894 "visibility": {
10895 "allOf": [
10896 {
10897 "$ref": "#/components/schemas/AssetVisibility"
10898 }
10899 ]
10900 }
10901 },
10902 "required": [
10903 "assetData",
10904 "deviceAssetId",
10905 "deviceId",
10906 "fileCreatedAt",
10907 "fileModifiedAt",
10908 "metadata"
10909 ],
10910 "type": "object"
10911 },
10912 "AssetMediaReplaceDto": {
10913 "properties": {
10914 "assetData": {
10915 "format": "binary",
10916 "type": "string"
10917 },
10918 "deviceAssetId": {
10919 "type": "string"
10920 },
10921 "deviceId": {
10922 "type": "string"
10923 },
10924 "duration": {
10925 "type": "string"
10926 },
10927 "fileCreatedAt": {
10928 "format": "date-time",
10929 "type": "string"
10930 },
10931 "fileModifiedAt": {
10932 "format": "date-time",
10933 "type": "string"
10934 },
10935 "filename": {
10936 "type": "string"
10937 }
10938 },
10939 "required": [
10940 "assetData",
10941 "deviceAssetId",
10942 "deviceId",
10943 "fileCreatedAt",
10944 "fileModifiedAt"
10945 ],
10946 "type": "object"
10947 },
10948 "AssetMediaResponseDto": {
10949 "properties": {
10950 "id": {
10951 "type": "string"
10952 },
10953 "status": {
10954 "allOf": [
10955 {
10956 "$ref": "#/components/schemas/AssetMediaStatus"
10957 }
10958 ]
10959 }
10960 },
10961 "required": [
10962 "id",
10963 "status"
10964 ],
10965 "type": "object"
10966 },
10967 "AssetMediaSize": {
10968 "enum": [
10969 "fullsize",
10970 "preview",
10971 "thumbnail"
10972 ],
10973 "type": "string"
10974 },
10975 "AssetMediaStatus": {
10976 "enum": [
10977 "created",
10978 "replaced",
10979 "duplicate"
10980 ],
10981 "type": "string"
10982 },
10983 "AssetMetadataKey": {
10984 "enum": [
10985 "mobile-app"
10986 ],
10987 "type": "string"
10988 },
10989 "AssetMetadataResponseDto": {
10990 "properties": {
10991 "key": {
10992 "allOf": [
10993 {
10994 "$ref": "#/components/schemas/AssetMetadataKey"
10995 }
10996 ]
10997 },
10998 "updatedAt": {
10999 "format": "date-time",
11000 "type": "string"
11001 },
11002 "value": {
11003 "type": "object"
11004 }
11005 },
11006 "required": [
11007 "key",
11008 "updatedAt",
11009 "value"
11010 ],
11011 "type": "object"
11012 },
11013 "AssetMetadataUpsertDto": {
11014 "properties": {
11015 "items": {
11016 "items": {
11017 "$ref": "#/components/schemas/AssetMetadataUpsertItemDto"
11018 },
11019 "type": "array"
11020 }
11021 },
11022 "required": [
11023 "items"
11024 ],
11025 "type": "object"
11026 },
11027 "AssetMetadataUpsertItemDto": {
11028 "properties": {
11029 "key": {
11030 "allOf": [
11031 {
11032 "$ref": "#/components/schemas/AssetMetadataKey"
11033 }
11034 ]
11035 },
11036 "value": {
11037 "type": "object"
11038 }
11039 },
11040 "required": [
11041 "key",
11042 "value"
11043 ],
11044 "type": "object"
11045 },
11046 "AssetOrder": {
11047 "enum": [
11048 "asc",
11049 "desc"
11050 ],
11051 "type": "string"
11052 },
11053 "AssetResponseDto": {
11054 "properties": {
11055 "checksum": {
11056 "description": "base64 encoded sha1 hash",
11057 "type": "string"
11058 },
11059 "createdAt": {
11060 "description": "The UTC timestamp when the asset was originally uploaded to Immich.",
11061 "example": "2024-01-15T20:30:00.000Z",
11062 "format": "date-time",
11063 "type": "string"
11064 },
11065 "deviceAssetId": {
11066 "type": "string"
11067 },
11068 "deviceId": {
11069 "type": "string"
11070 },
11071 "duplicateId": {
11072 "nullable": true,
11073 "type": "string"
11074 },
11075 "duration": {
11076 "type": "string"
11077 },
11078 "exifInfo": {
11079 "$ref": "#/components/schemas/ExifResponseDto"
11080 },
11081 "fileCreatedAt": {
11082 "description": "The actual UTC timestamp when the file was created/captured, preserving timezone information. This is the authoritative timestamp for chronological sorting within timeline groups. Combined with timezone data, this can be used to determine the exact moment the photo was taken.",
11083 "example": "2024-01-15T19:30:00.000Z",
11084 "format": "date-time",
11085 "type": "string"
11086 },
11087 "fileModifiedAt": {
11088 "description": "The UTC timestamp when the file was last modified on the filesystem. This reflects the last time the physical file was changed, which may be different from when the photo was originally taken.",
11089 "example": "2024-01-16T10:15:00.000Z",
11090 "format": "date-time",
11091 "type": "string"
11092 },
11093 "hasMetadata": {
11094 "type": "boolean"
11095 },
11096 "id": {
11097 "type": "string"
11098 },
11099 "isArchived": {
11100 "type": "boolean"
11101 },
11102 "isFavorite": {
11103 "type": "boolean"
11104 },
11105 "isOffline": {
11106 "type": "boolean"
11107 },
11108 "isTrashed": {
11109 "type": "boolean"
11110 },
11111 "libraryId": {
11112 "deprecated": true,
11113 "description": "This property was deprecated in v1.106.0",
11114 "nullable": true,
11115 "type": "string"
11116 },
11117 "livePhotoVideoId": {
11118 "nullable": true,
11119 "type": "string"
11120 },
11121 "localDateTime": {
11122 "description": "The local date and time when the photo/video was taken, derived from EXIF metadata. This represents the photographer's local time regardless of timezone, stored as a timezone-agnostic timestamp. Used for timeline grouping by \"local\" days and months.",
11123 "example": "2024-01-15T14:30:00.000Z",
11124 "format": "date-time",
11125 "type": "string"
11126 },
11127 "originalFileName": {
11128 "type": "string"
11129 },
11130 "originalMimeType": {
11131 "type": "string"
11132 },
11133 "originalPath": {
11134 "type": "string"
11135 },
11136 "owner": {
11137 "$ref": "#/components/schemas/UserResponseDto"
11138 },
11139 "ownerId": {
11140 "type": "string"
11141 },
11142 "people": {
11143 "items": {
11144 "$ref": "#/components/schemas/PersonWithFacesResponseDto"
11145 },
11146 "type": "array"
11147 },
11148 "resized": {
11149 "deprecated": true,
11150 "description": "This property was deprecated in v1.113.0",
11151 "type": "boolean"
11152 },
11153 "stack": {
11154 "allOf": [
11155 {
11156 "$ref": "#/components/schemas/AssetStackResponseDto"
11157 }
11158 ],
11159 "nullable": true
11160 },
11161 "tags": {
11162 "items": {
11163 "$ref": "#/components/schemas/TagResponseDto"
11164 },
11165 "type": "array"
11166 },
11167 "thumbhash": {
11168 "nullable": true,
11169 "type": "string"
11170 },
11171 "type": {
11172 "allOf": [
11173 {
11174 "$ref": "#/components/schemas/AssetTypeEnum"
11175 }
11176 ]
11177 },
11178 "unassignedFaces": {
11179 "items": {
11180 "$ref": "#/components/schemas/AssetFaceWithoutPersonResponseDto"
11181 },
11182 "type": "array"
11183 },
11184 "updatedAt": {
11185 "description": "The UTC timestamp when the asset record was last updated in the database. This is automatically maintained by the database and reflects when any field in the asset was last modified.",
11186 "example": "2024-01-16T12:45:30.000Z",
11187 "format": "date-time",
11188 "type": "string"
11189 },
11190 "visibility": {
11191 "allOf": [
11192 {
11193 "$ref": "#/components/schemas/AssetVisibility"
11194 }
11195 ]
11196 }
11197 },
11198 "required": [
11199 "checksum",
11200 "createdAt",
11201 "deviceAssetId",
11202 "deviceId",
11203 "duration",
11204 "fileCreatedAt",
11205 "fileModifiedAt",
11206 "hasMetadata",
11207 "id",
11208 "isArchived",
11209 "isFavorite",
11210 "isOffline",
11211 "isTrashed",
11212 "localDateTime",
11213 "originalFileName",
11214 "originalPath",
11215 "ownerId",
11216 "thumbhash",
11217 "type",
11218 "updatedAt",
11219 "visibility"
11220 ],
11221 "type": "object"
11222 },
11223 "AssetStackResponseDto": {
11224 "properties": {
11225 "assetCount": {
11226 "type": "integer"
11227 },
11228 "id": {
11229 "type": "string"
11230 },
11231 "primaryAssetId": {
11232 "type": "string"
11233 }
11234 },
11235 "required": [
11236 "assetCount",
11237 "id",
11238 "primaryAssetId"
11239 ],
11240 "type": "object"
11241 },
11242 "AssetStatsResponseDto": {
11243 "properties": {
11244 "images": {
11245 "type": "integer"
11246 },
11247 "total": {
11248 "type": "integer"
11249 },
11250 "videos": {
11251 "type": "integer"
11252 }
11253 },
11254 "required": [
11255 "images",
11256 "total",
11257 "videos"
11258 ],
11259 "type": "object"
11260 },
11261 "AssetTypeEnum": {
11262 "enum": [
11263 "IMAGE",
11264 "VIDEO",
11265 "AUDIO",
11266 "OTHER"
11267 ],
11268 "type": "string"
11269 },
11270 "AssetVisibility": {
11271 "enum": [
11272 "archive",
11273 "timeline",
11274 "hidden",
11275 "locked"
11276 ],
11277 "type": "string"
11278 },
11279 "AudioCodec": {
11280 "enum": [
11281 "mp3",
11282 "aac",
11283 "libopus",
11284 "pcm_s16le"
11285 ],
11286 "type": "string"
11287 },
11288 "AuthStatusResponseDto": {
11289 "properties": {
11290 "expiresAt": {
11291 "type": "string"
11292 },
11293 "isElevated": {
11294 "type": "boolean"
11295 },
11296 "password": {
11297 "type": "boolean"
11298 },
11299 "pinCode": {
11300 "type": "boolean"
11301 },
11302 "pinExpiresAt": {
11303 "type": "string"
11304 }
11305 },
11306 "required": [
11307 "isElevated",
11308 "password",
11309 "pinCode"
11310 ],
11311 "type": "object"
11312 },
11313 "AvatarUpdate": {
11314 "properties": {
11315 "color": {
11316 "allOf": [
11317 {
11318 "$ref": "#/components/schemas/UserAvatarColor"
11319 }
11320 ]
11321 }
11322 },
11323 "type": "object"
11324 },
11325 "BulkIdErrorReason": {
11326 "enum": [
11327 "duplicate",
11328 "no_permission",
11329 "not_found",
11330 "unknown"
11331 ],
11332 "type": "string"
11333 },
11334 "BulkIdResponseDto": {
11335 "properties": {
11336 "error": {
11337 "enum": [
11338 "duplicate",
11339 "no_permission",
11340 "not_found",
11341 "unknown"
11342 ],
11343 "type": "string"
11344 },
11345 "id": {
11346 "type": "string"
11347 },
11348 "success": {
11349 "type": "boolean"
11350 }
11351 },
11352 "required": [
11353 "id",
11354 "success"
11355 ],
11356 "type": "object"
11357 },
11358 "BulkIdsDto": {
11359 "properties": {
11360 "ids": {
11361 "items": {
11362 "format": "uuid",
11363 "type": "string"
11364 },
11365 "type": "array"
11366 }
11367 },
11368 "required": [
11369 "ids"
11370 ],
11371 "type": "object"
11372 },
11373 "CLIPConfig": {
11374 "properties": {
11375 "enabled": {
11376 "type": "boolean"
11377 },
11378 "modelName": {
11379 "type": "string"
11380 }
11381 },
11382 "required": [
11383 "enabled",
11384 "modelName"
11385 ],
11386 "type": "object"
11387 },
11388 "CQMode": {
11389 "enum": [
11390 "auto",
11391 "cqp",
11392 "icq"
11393 ],
11394 "type": "string"
11395 },
11396 "CastResponse": {
11397 "properties": {
11398 "gCastEnabled": {
11399 "default": false,
11400 "type": "boolean"
11401 }
11402 },
11403 "required": [
11404 "gCastEnabled"
11405 ],
11406 "type": "object"
11407 },
11408 "CastUpdate": {
11409 "properties": {
11410 "gCastEnabled": {
11411 "type": "boolean"
11412 }
11413 },
11414 "type": "object"
11415 },
11416 "ChangePasswordDto": {
11417 "properties": {
11418 "newPassword": {
11419 "example": "password",
11420 "minLength": 8,
11421 "type": "string"
11422 },
11423 "password": {
11424 "example": "password",
11425 "type": "string"
11426 }
11427 },
11428 "required": [
11429 "newPassword",
11430 "password"
11431 ],
11432 "type": "object"
11433 },
11434 "CheckExistingAssetsDto": {
11435 "properties": {
11436 "deviceAssetIds": {
11437 "items": {
11438 "type": "string"
11439 },
11440 "minItems": 1,
11441 "type": "array"
11442 },
11443 "deviceId": {
11444 "type": "string"
11445 }
11446 },
11447 "required": [
11448 "deviceAssetIds",
11449 "deviceId"
11450 ],
11451 "type": "object"
11452 },
11453 "CheckExistingAssetsResponseDto": {
11454 "properties": {
11455 "existingIds": {
11456 "items": {
11457 "type": "string"
11458 },
11459 "type": "array"
11460 }
11461 },
11462 "required": [
11463 "existingIds"
11464 ],
11465 "type": "object"
11466 },
11467 "Colorspace": {
11468 "enum": [
11469 "srgb",
11470 "p3"
11471 ],
11472 "type": "string"
11473 },
11474 "CreateAlbumDto": {
11475 "properties": {
11476 "albumName": {
11477 "type": "string"
11478 },
11479 "albumUsers": {
11480 "items": {
11481 "$ref": "#/components/schemas/AlbumUserCreateDto"
11482 },
11483 "type": "array"
11484 },
11485 "assetIds": {
11486 "items": {
11487 "format": "uuid",
11488 "type": "string"
11489 },
11490 "type": "array"
11491 },
11492 "description": {
11493 "type": "string"
11494 }
11495 },
11496 "required": [
11497 "albumName"
11498 ],
11499 "type": "object"
11500 },
11501 "CreateLibraryDto": {
11502 "properties": {
11503 "exclusionPatterns": {
11504 "items": {
11505 "type": "string"
11506 },
11507 "maxItems": 128,
11508 "type": "array",
11509 "uniqueItems": true
11510 },
11511 "importPaths": {
11512 "items": {
11513 "type": "string"
11514 },
11515 "maxItems": 128,
11516 "type": "array",
11517 "uniqueItems": true
11518 },
11519 "name": {
11520 "type": "string"
11521 },
11522 "ownerId": {
11523 "format": "uuid",
11524 "type": "string"
11525 }
11526 },
11527 "required": [
11528 "ownerId"
11529 ],
11530 "type": "object"
11531 },
11532 "CreateProfileImageDto": {
11533 "properties": {
11534 "file": {
11535 "format": "binary",
11536 "type": "string"
11537 }
11538 },
11539 "required": [
11540 "file"
11541 ],
11542 "type": "object"
11543 },
11544 "CreateProfileImageResponseDto": {
11545 "properties": {
11546 "profileChangedAt": {
11547 "format": "date-time",
11548 "type": "string"
11549 },
11550 "profileImagePath": {
11551 "type": "string"
11552 },
11553 "userId": {
11554 "type": "string"
11555 }
11556 },
11557 "required": [
11558 "profileChangedAt",
11559 "profileImagePath",
11560 "userId"
11561 ],
11562 "type": "object"
11563 },
11564 "DatabaseBackupConfig": {
11565 "properties": {
11566 "cronExpression": {
11567 "type": "string"
11568 },
11569 "enabled": {
11570 "type": "boolean"
11571 },
11572 "keepLastAmount": {
11573 "minimum": 1,
11574 "type": "number"
11575 }
11576 },
11577 "required": [
11578 "cronExpression",
11579 "enabled",
11580 "keepLastAmount"
11581 ],
11582 "type": "object"
11583 },
11584 "DownloadArchiveInfo": {
11585 "properties": {
11586 "assetIds": {
11587 "items": {
11588 "type": "string"
11589 },
11590 "type": "array"
11591 },
11592 "size": {
11593 "type": "integer"
11594 }
11595 },
11596 "required": [
11597 "assetIds",
11598 "size"
11599 ],
11600 "type": "object"
11601 },
11602 "DownloadInfoDto": {
11603 "properties": {
11604 "albumId": {
11605 "format": "uuid",
11606 "type": "string"
11607 },
11608 "archiveSize": {
11609 "minimum": 1,
11610 "type": "integer"
11611 },
11612 "assetIds": {
11613 "items": {
11614 "format": "uuid",
11615 "type": "string"
11616 },
11617 "type": "array"
11618 },
11619 "userId": {
11620 "format": "uuid",
11621 "type": "string"
11622 }
11623 },
11624 "type": "object"
11625 },
11626 "DownloadResponse": {
11627 "properties": {
11628 "archiveSize": {
11629 "type": "integer"
11630 },
11631 "includeEmbeddedVideos": {
11632 "default": false,
11633 "type": "boolean"
11634 }
11635 },
11636 "required": [
11637 "archiveSize",
11638 "includeEmbeddedVideos"
11639 ],
11640 "type": "object"
11641 },
11642 "DownloadResponseDto": {
11643 "properties": {
11644 "archives": {
11645 "items": {
11646 "$ref": "#/components/schemas/DownloadArchiveInfo"
11647 },
11648 "type": "array"
11649 },
11650 "totalSize": {
11651 "type": "integer"
11652 }
11653 },
11654 "required": [
11655 "archives",
11656 "totalSize"
11657 ],
11658 "type": "object"
11659 },
11660 "DownloadUpdate": {
11661 "properties": {
11662 "archiveSize": {
11663 "minimum": 1,
11664 "type": "integer"
11665 },
11666 "includeEmbeddedVideos": {
11667 "type": "boolean"
11668 }
11669 },
11670 "type": "object"
11671 },
11672 "DuplicateDetectionConfig": {
11673 "properties": {
11674 "enabled": {
11675 "type": "boolean"
11676 },
11677 "maxDistance": {
11678 "format": "double",
11679 "maximum": 0.1,
11680 "minimum": 0.001,
11681 "type": "number"
11682 }
11683 },
11684 "required": [
11685 "enabled",
11686 "maxDistance"
11687 ],
11688 "type": "object"
11689 },
11690 "DuplicateResponseDto": {
11691 "properties": {
11692 "assets": {
11693 "items": {
11694 "$ref": "#/components/schemas/AssetResponseDto"
11695 },
11696 "type": "array"
11697 },
11698 "duplicateId": {
11699 "type": "string"
11700 }
11701 },
11702 "required": [
11703 "assets",
11704 "duplicateId"
11705 ],
11706 "type": "object"
11707 },
11708 "EmailNotificationsResponse": {
11709 "properties": {
11710 "albumInvite": {
11711 "type": "boolean"
11712 },
11713 "albumUpdate": {
11714 "type": "boolean"
11715 },
11716 "enabled": {
11717 "type": "boolean"
11718 }
11719 },
11720 "required": [
11721 "albumInvite",
11722 "albumUpdate",
11723 "enabled"
11724 ],
11725 "type": "object"
11726 },
11727 "EmailNotificationsUpdate": {
11728 "properties": {
11729 "albumInvite": {
11730 "type": "boolean"
11731 },
11732 "albumUpdate": {
11733 "type": "boolean"
11734 },
11735 "enabled": {
11736 "type": "boolean"
11737 }
11738 },
11739 "type": "object"
11740 },
11741 "ExifResponseDto": {
11742 "properties": {
11743 "city": {
11744 "default": null,
11745 "nullable": true,
11746 "type": "string"
11747 },
11748 "country": {
11749 "default": null,
11750 "nullable": true,
11751 "type": "string"
11752 },
11753 "dateTimeOriginal": {
11754 "default": null,
11755 "format": "date-time",
11756 "nullable": true,
11757 "type": "string"
11758 },
11759 "description": {
11760 "default": null,
11761 "nullable": true,
11762 "type": "string"
11763 },
11764 "exifImageHeight": {
11765 "default": null,
11766 "nullable": true,
11767 "type": "number"
11768 },
11769 "exifImageWidth": {
11770 "default": null,
11771 "nullable": true,
11772 "type": "number"
11773 },
11774 "exposureTime": {
11775 "default": null,
11776 "nullable": true,
11777 "type": "string"
11778 },
11779 "fNumber": {
11780 "default": null,
11781 "nullable": true,
11782 "type": "number"
11783 },
11784 "fileSizeInByte": {
11785 "default": null,
11786 "format": "int64",
11787 "nullable": true,
11788 "type": "integer"
11789 },
11790 "focalLength": {
11791 "default": null,
11792 "nullable": true,
11793 "type": "number"
11794 },
11795 "iso": {
11796 "default": null,
11797 "nullable": true,
11798 "type": "number"
11799 },
11800 "latitude": {
11801 "default": null,
11802 "nullable": true,
11803 "type": "number"
11804 },
11805 "lensModel": {
11806 "default": null,
11807 "nullable": true,
11808 "type": "string"
11809 },
11810 "longitude": {
11811 "default": null,
11812 "nullable": true,
11813 "type": "number"
11814 },
11815 "make": {
11816 "default": null,
11817 "nullable": true,
11818 "type": "string"
11819 },
11820 "model": {
11821 "default": null,
11822 "nullable": true,
11823 "type": "string"
11824 },
11825 "modifyDate": {
11826 "default": null,
11827 "format": "date-time",
11828 "nullable": true,
11829 "type": "string"
11830 },
11831 "orientation": {
11832 "default": null,
11833 "nullable": true,
11834 "type": "string"
11835 },
11836 "projectionType": {
11837 "default": null,
11838 "nullable": true,
11839 "type": "string"
11840 },
11841 "rating": {
11842 "default": null,
11843 "nullable": true,
11844 "type": "number"
11845 },
11846 "state": {
11847 "default": null,
11848 "nullable": true,
11849 "type": "string"
11850 },
11851 "timeZone": {
11852 "default": null,
11853 "nullable": true,
11854 "type": "string"
11855 }
11856 },
11857 "type": "object"
11858 },
11859 "FaceDto": {
11860 "properties": {
11861 "id": {
11862 "format": "uuid",
11863 "type": "string"
11864 }
11865 },
11866 "required": [
11867 "id"
11868 ],
11869 "type": "object"
11870 },
11871 "FacialRecognitionConfig": {
11872 "properties": {
11873 "enabled": {
11874 "type": "boolean"
11875 },
11876 "maxDistance": {
11877 "format": "double",
11878 "maximum": 2,
11879 "minimum": 0.1,
11880 "type": "number"
11881 },
11882 "minFaces": {
11883 "minimum": 1,
11884 "type": "integer"
11885 },
11886 "minScore": {
11887 "format": "double",
11888 "maximum": 1,
11889 "minimum": 0.1,
11890 "type": "number"
11891 },
11892 "modelName": {
11893 "type": "string"
11894 }
11895 },
11896 "required": [
11897 "enabled",
11898 "maxDistance",
11899 "minFaces",
11900 "minScore",
11901 "modelName"
11902 ],
11903 "type": "object"
11904 },
11905 "FoldersResponse": {
11906 "properties": {
11907 "enabled": {
11908 "default": false,
11909 "type": "boolean"
11910 },
11911 "sidebarWeb": {
11912 "default": false,
11913 "type": "boolean"
11914 }
11915 },
11916 "required": [
11917 "enabled",
11918 "sidebarWeb"
11919 ],
11920 "type": "object"
11921 },
11922 "FoldersUpdate": {
11923 "properties": {
11924 "enabled": {
11925 "type": "boolean"
11926 },
11927 "sidebarWeb": {
11928 "type": "boolean"
11929 }
11930 },
11931 "type": "object"
11932 },
11933 "ImageFormat": {
11934 "enum": [
11935 "jpeg",
11936 "webp"
11937 ],
11938 "type": "string"
11939 },
11940 "JobCommand": {
11941 "enum": [
11942 "start",
11943 "pause",
11944 "resume",
11945 "empty",
11946 "clear-failed"
11947 ],
11948 "type": "string"
11949 },
11950 "JobCommandDto": {
11951 "properties": {
11952 "command": {
11953 "allOf": [
11954 {
11955 "$ref": "#/components/schemas/JobCommand"
11956 }
11957 ]
11958 },
11959 "force": {
11960 "type": "boolean"
11961 }
11962 },
11963 "required": [
11964 "command"
11965 ],
11966 "type": "object"
11967 },
11968 "JobCountsDto": {
11969 "properties": {
11970 "active": {
11971 "type": "integer"
11972 },
11973 "completed": {
11974 "type": "integer"
11975 },
11976 "delayed": {
11977 "type": "integer"
11978 },
11979 "failed": {
11980 "type": "integer"
11981 },
11982 "paused": {
11983 "type": "integer"
11984 },
11985 "waiting": {
11986 "type": "integer"
11987 }
11988 },
11989 "required": [
11990 "active",
11991 "completed",
11992 "delayed",
11993 "failed",
11994 "paused",
11995 "waiting"
11996 ],
11997 "type": "object"
11998 },
11999 "JobCreateDto": {
12000 "properties": {
12001 "name": {
12002 "allOf": [
12003 {
12004 "$ref": "#/components/schemas/ManualJobName"
12005 }
12006 ]
12007 }
12008 },
12009 "required": [
12010 "name"
12011 ],
12012 "type": "object"
12013 },
12014 "JobName": {
12015 "enum": [
12016 "thumbnailGeneration",
12017 "metadataExtraction",
12018 "videoConversion",
12019 "faceDetection",
12020 "facialRecognition",
12021 "smartSearch",
12022 "duplicateDetection",
12023 "backgroundTask",
12024 "storageTemplateMigration",
12025 "migration",
12026 "search",
12027 "sidecar",
12028 "library",
12029 "notifications",
12030 "backupDatabase"
12031 ],
12032 "type": "string"
12033 },
12034 "JobSettingsDto": {
12035 "properties": {
12036 "concurrency": {
12037 "minimum": 1,
12038 "type": "integer"
12039 }
12040 },
12041 "required": [
12042 "concurrency"
12043 ],
12044 "type": "object"
12045 },
12046 "JobStatusDto": {
12047 "properties": {
12048 "jobCounts": {
12049 "$ref": "#/components/schemas/JobCountsDto"
12050 },
12051 "queueStatus": {
12052 "$ref": "#/components/schemas/QueueStatusDto"
12053 }
12054 },
12055 "required": [
12056 "jobCounts",
12057 "queueStatus"
12058 ],
12059 "type": "object"
12060 },
12061 "LibraryResponseDto": {
12062 "properties": {
12063 "assetCount": {
12064 "type": "integer"
12065 },
12066 "createdAt": {
12067 "format": "date-time",
12068 "type": "string"
12069 },
12070 "exclusionPatterns": {
12071 "items": {
12072 "type": "string"
12073 },
12074 "type": "array"
12075 },
12076 "id": {
12077 "type": "string"
12078 },
12079 "importPaths": {
12080 "items": {
12081 "type": "string"
12082 },
12083 "type": "array"
12084 },
12085 "name": {
12086 "type": "string"
12087 },
12088 "ownerId": {
12089 "type": "string"
12090 },
12091 "refreshedAt": {
12092 "format": "date-time",
12093 "nullable": true,
12094 "type": "string"
12095 },
12096 "updatedAt": {
12097 "format": "date-time",
12098 "type": "string"
12099 }
12100 },
12101 "required": [
12102 "assetCount",
12103 "createdAt",
12104 "exclusionPatterns",
12105 "id",
12106 "importPaths",
12107 "name",
12108 "ownerId",
12109 "refreshedAt",
12110 "updatedAt"
12111 ],
12112 "type": "object"
12113 },
12114 "LibraryStatsResponseDto": {
12115 "properties": {
12116 "photos": {
12117 "default": 0,
12118 "type": "integer"
12119 },
12120 "total": {
12121 "default": 0,
12122 "type": "integer"
12123 },
12124 "usage": {
12125 "default": 0,
12126 "format": "int64",
12127 "type": "integer"
12128 },
12129 "videos": {
12130 "default": 0,
12131 "type": "integer"
12132 }
12133 },
12134 "required": [
12135 "photos",
12136 "total",
12137 "usage",
12138 "videos"
12139 ],
12140 "type": "object"
12141 },
12142 "LicenseKeyDto": {
12143 "properties": {
12144 "activationKey": {
12145 "type": "string"
12146 },
12147 "licenseKey": {
12148 "pattern": "/IM(SV|CL)(-[\\dA-Za-z]{4}){8}/",
12149 "type": "string"
12150 }
12151 },
12152 "required": [
12153 "activationKey",
12154 "licenseKey"
12155 ],
12156 "type": "object"
12157 },
12158 "LicenseResponseDto": {
12159 "properties": {
12160 "activatedAt": {
12161 "format": "date-time",
12162 "type": "string"
12163 },
12164 "activationKey": {
12165 "type": "string"
12166 },
12167 "licenseKey": {
12168 "pattern": "/IM(SV|CL)(-[\\dA-Za-z]{4}){8}/",
12169 "type": "string"
12170 }
12171 },
12172 "required": [
12173 "activatedAt",
12174 "activationKey",
12175 "licenseKey"
12176 ],
12177 "type": "object"
12178 },
12179 "LogLevel": {
12180 "enum": [
12181 "verbose",
12182 "debug",
12183 "log",
12184 "warn",
12185 "error",
12186 "fatal"
12187 ],
12188 "type": "string"
12189 },
12190 "LoginCredentialDto": {
12191 "properties": {
12192 "email": {
12193 "example": "[email protected]",
12194 "format": "email",
12195 "type": "string"
12196 },
12197 "password": {
12198 "example": "password",
12199 "type": "string"
12200 }
12201 },
12202 "required": [
12203 "email",
12204 "password"
12205 ],
12206 "type": "object"
12207 },
12208 "LoginResponseDto": {
12209 "properties": {
12210 "accessToken": {
12211 "type": "string"
12212 },
12213 "isAdmin": {
12214 "type": "boolean"
12215 },
12216 "isOnboarded": {
12217 "type": "boolean"
12218 },
12219 "name": {
12220 "type": "string"
12221 },
12222 "profileImagePath": {
12223 "type": "string"
12224 },
12225 "shouldChangePassword": {
12226 "type": "boolean"
12227 },
12228 "userEmail": {
12229 "type": "string"
12230 },
12231 "userId": {
12232 "type": "string"
12233 }
12234 },
12235 "required": [
12236 "accessToken",
12237 "isAdmin",
12238 "isOnboarded",
12239 "name",
12240 "profileImagePath",
12241 "shouldChangePassword",
12242 "userEmail",
12243 "userId"
12244 ],
12245 "type": "object"
12246 },
12247 "LogoutResponseDto": {
12248 "properties": {
12249 "redirectUri": {
12250 "type": "string"
12251 },
12252 "successful": {
12253 "type": "boolean"
12254 }
12255 },
12256 "required": [
12257 "redirectUri",
12258 "successful"
12259 ],
12260 "type": "object"
12261 },
12262 "MachineLearningAvailabilityChecksDto": {
12263 "properties": {
12264 "enabled": {
12265 "type": "boolean"
12266 },
12267 "interval": {
12268 "type": "number"
12269 },
12270 "timeout": {
12271 "type": "number"
12272 }
12273 },
12274 "required": [
12275 "enabled",
12276 "interval",
12277 "timeout"
12278 ],
12279 "type": "object"
12280 },
12281 "ManualJobName": {
12282 "enum": [
12283 "person-cleanup",
12284 "tag-cleanup",
12285 "user-cleanup",
12286 "memory-cleanup",
12287 "memory-create",
12288 "backup-database"
12289 ],
12290 "type": "string"
12291 },
12292 "MapMarkerResponseDto": {
12293 "properties": {
12294 "city": {
12295 "nullable": true,
12296 "type": "string"
12297 },
12298 "country": {
12299 "nullable": true,
12300 "type": "string"
12301 },
12302 "id": {
12303 "type": "string"
12304 },
12305 "lat": {
12306 "format": "double",
12307 "type": "number"
12308 },
12309 "lon": {
12310 "format": "double",
12311 "type": "number"
12312 },
12313 "state": {
12314 "nullable": true,
12315 "type": "string"
12316 }
12317 },
12318 "required": [
12319 "city",
12320 "country",
12321 "id",
12322 "lat",
12323 "lon",
12324 "state"
12325 ],
12326 "type": "object"
12327 },
12328 "MapReverseGeocodeResponseDto": {
12329 "properties": {
12330 "city": {
12331 "nullable": true,
12332 "type": "string"
12333 },
12334 "country": {
12335 "nullable": true,
12336 "type": "string"
12337 },
12338 "state": {
12339 "nullable": true,
12340 "type": "string"
12341 }
12342 },
12343 "required": [
12344 "city",
12345 "country",
12346 "state"
12347 ],
12348 "type": "object"
12349 },
12350 "MemoriesResponse": {
12351 "properties": {
12352 "enabled": {
12353 "default": true,
12354 "type": "boolean"
12355 }
12356 },
12357 "required": [
12358 "enabled"
12359 ],
12360 "type": "object"
12361 },
12362 "MemoriesUpdate": {
12363 "properties": {
12364 "enabled": {
12365 "type": "boolean"
12366 }
12367 },
12368 "type": "object"
12369 },
12370 "MemoryCreateDto": {
12371 "properties": {
12372 "assetIds": {
12373 "items": {
12374 "format": "uuid",
12375 "type": "string"
12376 },
12377 "type": "array"
12378 },
12379 "data": {
12380 "$ref": "#/components/schemas/OnThisDayDto"
12381 },
12382 "isSaved": {
12383 "type": "boolean"
12384 },
12385 "memoryAt": {
12386 "format": "date-time",
12387 "type": "string"
12388 },
12389 "seenAt": {
12390 "format": "date-time",
12391 "type": "string"
12392 },
12393 "type": {
12394 "allOf": [
12395 {
12396 "$ref": "#/components/schemas/MemoryType"
12397 }
12398 ]
12399 }
12400 },
12401 "required": [
12402 "data",
12403 "memoryAt",
12404 "type"
12405 ],
12406 "type": "object"
12407 },
12408 "MemoryResponseDto": {
12409 "properties": {
12410 "assets": {
12411 "items": {
12412 "$ref": "#/components/schemas/AssetResponseDto"
12413 },
12414 "type": "array"
12415 },
12416 "createdAt": {
12417 "format": "date-time",
12418 "type": "string"
12419 },
12420 "data": {
12421 "$ref": "#/components/schemas/OnThisDayDto"
12422 },
12423 "deletedAt": {
12424 "format": "date-time",
12425 "type": "string"
12426 },
12427 "hideAt": {
12428 "format": "date-time",
12429 "type": "string"
12430 },
12431 "id": {
12432 "type": "string"
12433 },
12434 "isSaved": {
12435 "type": "boolean"
12436 },
12437 "memoryAt": {
12438 "format": "date-time",
12439 "type": "string"
12440 },
12441 "ownerId": {
12442 "type": "string"
12443 },
12444 "seenAt": {
12445 "format": "date-time",
12446 "type": "string"
12447 },
12448 "showAt": {
12449 "format": "date-time",
12450 "type": "string"
12451 },
12452 "type": {
12453 "allOf": [
12454 {
12455 "$ref": "#/components/schemas/MemoryType"
12456 }
12457 ]
12458 },
12459 "updatedAt": {
12460 "format": "date-time",
12461 "type": "string"
12462 }
12463 },
12464 "required": [
12465 "assets",
12466 "createdAt",
12467 "data",
12468 "id",
12469 "isSaved",
12470 "memoryAt",
12471 "ownerId",
12472 "type",
12473 "updatedAt"
12474 ],
12475 "type": "object"
12476 },
12477 "MemoryStatisticsResponseDto": {
12478 "properties": {
12479 "total": {
12480 "type": "integer"
12481 }
12482 },
12483 "required": [
12484 "total"
12485 ],
12486 "type": "object"
12487 },
12488 "MemoryType": {
12489 "enum": [
12490 "on_this_day"
12491 ],
12492 "type": "string"
12493 },
12494 "MemoryUpdateDto": {
12495 "properties": {
12496 "isSaved": {
12497 "type": "boolean"
12498 },
12499 "memoryAt": {
12500 "format": "date-time",
12501 "type": "string"
12502 },
12503 "seenAt": {
12504 "format": "date-time",
12505 "type": "string"
12506 }
12507 },
12508 "type": "object"
12509 },
12510 "MergePersonDto": {
12511 "properties": {
12512 "ids": {
12513 "items": {
12514 "format": "uuid",
12515 "type": "string"
12516 },
12517 "type": "array"
12518 }
12519 },
12520 "required": [
12521 "ids"
12522 ],
12523 "type": "object"
12524 },
12525 "MetadataSearchDto": {
12526 "properties": {
12527 "albumIds": {
12528 "items": {
12529 "format": "uuid",
12530 "type": "string"
12531 },
12532 "type": "array"
12533 },
12534 "checksum": {
12535 "type": "string"
12536 },
12537 "city": {
12538 "nullable": true,
12539 "type": "string"
12540 },
12541 "country": {
12542 "nullable": true,
12543 "type": "string"
12544 },
12545 "createdAfter": {
12546 "format": "date-time",
12547 "type": "string"
12548 },
12549 "createdBefore": {
12550 "format": "date-time",
12551 "type": "string"
12552 },
12553 "description": {
12554 "type": "string"
12555 },
12556 "deviceAssetId": {
12557 "type": "string"
12558 },
12559 "deviceId": {
12560 "type": "string"
12561 },
12562 "encodedVideoPath": {
12563 "type": "string"
12564 },
12565 "id": {
12566 "format": "uuid",
12567 "type": "string"
12568 },
12569 "isEncoded": {
12570 "type": "boolean"
12571 },
12572 "isFavorite": {
12573 "type": "boolean"
12574 },
12575 "isMotion": {
12576 "type": "boolean"
12577 },
12578 "isNotInAlbum": {
12579 "type": "boolean"
12580 },
12581 "isOffline": {
12582 "type": "boolean"
12583 },
12584 "lensModel": {
12585 "nullable": true,
12586 "type": "string"
12587 },
12588 "libraryId": {
12589 "format": "uuid",
12590 "nullable": true,
12591 "type": "string"
12592 },
12593 "make": {
12594 "type": "string"
12595 },
12596 "model": {
12597 "nullable": true,
12598 "type": "string"
12599 },
12600 "order": {
12601 "allOf": [
12602 {
12603 "$ref": "#/components/schemas/AssetOrder"
12604 }
12605 ],
12606 "default": "desc"
12607 },
12608 "originalFileName": {
12609 "type": "string"
12610 },
12611 "originalPath": {
12612 "type": "string"
12613 },
12614 "page": {
12615 "minimum": 1,
12616 "type": "number"
12617 },
12618 "personIds": {
12619 "items": {
12620 "format": "uuid",
12621 "type": "string"
12622 },
12623 "type": "array"
12624 },
12625 "previewPath": {
12626 "type": "string"
12627 },
12628 "rating": {
12629 "maximum": 5,
12630 "minimum": -1,
12631 "type": "number"
12632 },
12633 "size": {
12634 "maximum": 1000,
12635 "minimum": 1,
12636 "type": "number"
12637 },
12638 "state": {
12639 "nullable": true,
12640 "type": "string"
12641 },
12642 "tagIds": {
12643 "items": {
12644 "format": "uuid",
12645 "type": "string"
12646 },
12647 "nullable": true,
12648 "type": "array"
12649 },
12650 "takenAfter": {
12651 "format": "date-time",
12652 "type": "string"
12653 },
12654 "takenBefore": {
12655 "format": "date-time",
12656 "type": "string"
12657 },
12658 "thumbnailPath": {
12659 "type": "string"
12660 },
12661 "trashedAfter": {
12662 "format": "date-time",
12663 "type": "string"
12664 },
12665 "trashedBefore": {
12666 "format": "date-time",
12667 "type": "string"
12668 },
12669 "type": {
12670 "allOf": [
12671 {
12672 "$ref": "#/components/schemas/AssetTypeEnum"
12673 }
12674 ]
12675 },
12676 "updatedAfter": {
12677 "format": "date-time",
12678 "type": "string"
12679 },
12680 "updatedBefore": {
12681 "format": "date-time",
12682 "type": "string"
12683 },
12684 "visibility": {
12685 "allOf": [
12686 {
12687 "$ref": "#/components/schemas/AssetVisibility"
12688 }
12689 ]
12690 },
12691 "withDeleted": {
12692 "type": "boolean"
12693 },
12694 "withExif": {
12695 "type": "boolean"
12696 },
12697 "withPeople": {
12698 "type": "boolean"
12699 },
12700 "withStacked": {
12701 "type": "boolean"
12702 }
12703 },
12704 "type": "object"
12705 },
12706 "NotificationCreateDto": {
12707 "properties": {
12708 "data": {
12709 "type": "object"
12710 },
12711 "description": {
12712 "nullable": true,
12713 "type": "string"
12714 },
12715 "level": {
12716 "allOf": [
12717 {
12718 "$ref": "#/components/schemas/NotificationLevel"
12719 }
12720 ]
12721 },
12722 "readAt": {
12723 "format": "date-time",
12724 "nullable": true,
12725 "type": "string"
12726 },
12727 "title": {
12728 "type": "string"
12729 },
12730 "type": {
12731 "allOf": [
12732 {
12733 "$ref": "#/components/schemas/NotificationType"
12734 }
12735 ]
12736 },
12737 "userId": {
12738 "format": "uuid",
12739 "type": "string"
12740 }
12741 },
12742 "required": [
12743 "title",
12744 "userId"
12745 ],
12746 "type": "object"
12747 },
12748 "NotificationDeleteAllDto": {
12749 "properties": {
12750 "ids": {
12751 "items": {
12752 "format": "uuid",
12753 "type": "string"
12754 },
12755 "type": "array"
12756 }
12757 },
12758 "required": [
12759 "ids"
12760 ],
12761 "type": "object"
12762 },
12763 "NotificationDto": {
12764 "properties": {
12765 "createdAt": {
12766 "format": "date-time",
12767 "type": "string"
12768 },
12769 "data": {
12770 "type": "object"
12771 },
12772 "description": {
12773 "type": "string"
12774 },
12775 "id": {
12776 "type": "string"
12777 },
12778 "level": {
12779 "allOf": [
12780 {
12781 "$ref": "#/components/schemas/NotificationLevel"
12782 }
12783 ]
12784 },
12785 "readAt": {
12786 "format": "date-time",
12787 "type": "string"
12788 },
12789 "title": {
12790 "type": "string"
12791 },
12792 "type": {
12793 "allOf": [
12794 {
12795 "$ref": "#/components/schemas/NotificationType"
12796 }
12797 ]
12798 }
12799 },
12800 "required": [
12801 "createdAt",
12802 "id",
12803 "level",
12804 "title",
12805 "type"
12806 ],
12807 "type": "object"
12808 },
12809 "NotificationLevel": {
12810 "enum": [
12811 "success",
12812 "error",
12813 "warning",
12814 "info"
12815 ],
12816 "type": "string"
12817 },
12818 "NotificationType": {
12819 "enum": [
12820 "JobFailed",
12821 "BackupFailed",
12822 "SystemMessage",
12823 "Custom"
12824 ],
12825 "type": "string"
12826 },
12827 "NotificationUpdateAllDto": {
12828 "properties": {
12829 "ids": {
12830 "items": {
12831 "format": "uuid",
12832 "type": "string"
12833 },
12834 "type": "array"
12835 },
12836 "readAt": {
12837 "format": "date-time",
12838 "nullable": true,
12839 "type": "string"
12840 }
12841 },
12842 "required": [
12843 "ids"
12844 ],
12845 "type": "object"
12846 },
12847 "NotificationUpdateDto": {
12848 "properties": {
12849 "readAt": {
12850 "format": "date-time",
12851 "nullable": true,
12852 "type": "string"
12853 }
12854 },
12855 "type": "object"
12856 },
12857 "OAuthAuthorizeResponseDto": {
12858 "properties": {
12859 "url": {
12860 "type": "string"
12861 }
12862 },
12863 "required": [
12864 "url"
12865 ],
12866 "type": "object"
12867 },
12868 "OAuthCallbackDto": {
12869 "properties": {
12870 "codeVerifier": {
12871 "type": "string"
12872 },
12873 "state": {
12874 "type": "string"
12875 },
12876 "url": {
12877 "type": "string"
12878 }
12879 },
12880 "required": [
12881 "url"
12882 ],
12883 "type": "object"
12884 },
12885 "OAuthConfigDto": {
12886 "properties": {
12887 "codeChallenge": {
12888 "type": "string"
12889 },
12890 "redirectUri": {
12891 "type": "string"
12892 },
12893 "state": {
12894 "type": "string"
12895 }
12896 },
12897 "required": [
12898 "redirectUri"
12899 ],
12900 "type": "object"
12901 },
12902 "OAuthTokenEndpointAuthMethod": {
12903 "enum": [
12904 "client_secret_post",
12905 "client_secret_basic"
12906 ],
12907 "type": "string"
12908 },
12909 "OnThisDayDto": {
12910 "properties": {
12911 "year": {
12912 "minimum": 1,
12913 "type": "number"
12914 }
12915 },
12916 "required": [
12917 "year"
12918 ],
12919 "type": "object"
12920 },
12921 "OnboardingDto": {
12922 "properties": {
12923 "isOnboarded": {
12924 "type": "boolean"
12925 }
12926 },
12927 "required": [
12928 "isOnboarded"
12929 ],
12930 "type": "object"
12931 },
12932 "OnboardingResponseDto": {
12933 "properties": {
12934 "isOnboarded": {
12935 "type": "boolean"
12936 }
12937 },
12938 "required": [
12939 "isOnboarded"
12940 ],
12941 "type": "object"
12942 },
12943 "PartnerCreateDto": {
12944 "properties": {
12945 "sharedWithId": {
12946 "format": "uuid",
12947 "type": "string"
12948 }
12949 },
12950 "required": [
12951 "sharedWithId"
12952 ],
12953 "type": "object"
12954 },
12955 "PartnerDirection": {
12956 "enum": [
12957 "shared-by",
12958 "shared-with"
12959 ],
12960 "type": "string"
12961 },
12962 "PartnerResponseDto": {
12963 "properties": {
12964 "avatarColor": {
12965 "allOf": [
12966 {
12967 "$ref": "#/components/schemas/UserAvatarColor"
12968 }
12969 ]
12970 },
12971 "email": {
12972 "type": "string"
12973 },
12974 "id": {
12975 "type": "string"
12976 },
12977 "inTimeline": {
12978 "type": "boolean"
12979 },
12980 "name": {
12981 "type": "string"
12982 },
12983 "profileChangedAt": {
12984 "format": "date-time",
12985 "type": "string"
12986 },
12987 "profileImagePath": {
12988 "type": "string"
12989 }
12990 },
12991 "required": [
12992 "avatarColor",
12993 "email",
12994 "id",
12995 "name",
12996 "profileChangedAt",
12997 "profileImagePath"
12998 ],
12999 "type": "object"
13000 },
13001 "PartnerUpdateDto": {
13002 "properties": {
13003 "inTimeline": {
13004 "type": "boolean"
13005 }
13006 },
13007 "required": [
13008 "inTimeline"
13009 ],
13010 "type": "object"
13011 },
13012 "PeopleResponse": {
13013 "properties": {
13014 "enabled": {
13015 "default": true,
13016 "type": "boolean"
13017 },
13018 "sidebarWeb": {
13019 "default": false,
13020 "type": "boolean"
13021 }
13022 },
13023 "required": [
13024 "enabled",
13025 "sidebarWeb"
13026 ],
13027 "type": "object"
13028 },
13029 "PeopleResponseDto": {
13030 "properties": {
13031 "hasNextPage": {
13032 "description": "This property was added in v1.110.0",
13033 "type": "boolean"
13034 },
13035 "hidden": {
13036 "type": "integer"
13037 },
13038 "people": {
13039 "items": {
13040 "$ref": "#/components/schemas/PersonResponseDto"
13041 },
13042 "type": "array"
13043 },
13044 "total": {
13045 "type": "integer"
13046 }
13047 },
13048 "required": [
13049 "hidden",
13050 "people",
13051 "total"
13052 ],
13053 "type": "object"
13054 },
13055 "PeopleUpdate": {
13056 "properties": {
13057 "enabled": {
13058 "type": "boolean"
13059 },
13060 "sidebarWeb": {
13061 "type": "boolean"
13062 }
13063 },
13064 "type": "object"
13065 },
13066 "PeopleUpdateDto": {
13067 "properties": {
13068 "people": {
13069 "items": {
13070 "$ref": "#/components/schemas/PeopleUpdateItem"
13071 },
13072 "type": "array"
13073 }
13074 },
13075 "required": [
13076 "people"
13077 ],
13078 "type": "object"
13079 },
13080 "PeopleUpdateItem": {
13081 "properties": {
13082 "birthDate": {
13083 "description": "Person date of birth.\nNote: the mobile app cannot currently set the birth date to null.",
13084 "format": "date",
13085 "nullable": true,
13086 "type": "string"
13087 },
13088 "color": {
13089 "nullable": true,
13090 "type": "string"
13091 },
13092 "featureFaceAssetId": {
13093 "description": "Asset is used to get the feature face thumbnail.",
13094 "format": "uuid",
13095 "type": "string"
13096 },
13097 "id": {
13098 "description": "Person id.",
13099 "type": "string"
13100 },
13101 "isFavorite": {
13102 "type": "boolean"
13103 },
13104 "isHidden": {
13105 "description": "Person visibility",
13106 "type": "boolean"
13107 },
13108 "name": {
13109 "description": "Person name.",
13110 "type": "string"
13111 }
13112 },
13113 "required": [
13114 "id"
13115 ],
13116 "type": "object"
13117 },
13118 "Permission": {
13119 "enum": [
13120 "all",
13121 "activity.create",
13122 "activity.read",
13123 "activity.update",
13124 "activity.delete",
13125 "activity.statistics",
13126 "apiKey.create",
13127 "apiKey.read",
13128 "apiKey.update",
13129 "apiKey.delete",
13130 "asset.read",
13131 "asset.update",
13132 "asset.delete",
13133 "asset.statistics",
13134 "asset.share",
13135 "asset.view",
13136 "asset.download",
13137 "asset.upload",
13138 "asset.replace",
13139 "album.create",
13140 "album.read",
13141 "album.update",
13142 "album.delete",
13143 "album.statistics",
13144 "album.share",
13145 "album.download",
13146 "albumAsset.create",
13147 "albumAsset.delete",
13148 "albumUser.create",
13149 "albumUser.update",
13150 "albumUser.delete",
13151 "auth.changePassword",
13152 "authDevice.delete",
13153 "archive.read",
13154 "duplicate.read",
13155 "duplicate.delete",
13156 "face.create",
13157 "face.read",
13158 "face.update",
13159 "face.delete",
13160 "job.create",
13161 "job.read",
13162 "library.create",
13163 "library.read",
13164 "library.update",
13165 "library.delete",
13166 "library.statistics",
13167 "timeline.read",
13168 "timeline.download",
13169 "memory.create",
13170 "memory.read",
13171 "memory.update",
13172 "memory.delete",
13173 "memory.statistics",
13174 "memoryAsset.create",
13175 "memoryAsset.delete",
13176 "notification.create",
13177 "notification.read",
13178 "notification.update",
13179 "notification.delete",
13180 "partner.create",
13181 "partner.read",
13182 "partner.update",
13183 "partner.delete",
13184 "person.create",
13185 "person.read",
13186 "person.update",
13187 "person.delete",
13188 "person.statistics",
13189 "person.merge",
13190 "person.reassign",
13191 "pinCode.create",
13192 "pinCode.update",
13193 "pinCode.delete",
13194 "server.about",
13195 "server.apkLinks",
13196 "server.storage",
13197 "server.statistics",
13198 "server.versionCheck",
13199 "serverLicense.read",
13200 "serverLicense.update",
13201 "serverLicense.delete",
13202 "session.create",
13203 "session.read",
13204 "session.update",
13205 "session.delete",
13206 "session.lock",
13207 "sharedLink.create",
13208 "sharedLink.read",
13209 "sharedLink.update",
13210 "sharedLink.delete",
13211 "stack.create",
13212 "stack.read",
13213 "stack.update",
13214 "stack.delete",
13215 "sync.stream",
13216 "syncCheckpoint.read",
13217 "syncCheckpoint.update",
13218 "syncCheckpoint.delete",
13219 "systemConfig.read",
13220 "systemConfig.update",
13221 "systemMetadata.read",
13222 "systemMetadata.update",
13223 "tag.create",
13224 "tag.read",
13225 "tag.update",
13226 "tag.delete",
13227 "tag.asset",
13228 "user.read",
13229 "user.update",
13230 "userLicense.create",
13231 "userLicense.read",
13232 "userLicense.update",
13233 "userLicense.delete",
13234 "userOnboarding.read",
13235 "userOnboarding.update",
13236 "userOnboarding.delete",
13237 "userPreference.read",
13238 "userPreference.update",
13239 "userProfileImage.create",
13240 "userProfileImage.read",
13241 "userProfileImage.update",
13242 "userProfileImage.delete",
13243 "adminUser.create",
13244 "adminUser.read",
13245 "adminUser.update",
13246 "adminUser.delete",
13247 "adminAuth.unlinkAll"
13248 ],
13249 "type": "string"
13250 },
13251 "PersonCreateDto": {
13252 "properties": {
13253 "birthDate": {
13254 "description": "Person date of birth.\nNote: the mobile app cannot currently set the birth date to null.",
13255 "format": "date",
13256 "nullable": true,
13257 "type": "string"
13258 },
13259 "color": {
13260 "nullable": true,
13261 "type": "string"
13262 },
13263 "isFavorite": {
13264 "type": "boolean"
13265 },
13266 "isHidden": {
13267 "description": "Person visibility",
13268 "type": "boolean"
13269 },
13270 "name": {
13271 "description": "Person name.",
13272 "type": "string"
13273 }
13274 },
13275 "type": "object"
13276 },
13277 "PersonResponseDto": {
13278 "properties": {
13279 "birthDate": {
13280 "format": "date",
13281 "nullable": true,
13282 "type": "string"
13283 },
13284 "color": {
13285 "description": "This property was added in v1.126.0",
13286 "type": "string"
13287 },
13288 "id": {
13289 "type": "string"
13290 },
13291 "isFavorite": {
13292 "description": "This property was added in v1.126.0",
13293 "type": "boolean"
13294 },
13295 "isHidden": {
13296 "type": "boolean"
13297 },
13298 "name": {
13299 "type": "string"
13300 },
13301 "thumbnailPath": {
13302 "type": "string"
13303 },
13304 "updatedAt": {
13305 "description": "This property was added in v1.107.0",
13306 "format": "date-time",
13307 "type": "string"
13308 }
13309 },
13310 "required": [
13311 "birthDate",
13312 "id",
13313 "isHidden",
13314 "name",
13315 "thumbnailPath"
13316 ],
13317 "type": "object"
13318 },
13319 "PersonStatisticsResponseDto": {
13320 "properties": {
13321 "assets": {
13322 "type": "integer"
13323 }
13324 },
13325 "required": [
13326 "assets"
13327 ],
13328 "type": "object"
13329 },
13330 "PersonUpdateDto": {
13331 "properties": {
13332 "birthDate": {
13333 "description": "Person date of birth.\nNote: the mobile app cannot currently set the birth date to null.",
13334 "format": "date",
13335 "nullable": true,
13336 "type": "string"
13337 },
13338 "color": {
13339 "nullable": true,
13340 "type": "string"
13341 },
13342 "featureFaceAssetId": {
13343 "description": "Asset is used to get the feature face thumbnail.",
13344 "format": "uuid",
13345 "type": "string"
13346 },
13347 "isFavorite": {
13348 "type": "boolean"
13349 },
13350 "isHidden": {
13351 "description": "Person visibility",
13352 "type": "boolean"
13353 },
13354 "name": {
13355 "description": "Person name.",
13356 "type": "string"
13357 }
13358 },
13359 "type": "object"
13360 },
13361 "PersonWithFacesResponseDto": {
13362 "properties": {
13363 "birthDate": {
13364 "format": "date",
13365 "nullable": true,
13366 "type": "string"
13367 },
13368 "color": {
13369 "description": "This property was added in v1.126.0",
13370 "type": "string"
13371 },
13372 "faces": {
13373 "items": {
13374 "$ref": "#/components/schemas/AssetFaceWithoutPersonResponseDto"
13375 },
13376 "type": "array"
13377 },
13378 "id": {
13379 "type": "string"
13380 },
13381 "isFavorite": {
13382 "description": "This property was added in v1.126.0",
13383 "type": "boolean"
13384 },
13385 "isHidden": {
13386 "type": "boolean"
13387 },
13388 "name": {
13389 "type": "string"
13390 },
13391 "thumbnailPath": {
13392 "type": "string"
13393 },
13394 "updatedAt": {
13395 "description": "This property was added in v1.107.0",
13396 "format": "date-time",
13397 "type": "string"
13398 }
13399 },
13400 "required": [
13401 "birthDate",
13402 "faces",
13403 "id",
13404 "isHidden",
13405 "name",
13406 "thumbnailPath"
13407 ],
13408 "type": "object"
13409 },
13410 "PinCodeChangeDto": {
13411 "properties": {
13412 "newPinCode": {
13413 "example": "123456",
13414 "type": "string"
13415 },
13416 "password": {
13417 "type": "string"
13418 },
13419 "pinCode": {
13420 "example": "123456",
13421 "type": "string"
13422 }
13423 },
13424 "required": [
13425 "newPinCode"
13426 ],
13427 "type": "object"
13428 },
13429 "PinCodeResetDto": {
13430 "properties": {
13431 "password": {
13432 "type": "string"
13433 },
13434 "pinCode": {
13435 "example": "123456",
13436 "type": "string"
13437 }
13438 },
13439 "type": "object"
13440 },
13441 "PinCodeSetupDto": {
13442 "properties": {
13443 "pinCode": {
13444 "example": "123456",
13445 "type": "string"
13446 }
13447 },
13448 "required": [
13449 "pinCode"
13450 ],
13451 "type": "object"
13452 },
13453 "PlacesResponseDto": {
13454 "properties": {
13455 "admin1name": {
13456 "type": "string"
13457 },
13458 "admin2name": {
13459 "type": "string"
13460 },
13461 "latitude": {
13462 "type": "number"
13463 },
13464 "longitude": {
13465 "type": "number"
13466 },
13467 "name": {
13468 "type": "string"
13469 }
13470 },
13471 "required": [
13472 "latitude",
13473 "longitude",
13474 "name"
13475 ],
13476 "type": "object"
13477 },
13478 "PurchaseResponse": {
13479 "properties": {
13480 "hideBuyButtonUntil": {
13481 "type": "string"
13482 },
13483 "showSupportBadge": {
13484 "type": "boolean"
13485 }
13486 },
13487 "required": [
13488 "hideBuyButtonUntil",
13489 "showSupportBadge"
13490 ],
13491 "type": "object"
13492 },
13493 "PurchaseUpdate": {
13494 "properties": {
13495 "hideBuyButtonUntil": {
13496 "type": "string"
13497 },
13498 "showSupportBadge": {
13499 "type": "boolean"
13500 }
13501 },
13502 "type": "object"
13503 },
13504 "QueueStatusDto": {
13505 "properties": {
13506 "isActive": {
13507 "type": "boolean"
13508 },
13509 "isPaused": {
13510 "type": "boolean"
13511 }
13512 },
13513 "required": [
13514 "isActive",
13515 "isPaused"
13516 ],
13517 "type": "object"
13518 },
13519 "RandomSearchDto": {
13520 "properties": {
13521 "albumIds": {
13522 "items": {
13523 "format": "uuid",
13524 "type": "string"
13525 },
13526 "type": "array"
13527 },
13528 "city": {
13529 "nullable": true,
13530 "type": "string"
13531 },
13532 "country": {
13533 "nullable": true,
13534 "type": "string"
13535 },
13536 "createdAfter": {
13537 "format": "date-time",
13538 "type": "string"
13539 },
13540 "createdBefore": {
13541 "format": "date-time",
13542 "type": "string"
13543 },
13544 "deviceId": {
13545 "type": "string"
13546 },
13547 "isEncoded": {
13548 "type": "boolean"
13549 },
13550 "isFavorite": {
13551 "type": "boolean"
13552 },
13553 "isMotion": {
13554 "type": "boolean"
13555 },
13556 "isNotInAlbum": {
13557 "type": "boolean"
13558 },
13559 "isOffline": {
13560 "type": "boolean"
13561 },
13562 "lensModel": {
13563 "nullable": true,
13564 "type": "string"
13565 },
13566 "libraryId": {
13567 "format": "uuid",
13568 "nullable": true,
13569 "type": "string"
13570 },
13571 "make": {
13572 "type": "string"
13573 },
13574 "model": {
13575 "nullable": true,
13576 "type": "string"
13577 },
13578 "personIds": {
13579 "items": {
13580 "format": "uuid",
13581 "type": "string"
13582 },
13583 "type": "array"
13584 },
13585 "rating": {
13586 "maximum": 5,
13587 "minimum": -1,
13588 "type": "number"
13589 },
13590 "size": {
13591 "maximum": 1000,
13592 "minimum": 1,
13593 "type": "number"
13594 },
13595 "state": {
13596 "nullable": true,
13597 "type": "string"
13598 },
13599 "tagIds": {
13600 "items": {
13601 "format": "uuid",
13602 "type": "string"
13603 },
13604 "nullable": true,
13605 "type": "array"
13606 },
13607 "takenAfter": {
13608 "format": "date-time",
13609 "type": "string"
13610 },
13611 "takenBefore": {
13612 "format": "date-time",
13613 "type": "string"
13614 },
13615 "trashedAfter": {
13616 "format": "date-time",
13617 "type": "string"
13618 },
13619 "trashedBefore": {
13620 "format": "date-time",
13621 "type": "string"
13622 },
13623 "type": {
13624 "allOf": [
13625 {
13626 "$ref": "#/components/schemas/AssetTypeEnum"
13627 }
13628 ]
13629 },
13630 "updatedAfter": {
13631 "format": "date-time",
13632 "type": "string"
13633 },
13634 "updatedBefore": {
13635 "format": "date-time",
13636 "type": "string"
13637 },
13638 "visibility": {
13639 "allOf": [
13640 {
13641 "$ref": "#/components/schemas/AssetVisibility"
13642 }
13643 ]
13644 },
13645 "withDeleted": {
13646 "type": "boolean"
13647 },
13648 "withExif": {
13649 "type": "boolean"
13650 },
13651 "withPeople": {
13652 "type": "boolean"
13653 },
13654 "withStacked": {
13655 "type": "boolean"
13656 }
13657 },
13658 "type": "object"
13659 },
13660 "RatingsResponse": {
13661 "properties": {
13662 "enabled": {
13663 "default": false,
13664 "type": "boolean"
13665 }
13666 },
13667 "required": [
13668 "enabled"
13669 ],
13670 "type": "object"
13671 },
13672 "RatingsUpdate": {
13673 "properties": {
13674 "enabled": {
13675 "type": "boolean"
13676 }
13677 },
13678 "type": "object"
13679 },
13680 "ReactionLevel": {
13681 "enum": [
13682 "album",
13683 "asset"
13684 ],
13685 "type": "string"
13686 },
13687 "ReactionType": {
13688 "enum": [
13689 "comment",
13690 "like"
13691 ],
13692 "type": "string"
13693 },
13694 "ReverseGeocodingStateResponseDto": {
13695 "properties": {
13696 "lastImportFileName": {
13697 "nullable": true,
13698 "type": "string"
13699 },
13700 "lastUpdate": {
13701 "nullable": true,
13702 "type": "string"
13703 }
13704 },
13705 "required": [
13706 "lastImportFileName",
13707 "lastUpdate"
13708 ],
13709 "type": "object"
13710 },
13711 "SearchAlbumResponseDto": {
13712 "properties": {
13713 "count": {
13714 "type": "integer"
13715 },
13716 "facets": {
13717 "items": {
13718 "$ref": "#/components/schemas/SearchFacetResponseDto"
13719 },
13720 "type": "array"
13721 },
13722 "items": {
13723 "items": {
13724 "$ref": "#/components/schemas/AlbumResponseDto"
13725 },
13726 "type": "array"
13727 },
13728 "total": {
13729 "type": "integer"
13730 }
13731 },
13732 "required": [
13733 "count",
13734 "facets",
13735 "items",
13736 "total"
13737 ],
13738 "type": "object"
13739 },
13740 "SearchAssetResponseDto": {
13741 "properties": {
13742 "count": {
13743 "type": "integer"
13744 },
13745 "facets": {
13746 "items": {
13747 "$ref": "#/components/schemas/SearchFacetResponseDto"
13748 },
13749 "type": "array"
13750 },
13751 "items": {
13752 "items": {
13753 "$ref": "#/components/schemas/AssetResponseDto"
13754 },
13755 "type": "array"
13756 },
13757 "nextPage": {
13758 "nullable": true,
13759 "type": "string"
13760 },
13761 "total": {
13762 "type": "integer"
13763 }
13764 },
13765 "required": [
13766 "count",
13767 "facets",
13768 "items",
13769 "nextPage",
13770 "total"
13771 ],
13772 "type": "object"
13773 },
13774 "SearchExploreItem": {
13775 "properties": {
13776 "data": {
13777 "$ref": "#/components/schemas/AssetResponseDto"
13778 },
13779 "value": {
13780 "type": "string"
13781 }
13782 },
13783 "required": [
13784 "data",
13785 "value"
13786 ],
13787 "type": "object"
13788 },
13789 "SearchExploreResponseDto": {
13790 "properties": {
13791 "fieldName": {
13792 "type": "string"
13793 },
13794 "items": {
13795 "items": {
13796 "$ref": "#/components/schemas/SearchExploreItem"
13797 },
13798 "type": "array"
13799 }
13800 },
13801 "required": [
13802 "fieldName",
13803 "items"
13804 ],
13805 "type": "object"
13806 },
13807 "SearchFacetCountResponseDto": {
13808 "properties": {
13809 "count": {
13810 "type": "integer"
13811 },
13812 "value": {
13813 "type": "string"
13814 }
13815 },
13816 "required": [
13817 "count",
13818 "value"
13819 ],
13820 "type": "object"
13821 },
13822 "SearchFacetResponseDto": {
13823 "properties": {
13824 "counts": {
13825 "items": {
13826 "$ref": "#/components/schemas/SearchFacetCountResponseDto"
13827 },
13828 "type": "array"
13829 },
13830 "fieldName": {
13831 "type": "string"
13832 }
13833 },
13834 "required": [
13835 "counts",
13836 "fieldName"
13837 ],
13838 "type": "object"
13839 },
13840 "SearchResponseDto": {
13841 "properties": {
13842 "albums": {
13843 "$ref": "#/components/schemas/SearchAlbumResponseDto"
13844 },
13845 "assets": {
13846 "$ref": "#/components/schemas/SearchAssetResponseDto"
13847 }
13848 },
13849 "required": [
13850 "albums",
13851 "assets"
13852 ],
13853 "type": "object"
13854 },
13855 "SearchStatisticsResponseDto": {
13856 "properties": {
13857 "total": {
13858 "type": "integer"
13859 }
13860 },
13861 "required": [
13862 "total"
13863 ],
13864 "type": "object"
13865 },
13866 "SearchSuggestionType": {
13867 "enum": [
13868 "country",
13869 "state",
13870 "city",
13871 "camera-make",
13872 "camera-model"
13873 ],
13874 "type": "string"
13875 },
13876 "ServerAboutResponseDto": {
13877 "properties": {
13878 "build": {
13879 "type": "string"
13880 },
13881 "buildImage": {
13882 "type": "string"
13883 },
13884 "buildImageUrl": {
13885 "type": "string"
13886 },
13887 "buildUrl": {
13888 "type": "string"
13889 },
13890 "exiftool": {
13891 "type": "string"
13892 },
13893 "ffmpeg": {
13894 "type": "string"
13895 },
13896 "imagemagick": {
13897 "type": "string"
13898 },
13899 "libvips": {
13900 "type": "string"
13901 },
13902 "licensed": {
13903 "type": "boolean"
13904 },
13905 "nodejs": {
13906 "type": "string"
13907 },
13908 "repository": {
13909 "type": "string"
13910 },
13911 "repositoryUrl": {
13912 "type": "string"
13913 },
13914 "sourceCommit": {
13915 "type": "string"
13916 },
13917 "sourceRef": {
13918 "type": "string"
13919 },
13920 "sourceUrl": {
13921 "type": "string"
13922 },
13923 "thirdPartyBugFeatureUrl": {
13924 "type": "string"
13925 },
13926 "thirdPartyDocumentationUrl": {
13927 "type": "string"
13928 },
13929 "thirdPartySourceUrl": {
13930 "type": "string"
13931 },
13932 "thirdPartySupportUrl": {
13933 "type": "string"
13934 },
13935 "version": {
13936 "type": "string"
13937 },
13938 "versionUrl": {
13939 "type": "string"
13940 }
13941 },
13942 "required": [
13943 "licensed",
13944 "version",
13945 "versionUrl"
13946 ],
13947 "type": "object"
13948 },
13949 "ServerApkLinksDto": {
13950 "properties": {
13951 "arm64v8a": {
13952 "type": "string"
13953 },
13954 "armeabiv7a": {
13955 "type": "string"
13956 },
13957 "universal": {
13958 "type": "string"
13959 },
13960 "x86_64": {
13961 "type": "string"
13962 }
13963 },
13964 "required": [
13965 "arm64v8a",
13966 "armeabiv7a",
13967 "universal",
13968 "x86_64"
13969 ],
13970 "type": "object"
13971 },
13972 "ServerConfigDto": {
13973 "properties": {
13974 "externalDomain": {
13975 "type": "string"
13976 },
13977 "isInitialized": {
13978 "type": "boolean"
13979 },
13980 "isOnboarded": {
13981 "type": "boolean"
13982 },
13983 "loginPageMessage": {
13984 "type": "string"
13985 },
13986 "mapDarkStyleUrl": {
13987 "type": "string"
13988 },
13989 "mapLightStyleUrl": {
13990 "type": "string"
13991 },
13992 "oauthButtonText": {
13993 "type": "string"
13994 },
13995 "publicUsers": {
13996 "type": "boolean"
13997 },
13998 "trashDays": {
13999 "type": "integer"
14000 },
14001 "userDeleteDelay": {
14002 "type": "integer"
14003 }
14004 },
14005 "required": [
14006 "externalDomain",
14007 "isInitialized",
14008 "isOnboarded",
14009 "loginPageMessage",
14010 "mapDarkStyleUrl",
14011 "mapLightStyleUrl",
14012 "oauthButtonText",
14013 "publicUsers",
14014 "trashDays",
14015 "userDeleteDelay"
14016 ],
14017 "type": "object"
14018 },
14019 "ServerFeaturesDto": {
14020 "properties": {
14021 "configFile": {
14022 "type": "boolean"
14023 },
14024 "duplicateDetection": {
14025 "type": "boolean"
14026 },
14027 "email": {
14028 "type": "boolean"
14029 },
14030 "facialRecognition": {
14031 "type": "boolean"
14032 },
14033 "importFaces": {
14034 "type": "boolean"
14035 },
14036 "map": {
14037 "type": "boolean"
14038 },
14039 "oauth": {
14040 "type": "boolean"
14041 },
14042 "oauthAutoLaunch": {
14043 "type": "boolean"
14044 },
14045 "passwordLogin": {
14046 "type": "boolean"
14047 },
14048 "reverseGeocoding": {
14049 "type": "boolean"
14050 },
14051 "search": {
14052 "type": "boolean"
14053 },
14054 "sidecar": {
14055 "type": "boolean"
14056 },
14057 "smartSearch": {
14058 "type": "boolean"
14059 },
14060 "trash": {
14061 "type": "boolean"
14062 }
14063 },
14064 "required": [
14065 "configFile",
14066 "duplicateDetection",
14067 "email",
14068 "facialRecognition",
14069 "importFaces",
14070 "map",
14071 "oauth",
14072 "oauthAutoLaunch",
14073 "passwordLogin",
14074 "reverseGeocoding",
14075 "search",
14076 "sidecar",
14077 "smartSearch",
14078 "trash"
14079 ],
14080 "type": "object"
14081 },
14082 "ServerMediaTypesResponseDto": {
14083 "properties": {
14084 "image": {
14085 "items": {
14086 "type": "string"
14087 },
14088 "type": "array"
14089 },
14090 "sidecar": {
14091 "items": {
14092 "type": "string"
14093 },
14094 "type": "array"
14095 },
14096 "video": {
14097 "items": {
14098 "type": "string"
14099 },
14100 "type": "array"
14101 }
14102 },
14103 "required": [
14104 "image",
14105 "sidecar",
14106 "video"
14107 ],
14108 "type": "object"
14109 },
14110 "ServerPingResponse": {
14111 "properties": {
14112 "res": {
14113 "example": "pong",
14114 "readOnly": true,
14115 "type": "string"
14116 }
14117 },
14118 "required": [
14119 "res"
14120 ],
14121 "type": "object"
14122 },
14123 "ServerStatsResponseDto": {
14124 "properties": {
14125 "photos": {
14126 "default": 0,
14127 "type": "integer"
14128 },
14129 "usage": {
14130 "default": 0,
14131 "format": "int64",
14132 "type": "integer"
14133 },
14134 "usageByUser": {
14135 "default": [],
14136 "example": [
14137 {
14138 "photos": 1,
14139 "videos": 1,
14140 "diskUsageRaw": 2,
14141 "usagePhotos": 1,
14142 "usageVideos": 1
14143 }
14144 ],
14145 "items": {
14146 "$ref": "#/components/schemas/UsageByUserDto"
14147 },
14148 "title": "Array of usage for each user",
14149 "type": "array"
14150 },
14151 "usagePhotos": {
14152 "default": 0,
14153 "format": "int64",
14154 "type": "integer"
14155 },
14156 "usageVideos": {
14157 "default": 0,
14158 "format": "int64",
14159 "type": "integer"
14160 },
14161 "videos": {
14162 "default": 0,
14163 "type": "integer"
14164 }
14165 },
14166 "required": [
14167 "photos",
14168 "usage",
14169 "usageByUser",
14170 "usagePhotos",
14171 "usageVideos",
14172 "videos"
14173 ],
14174 "type": "object"
14175 },
14176 "ServerStorageResponseDto": {
14177 "properties": {
14178 "diskAvailable": {
14179 "type": "string"
14180 },
14181 "diskAvailableRaw": {
14182 "format": "int64",
14183 "type": "integer"
14184 },
14185 "diskSize": {
14186 "type": "string"
14187 },
14188 "diskSizeRaw": {
14189 "format": "int64",
14190 "type": "integer"
14191 },
14192 "diskUsagePercentage": {
14193 "format": "double",
14194 "type": "number"
14195 },
14196 "diskUse": {
14197 "type": "string"
14198 },
14199 "diskUseRaw": {
14200 "format": "int64",
14201 "type": "integer"
14202 }
14203 },
14204 "required": [
14205 "diskAvailable",
14206 "diskAvailableRaw",
14207 "diskSize",
14208 "diskSizeRaw",
14209 "diskUsagePercentage",
14210 "diskUse",
14211 "diskUseRaw"
14212 ],
14213 "type": "object"
14214 },
14215 "ServerThemeDto": {
14216 "properties": {
14217 "customCss": {
14218 "type": "string"
14219 }
14220 },
14221 "required": [
14222 "customCss"
14223 ],
14224 "type": "object"
14225 },
14226 "ServerVersionHistoryResponseDto": {
14227 "properties": {
14228 "createdAt": {
14229 "format": "date-time",
14230 "type": "string"
14231 },
14232 "id": {
14233 "type": "string"
14234 },
14235 "version": {
14236 "type": "string"
14237 }
14238 },
14239 "required": [
14240 "createdAt",
14241 "id",
14242 "version"
14243 ],
14244 "type": "object"
14245 },
14246 "ServerVersionResponseDto": {
14247 "properties": {
14248 "major": {
14249 "type": "integer"
14250 },
14251 "minor": {
14252 "type": "integer"
14253 },
14254 "patch": {
14255 "type": "integer"
14256 }
14257 },
14258 "required": [
14259 "major",
14260 "minor",
14261 "patch"
14262 ],
14263 "type": "object"
14264 },
14265 "SessionCreateDto": {
14266 "properties": {
14267 "deviceOS": {
14268 "type": "string"
14269 },
14270 "deviceType": {
14271 "type": "string"
14272 },
14273 "duration": {
14274 "description": "session duration, in seconds",
14275 "minimum": 1,
14276 "type": "number"
14277 }
14278 },
14279 "type": "object"
14280 },
14281 "SessionCreateResponseDto": {
14282 "properties": {
14283 "createdAt": {
14284 "type": "string"
14285 },
14286 "current": {
14287 "type": "boolean"
14288 },
14289 "deviceOS": {
14290 "type": "string"
14291 },
14292 "deviceType": {
14293 "type": "string"
14294 },
14295 "expiresAt": {
14296 "type": "string"
14297 },
14298 "id": {
14299 "type": "string"
14300 },
14301 "isPendingSyncReset": {
14302 "type": "boolean"
14303 },
14304 "token": {
14305 "type": "string"
14306 },
14307 "updatedAt": {
14308 "type": "string"
14309 }
14310 },
14311 "required": [
14312 "createdAt",
14313 "current",
14314 "deviceOS",
14315 "deviceType",
14316 "id",
14317 "isPendingSyncReset",
14318 "token",
14319 "updatedAt"
14320 ],
14321 "type": "object"
14322 },
14323 "SessionResponseDto": {
14324 "properties": {
14325 "createdAt": {
14326 "type": "string"
14327 },
14328 "current": {
14329 "type": "boolean"
14330 },
14331 "deviceOS": {
14332 "type": "string"
14333 },
14334 "deviceType": {
14335 "type": "string"
14336 },
14337 "expiresAt": {
14338 "type": "string"
14339 },
14340 "id": {
14341 "type": "string"
14342 },
14343 "isPendingSyncReset": {
14344 "type": "boolean"
14345 },
14346 "updatedAt": {
14347 "type": "string"
14348 }
14349 },
14350 "required": [
14351 "createdAt",
14352 "current",
14353 "deviceOS",
14354 "deviceType",
14355 "id",
14356 "isPendingSyncReset",
14357 "updatedAt"
14358 ],
14359 "type": "object"
14360 },
14361 "SessionUnlockDto": {
14362 "properties": {
14363 "password": {
14364 "type": "string"
14365 },
14366 "pinCode": {
14367 "example": "123456",
14368 "type": "string"
14369 }
14370 },
14371 "type": "object"
14372 },
14373 "SessionUpdateDto": {
14374 "properties": {
14375 "isPendingSyncReset": {
14376 "type": "boolean"
14377 }
14378 },
14379 "type": "object"
14380 },
14381 "SharedLinkCreateDto": {
14382 "properties": {
14383 "albumId": {
14384 "format": "uuid",
14385 "type": "string"
14386 },
14387 "allowDownload": {
14388 "default": true,
14389 "type": "boolean"
14390 },
14391 "allowUpload": {
14392 "type": "boolean"
14393 },
14394 "assetIds": {
14395 "items": {
14396 "format": "uuid",
14397 "type": "string"
14398 },
14399 "type": "array"
14400 },
14401 "description": {
14402 "nullable": true,
14403 "type": "string"
14404 },
14405 "expiresAt": {
14406 "default": null,
14407 "format": "date-time",
14408 "nullable": true,
14409 "type": "string"
14410 },
14411 "password": {
14412 "nullable": true,
14413 "type": "string"
14414 },
14415 "showMetadata": {
14416 "default": true,
14417 "type": "boolean"
14418 },
14419 "slug": {
14420 "nullable": true,
14421 "type": "string"
14422 },
14423 "type": {
14424 "allOf": [
14425 {
14426 "$ref": "#/components/schemas/SharedLinkType"
14427 }
14428 ]
14429 }
14430 },
14431 "required": [
14432 "type"
14433 ],
14434 "type": "object"
14435 },
14436 "SharedLinkEditDto": {
14437 "properties": {
14438 "allowDownload": {
14439 "type": "boolean"
14440 },
14441 "allowUpload": {
14442 "type": "boolean"
14443 },
14444 "changeExpiryTime": {
14445 "description": "Few clients cannot send null to set the expiryTime to never.\nSetting this flag and not sending expiryAt is considered as null instead.\nClients that can send null values can ignore this.",
14446 "type": "boolean"
14447 },
14448 "description": {
14449 "nullable": true,
14450 "type": "string"
14451 },
14452 "expiresAt": {
14453 "format": "date-time",
14454 "nullable": true,
14455 "type": "string"
14456 },
14457 "password": {
14458 "nullable": true,
14459 "type": "string"
14460 },
14461 "showMetadata": {
14462 "type": "boolean"
14463 },
14464 "slug": {
14465 "nullable": true,
14466 "type": "string"
14467 }
14468 },
14469 "type": "object"
14470 },
14471 "SharedLinkResponseDto": {
14472 "properties": {
14473 "album": {
14474 "$ref": "#/components/schemas/AlbumResponseDto"
14475 },
14476 "allowDownload": {
14477 "type": "boolean"
14478 },
14479 "allowUpload": {
14480 "type": "boolean"
14481 },
14482 "assets": {
14483 "items": {
14484 "$ref": "#/components/schemas/AssetResponseDto"
14485 },
14486 "type": "array"
14487 },
14488 "createdAt": {
14489 "format": "date-time",
14490 "type": "string"
14491 },
14492 "description": {
14493 "nullable": true,
14494 "type": "string"
14495 },
14496 "expiresAt": {
14497 "format": "date-time",
14498 "nullable": true,
14499 "type": "string"
14500 },
14501 "id": {
14502 "type": "string"
14503 },
14504 "key": {
14505 "type": "string"
14506 },
14507 "password": {
14508 "nullable": true,
14509 "type": "string"
14510 },
14511 "showMetadata": {
14512 "type": "boolean"
14513 },
14514 "slug": {
14515 "nullable": true,
14516 "type": "string"
14517 },
14518 "token": {
14519 "nullable": true,
14520 "type": "string"
14521 },
14522 "type": {
14523 "allOf": [
14524 {
14525 "$ref": "#/components/schemas/SharedLinkType"
14526 }
14527 ]
14528 },
14529 "userId": {
14530 "type": "string"
14531 }
14532 },
14533 "required": [
14534 "allowDownload",
14535 "allowUpload",
14536 "assets",
14537 "createdAt",
14538 "description",
14539 "expiresAt",
14540 "id",
14541 "key",
14542 "password",
14543 "showMetadata",
14544 "slug",
14545 "type",
14546 "userId"
14547 ],
14548 "type": "object"
14549 },
14550 "SharedLinkType": {
14551 "enum": [
14552 "ALBUM",
14553 "INDIVIDUAL"
14554 ],
14555 "type": "string"
14556 },
14557 "SharedLinksResponse": {
14558 "properties": {
14559 "enabled": {
14560 "default": true,
14561 "type": "boolean"
14562 },
14563 "sidebarWeb": {
14564 "default": false,
14565 "type": "boolean"
14566 }
14567 },
14568 "required": [
14569 "enabled",
14570 "sidebarWeb"
14571 ],
14572 "type": "object"
14573 },
14574 "SharedLinksUpdate": {
14575 "properties": {
14576 "enabled": {
14577 "type": "boolean"
14578 },
14579 "sidebarWeb": {
14580 "type": "boolean"
14581 }
14582 },
14583 "type": "object"
14584 },
14585 "SignUpDto": {
14586 "properties": {
14587 "email": {
14588 "example": "[email protected]",
14589 "format": "email",
14590 "type": "string"
14591 },
14592 "name": {
14593 "example": "Admin",
14594 "type": "string"
14595 },
14596 "password": {
14597 "example": "password",
14598 "type": "string"
14599 }
14600 },
14601 "required": [
14602 "email",
14603 "name",
14604 "password"
14605 ],
14606 "type": "object"
14607 },
14608 "SmartSearchDto": {
14609 "properties": {
14610 "albumIds": {
14611 "items": {
14612 "format": "uuid",
14613 "type": "string"
14614 },
14615 "type": "array"
14616 },
14617 "city": {
14618 "nullable": true,
14619 "type": "string"
14620 },
14621 "country": {
14622 "nullable": true,
14623 "type": "string"
14624 },
14625 "createdAfter": {
14626 "format": "date-time",
14627 "type": "string"
14628 },
14629 "createdBefore": {
14630 "format": "date-time",
14631 "type": "string"
14632 },
14633 "deviceId": {
14634 "type": "string"
14635 },
14636 "isEncoded": {
14637 "type": "boolean"
14638 },
14639 "isFavorite": {
14640 "type": "boolean"
14641 },
14642 "isMotion": {
14643 "type": "boolean"
14644 },
14645 "isNotInAlbum": {
14646 "type": "boolean"
14647 },
14648 "isOffline": {
14649 "type": "boolean"
14650 },
14651 "language": {
14652 "type": "string"
14653 },
14654 "lensModel": {
14655 "nullable": true,
14656 "type": "string"
14657 },
14658 "libraryId": {
14659 "format": "uuid",
14660 "nullable": true,
14661 "type": "string"
14662 },
14663 "make": {
14664 "type": "string"
14665 },
14666 "model": {
14667 "nullable": true,
14668 "type": "string"
14669 },
14670 "page": {
14671 "minimum": 1,
14672 "type": "number"
14673 },
14674 "personIds": {
14675 "items": {
14676 "format": "uuid",
14677 "type": "string"
14678 },
14679 "type": "array"
14680 },
14681 "query": {
14682 "type": "string"
14683 },
14684 "queryAssetId": {
14685 "format": "uuid",
14686 "type": "string"
14687 },
14688 "rating": {
14689 "maximum": 5,
14690 "minimum": -1,
14691 "type": "number"
14692 },
14693 "size": {
14694 "maximum": 1000,
14695 "minimum": 1,
14696 "type": "number"
14697 },
14698 "state": {
14699 "nullable": true,
14700 "type": "string"
14701 },
14702 "tagIds": {
14703 "items": {
14704 "format": "uuid",
14705 "type": "string"
14706 },
14707 "nullable": true,
14708 "type": "array"
14709 },
14710 "takenAfter": {
14711 "format": "date-time",
14712 "type": "string"
14713 },
14714 "takenBefore": {
14715 "format": "date-time",
14716 "type": "string"
14717 },
14718 "trashedAfter": {
14719 "format": "date-time",
14720 "type": "string"
14721 },
14722 "trashedBefore": {
14723 "format": "date-time",
14724 "type": "string"
14725 },
14726 "type": {
14727 "allOf": [
14728 {
14729 "$ref": "#/components/schemas/AssetTypeEnum"
14730 }
14731 ]
14732 },
14733 "updatedAfter": {
14734 "format": "date-time",
14735 "type": "string"
14736 },
14737 "updatedBefore": {
14738 "format": "date-time",
14739 "type": "string"
14740 },
14741 "visibility": {
14742 "allOf": [
14743 {
14744 "$ref": "#/components/schemas/AssetVisibility"
14745 }
14746 ]
14747 },
14748 "withDeleted": {
14749 "type": "boolean"
14750 },
14751 "withExif": {
14752 "type": "boolean"
14753 }
14754 },
14755 "type": "object"
14756 },
14757 "SourceType": {
14758 "enum": [
14759 "machine-learning",
14760 "exif",
14761 "manual"
14762 ],
14763 "type": "string"
14764 },
14765 "StackCreateDto": {
14766 "properties": {
14767 "assetIds": {
14768 "description": "first asset becomes the primary",
14769 "items": {
14770 "format": "uuid",
14771 "type": "string"
14772 },
14773 "minItems": 2,
14774 "type": "array"
14775 }
14776 },
14777 "required": [
14778 "assetIds"
14779 ],
14780 "type": "object"
14781 },
14782 "StackResponseDto": {
14783 "properties": {
14784 "assets": {
14785 "items": {
14786 "$ref": "#/components/schemas/AssetResponseDto"
14787 },
14788 "type": "array"
14789 },
14790 "id": {
14791 "type": "string"
14792 },
14793 "primaryAssetId": {
14794 "type": "string"
14795 }
14796 },
14797 "required": [
14798 "assets",
14799 "id",
14800 "primaryAssetId"
14801 ],
14802 "type": "object"
14803 },
14804 "StackUpdateDto": {
14805 "properties": {
14806 "primaryAssetId": {
14807 "format": "uuid",
14808 "type": "string"
14809 }
14810 },
14811 "type": "object"
14812 },
14813 "StatisticsSearchDto": {
14814 "properties": {
14815 "albumIds": {
14816 "items": {
14817 "format": "uuid",
14818 "type": "string"
14819 },
14820 "type": "array"
14821 },
14822 "city": {
14823 "nullable": true,
14824 "type": "string"
14825 },
14826 "country": {
14827 "nullable": true,
14828 "type": "string"
14829 },
14830 "createdAfter": {
14831 "format": "date-time",
14832 "type": "string"
14833 },
14834 "createdBefore": {
14835 "format": "date-time",
14836 "type": "string"
14837 },
14838 "description": {
14839 "type": "string"
14840 },
14841 "deviceId": {
14842 "type": "string"
14843 },
14844 "isEncoded": {
14845 "type": "boolean"
14846 },
14847 "isFavorite": {
14848 "type": "boolean"
14849 },
14850 "isMotion": {
14851 "type": "boolean"
14852 },
14853 "isNotInAlbum": {
14854 "type": "boolean"
14855 },
14856 "isOffline": {
14857 "type": "boolean"
14858 },
14859 "lensModel": {
14860 "nullable": true,
14861 "type": "string"
14862 },
14863 "libraryId": {
14864 "format": "uuid",
14865 "nullable": true,
14866 "type": "string"
14867 },
14868 "make": {
14869 "type": "string"
14870 },
14871 "model": {
14872 "nullable": true,
14873 "type": "string"
14874 },
14875 "personIds": {
14876 "items": {
14877 "format": "uuid",
14878 "type": "string"
14879 },
14880 "type": "array"
14881 },
14882 "rating": {
14883 "maximum": 5,
14884 "minimum": -1,
14885 "type": "number"
14886 },
14887 "state": {
14888 "nullable": true,
14889 "type": "string"
14890 },
14891 "tagIds": {
14892 "items": {
14893 "format": "uuid",
14894 "type": "string"
14895 },
14896 "nullable": true,
14897 "type": "array"
14898 },
14899 "takenAfter": {
14900 "format": "date-time",
14901 "type": "string"
14902 },
14903 "takenBefore": {
14904 "format": "date-time",
14905 "type": "string"
14906 },
14907 "trashedAfter": {
14908 "format": "date-time",
14909 "type": "string"
14910 },
14911 "trashedBefore": {
14912 "format": "date-time",
14913 "type": "string"
14914 },
14915 "type": {
14916 "allOf": [
14917 {
14918 "$ref": "#/components/schemas/AssetTypeEnum"
14919 }
14920 ]
14921 },
14922 "updatedAfter": {
14923 "format": "date-time",
14924 "type": "string"
14925 },
14926 "updatedBefore": {
14927 "format": "date-time",
14928 "type": "string"
14929 },
14930 "visibility": {
14931 "allOf": [
14932 {
14933 "$ref": "#/components/schemas/AssetVisibility"
14934 }
14935 ]
14936 }
14937 },
14938 "type": "object"
14939 },
14940 "SyncAckDeleteDto": {
14941 "properties": {
14942 "types": {
14943 "items": {
14944 "$ref": "#/components/schemas/SyncEntityType"
14945 },
14946 "type": "array"
14947 }
14948 },
14949 "type": "object"
14950 },
14951 "SyncAckDto": {
14952 "properties": {
14953 "ack": {
14954 "type": "string"
14955 },
14956 "type": {
14957 "allOf": [
14958 {
14959 "$ref": "#/components/schemas/SyncEntityType"
14960 }
14961 ]
14962 }
14963 },
14964 "required": [
14965 "ack",
14966 "type"
14967 ],
14968 "type": "object"
14969 },
14970 "SyncAckSetDto": {
14971 "properties": {
14972 "acks": {
14973 "items": {
14974 "type": "string"
14975 },
14976 "maxItems": 1000,
14977 "type": "array"
14978 }
14979 },
14980 "required": [
14981 "acks"
14982 ],
14983 "type": "object"
14984 },
14985 "SyncAckV1": {
14986 "properties": {},
14987 "type": "object"
14988 },
14989 "SyncAlbumDeleteV1": {
14990 "properties": {
14991 "albumId": {
14992 "type": "string"
14993 }
14994 },
14995 "required": [
14996 "albumId"
14997 ],
14998 "type": "object"
14999 },
15000 "SyncAlbumToAssetDeleteV1": {
15001 "properties": {
15002 "albumId": {
15003 "type": "string"
15004 },
15005 "assetId": {
15006 "type": "string"
15007 }
15008 },
15009 "required": [
15010 "albumId",
15011 "assetId"
15012 ],
15013 "type": "object"
15014 },
15015 "SyncAlbumToAssetV1": {
15016 "properties": {
15017 "albumId": {
15018 "type": "string"
15019 },
15020 "assetId": {
15021 "type": "string"
15022 }
15023 },
15024 "required": [
15025 "albumId",
15026 "assetId"
15027 ],
15028 "type": "object"
15029 },
15030 "SyncAlbumUserDeleteV1": {
15031 "properties": {
15032 "albumId": {
15033 "type": "string"
15034 },
15035 "userId": {
15036 "type": "string"
15037 }
15038 },
15039 "required": [
15040 "albumId",
15041 "userId"
15042 ],
15043 "type": "object"
15044 },
15045 "SyncAlbumUserV1": {
15046 "properties": {
15047 "albumId": {
15048 "type": "string"
15049 },
15050 "role": {
15051 "allOf": [
15052 {
15053 "$ref": "#/components/schemas/AlbumUserRole"
15054 }
15055 ]
15056 },
15057 "userId": {
15058 "type": "string"
15059 }
15060 },
15061 "required": [
15062 "albumId",
15063 "role",
15064 "userId"
15065 ],
15066 "type": "object"
15067 },
15068 "SyncAlbumV1": {
15069 "properties": {
15070 "createdAt": {
15071 "format": "date-time",
15072 "type": "string"
15073 },
15074 "description": {
15075 "type": "string"
15076 },
15077 "id": {
15078 "type": "string"
15079 },
15080 "isActivityEnabled": {
15081 "type": "boolean"
15082 },
15083 "name": {
15084 "type": "string"
15085 },
15086 "order": {
15087 "allOf": [
15088 {
15089 "$ref": "#/components/schemas/AssetOrder"
15090 }
15091 ]
15092 },
15093 "ownerId": {
15094 "type": "string"
15095 },
15096 "thumbnailAssetId": {
15097 "nullable": true,
15098 "type": "string"
15099 },
15100 "updatedAt": {
15101 "format": "date-time",
15102 "type": "string"
15103 }
15104 },
15105 "required": [
15106 "createdAt",
15107 "description",
15108 "id",
15109 "isActivityEnabled",
15110 "name",
15111 "order",
15112 "ownerId",
15113 "thumbnailAssetId",
15114 "updatedAt"
15115 ],
15116 "type": "object"
15117 },
15118 "SyncAssetDeleteV1": {
15119 "properties": {
15120 "assetId": {
15121 "type": "string"
15122 }
15123 },
15124 "required": [
15125 "assetId"
15126 ],
15127 "type": "object"
15128 },
15129 "SyncAssetExifV1": {
15130 "properties": {
15131 "assetId": {
15132 "type": "string"
15133 },
15134 "city": {
15135 "nullable": true,
15136 "type": "string"
15137 },
15138 "country": {
15139 "nullable": true,
15140 "type": "string"
15141 },
15142 "dateTimeOriginal": {
15143 "format": "date-time",
15144 "nullable": true,
15145 "type": "string"
15146 },
15147 "description": {
15148 "nullable": true,
15149 "type": "string"
15150 },
15151 "exifImageHeight": {
15152 "nullable": true,
15153 "type": "integer"
15154 },
15155 "exifImageWidth": {
15156 "nullable": true,
15157 "type": "integer"
15158 },
15159 "exposureTime": {
15160 "nullable": true,
15161 "type": "string"
15162 },
15163 "fNumber": {
15164 "format": "double",
15165 "nullable": true,
15166 "type": "number"
15167 },
15168 "fileSizeInByte": {
15169 "nullable": true,
15170 "type": "integer"
15171 },
15172 "focalLength": {
15173 "format": "double",
15174 "nullable": true,
15175 "type": "number"
15176 },
15177 "fps": {
15178 "format": "double",
15179 "nullable": true,
15180 "type": "number"
15181 },
15182 "iso": {
15183 "nullable": true,
15184 "type": "integer"
15185 },
15186 "latitude": {
15187 "format": "double",
15188 "nullable": true,
15189 "type": "number"
15190 },
15191 "lensModel": {
15192 "nullable": true,
15193 "type": "string"
15194 },
15195 "longitude": {
15196 "format": "double",
15197 "nullable": true,
15198 "type": "number"
15199 },
15200 "make": {
15201 "nullable": true,
15202 "type": "string"
15203 },
15204 "model": {
15205 "nullable": true,
15206 "type": "string"
15207 },
15208 "modifyDate": {
15209 "format": "date-time",
15210 "nullable": true,
15211 "type": "string"
15212 },
15213 "orientation": {
15214 "nullable": true,
15215 "type": "string"
15216 },
15217 "profileDescription": {
15218 "nullable": true,
15219 "type": "string"
15220 },
15221 "projectionType": {
15222 "nullable": true,
15223 "type": "string"
15224 },
15225 "rating": {
15226 "nullable": true,
15227 "type": "integer"
15228 },
15229 "state": {
15230 "nullable": true,
15231 "type": "string"
15232 },
15233 "timeZone": {
15234 "nullable": true,
15235 "type": "string"
15236 }
15237 },
15238 "required": [
15239 "assetId",
15240 "city",
15241 "country",
15242 "dateTimeOriginal",
15243 "description",
15244 "exifImageHeight",
15245 "exifImageWidth",
15246 "exposureTime",
15247 "fNumber",
15248 "fileSizeInByte",
15249 "focalLength",
15250 "fps",
15251 "iso",
15252 "latitude",
15253 "lensModel",
15254 "longitude",
15255 "make",
15256 "model",
15257 "modifyDate",
15258 "orientation",
15259 "profileDescription",
15260 "projectionType",
15261 "rating",
15262 "state",
15263 "timeZone"
15264 ],
15265 "type": "object"
15266 },
15267 "SyncAssetFaceDeleteV1": {
15268 "properties": {
15269 "assetFaceId": {
15270 "type": "string"
15271 }
15272 },
15273 "required": [
15274 "assetFaceId"
15275 ],
15276 "type": "object"
15277 },
15278 "SyncAssetFaceV1": {
15279 "properties": {
15280 "assetId": {
15281 "type": "string"
15282 },
15283 "boundingBoxX1": {
15284 "type": "integer"
15285 },
15286 "boundingBoxX2": {
15287 "type": "integer"
15288 },
15289 "boundingBoxY1": {
15290 "type": "integer"
15291 },
15292 "boundingBoxY2": {
15293 "type": "integer"
15294 },
15295 "id": {
15296 "type": "string"
15297 },
15298 "imageHeight": {
15299 "type": "integer"
15300 },
15301 "imageWidth": {
15302 "type": "integer"
15303 },
15304 "personId": {
15305 "nullable": true,
15306 "type": "string"
15307 },
15308 "sourceType": {
15309 "type": "string"
15310 }
15311 },
15312 "required": [
15313 "assetId",
15314 "boundingBoxX1",
15315 "boundingBoxX2",
15316 "boundingBoxY1",
15317 "boundingBoxY2",
15318 "id",
15319 "imageHeight",
15320 "imageWidth",
15321 "personId",
15322 "sourceType"
15323 ],
15324 "type": "object"
15325 },
15326 "SyncAssetMetadataDeleteV1": {
15327 "properties": {
15328 "assetId": {
15329 "type": "string"
15330 },
15331 "key": {
15332 "allOf": [
15333 {
15334 "$ref": "#/components/schemas/AssetMetadataKey"
15335 }
15336 ]
15337 }
15338 },
15339 "required": [
15340 "assetId",
15341 "key"
15342 ],
15343 "type": "object"
15344 },
15345 "SyncAssetMetadataV1": {
15346 "properties": {
15347 "assetId": {
15348 "type": "string"
15349 },
15350 "key": {
15351 "allOf": [
15352 {
15353 "$ref": "#/components/schemas/AssetMetadataKey"
15354 }
15355 ]
15356 },
15357 "value": {
15358 "type": "object"
15359 }
15360 },
15361 "required": [
15362 "assetId",
15363 "key",
15364 "value"
15365 ],
15366 "type": "object"
15367 },
15368 "SyncAssetV1": {
15369 "properties": {
15370 "checksum": {
15371 "type": "string"
15372 },
15373 "deletedAt": {
15374 "format": "date-time",
15375 "nullable": true,
15376 "type": "string"
15377 },
15378 "duration": {
15379 "nullable": true,
15380 "type": "string"
15381 },
15382 "fileCreatedAt": {
15383 "format": "date-time",
15384 "nullable": true,
15385 "type": "string"
15386 },
15387 "fileModifiedAt": {
15388 "format": "date-time",
15389 "nullable": true,
15390 "type": "string"
15391 },
15392 "id": {
15393 "type": "string"
15394 },
15395 "isFavorite": {
15396 "type": "boolean"
15397 },
15398 "libraryId": {
15399 "nullable": true,
15400 "type": "string"
15401 },
15402 "livePhotoVideoId": {
15403 "nullable": true,
15404 "type": "string"
15405 },
15406 "localDateTime": {
15407 "format": "date-time",
15408 "nullable": true,
15409 "type": "string"
15410 },
15411 "originalFileName": {
15412 "type": "string"
15413 },
15414 "ownerId": {
15415 "type": "string"
15416 },
15417 "stackId": {
15418 "nullable": true,
15419 "type": "string"
15420 },
15421 "thumbhash": {
15422 "nullable": true,
15423 "type": "string"
15424 },
15425 "type": {
15426 "allOf": [
15427 {
15428 "$ref": "#/components/schemas/AssetTypeEnum"
15429 }
15430 ]
15431 },
15432 "visibility": {
15433 "allOf": [
15434 {
15435 "$ref": "#/components/schemas/AssetVisibility"
15436 }
15437 ]
15438 }
15439 },
15440 "required": [
15441 "checksum",
15442 "deletedAt",
15443 "duration",
15444 "fileCreatedAt",
15445 "fileModifiedAt",
15446 "id",
15447 "isFavorite",
15448 "libraryId",
15449 "livePhotoVideoId",
15450 "localDateTime",
15451 "originalFileName",
15452 "ownerId",
15453 "stackId",
15454 "thumbhash",
15455 "type",
15456 "visibility"
15457 ],
15458 "type": "object"
15459 },
15460 "SyncAuthUserV1": {
15461 "properties": {
15462 "avatarColor": {
15463 "allOf": [
15464 {
15465 "$ref": "#/components/schemas/UserAvatarColor"
15466 }
15467 ],
15468 "nullable": true
15469 },
15470 "deletedAt": {
15471 "format": "date-time",
15472 "nullable": true,
15473 "type": "string"
15474 },
15475 "email": {
15476 "type": "string"
15477 },
15478 "hasProfileImage": {
15479 "type": "boolean"
15480 },
15481 "id": {
15482 "type": "string"
15483 },
15484 "isAdmin": {
15485 "type": "boolean"
15486 },
15487 "name": {
15488 "type": "string"
15489 },
15490 "oauthId": {
15491 "type": "string"
15492 },
15493 "pinCode": {
15494 "nullable": true,
15495 "type": "string"
15496 },
15497 "profileChangedAt": {
15498 "format": "date-time",
15499 "type": "string"
15500 },
15501 "quotaSizeInBytes": {
15502 "nullable": true,
15503 "type": "integer"
15504 },
15505 "quotaUsageInBytes": {
15506 "type": "integer"
15507 },
15508 "storageLabel": {
15509 "nullable": true,
15510 "type": "string"
15511 }
15512 },
15513 "required": [
15514 "avatarColor",
15515 "deletedAt",
15516 "email",
15517 "hasProfileImage",
15518 "id",
15519 "isAdmin",
15520 "name",
15521 "oauthId",
15522 "pinCode",
15523 "profileChangedAt",
15524 "quotaSizeInBytes",
15525 "quotaUsageInBytes",
15526 "storageLabel"
15527 ],
15528 "type": "object"
15529 },
15530 "SyncCompleteV1": {
15531 "properties": {},
15532 "type": "object"
15533 },
15534 "SyncEntityType": {
15535 "enum": [
15536 "AuthUserV1",
15537 "UserV1",
15538 "UserDeleteV1",
15539 "AssetV1",
15540 "AssetDeleteV1",
15541 "AssetExifV1",
15542 "AssetMetadataV1",
15543 "AssetMetadataDeleteV1",
15544 "PartnerV1",
15545 "PartnerDeleteV1",
15546 "PartnerAssetV1",
15547 "PartnerAssetBackfillV1",
15548 "PartnerAssetDeleteV1",
15549 "PartnerAssetExifV1",
15550 "PartnerAssetExifBackfillV1",
15551 "PartnerStackBackfillV1",
15552 "PartnerStackDeleteV1",
15553 "PartnerStackV1",
15554 "AlbumV1",
15555 "AlbumDeleteV1",
15556 "AlbumUserV1",
15557 "AlbumUserBackfillV1",
15558 "AlbumUserDeleteV1",
15559 "AlbumAssetCreateV1",
15560 "AlbumAssetUpdateV1",
15561 "AlbumAssetBackfillV1",
15562 "AlbumAssetExifCreateV1",
15563 "AlbumAssetExifUpdateV1",
15564 "AlbumAssetExifBackfillV1",
15565 "AlbumToAssetV1",
15566 "AlbumToAssetDeleteV1",
15567 "AlbumToAssetBackfillV1",
15568 "MemoryV1",
15569 "MemoryDeleteV1",
15570 "MemoryToAssetV1",
15571 "MemoryToAssetDeleteV1",
15572 "StackV1",
15573 "StackDeleteV1",
15574 "PersonV1",
15575 "PersonDeleteV1",
15576 "AssetFaceV1",
15577 "AssetFaceDeleteV1",
15578 "UserMetadataV1",
15579 "UserMetadataDeleteV1",
15580 "SyncAckV1",
15581 "SyncResetV1",
15582 "SyncCompleteV1"
15583 ],
15584 "type": "string"
15585 },
15586 "SyncMemoryAssetDeleteV1": {
15587 "properties": {
15588 "assetId": {
15589 "type": "string"
15590 },
15591 "memoryId": {
15592 "type": "string"
15593 }
15594 },
15595 "required": [
15596 "assetId",
15597 "memoryId"
15598 ],
15599 "type": "object"
15600 },
15601 "SyncMemoryAssetV1": {
15602 "properties": {
15603 "assetId": {
15604 "type": "string"
15605 },
15606 "memoryId": {
15607 "type": "string"
15608 }
15609 },
15610 "required": [
15611 "assetId",
15612 "memoryId"
15613 ],
15614 "type": "object"
15615 },
15616 "SyncMemoryDeleteV1": {
15617 "properties": {
15618 "memoryId": {
15619 "type": "string"
15620 }
15621 },
15622 "required": [
15623 "memoryId"
15624 ],
15625 "type": "object"
15626 },
15627 "SyncMemoryV1": {
15628 "properties": {
15629 "createdAt": {
15630 "format": "date-time",
15631 "type": "string"
15632 },
15633 "data": {
15634 "type": "object"
15635 },
15636 "deletedAt": {
15637 "format": "date-time",
15638 "nullable": true,
15639 "type": "string"
15640 },
15641 "hideAt": {
15642 "format": "date-time",
15643 "nullable": true,
15644 "type": "string"
15645 },
15646 "id": {
15647 "type": "string"
15648 },
15649 "isSaved": {
15650 "type": "boolean"
15651 },
15652 "memoryAt": {
15653 "format": "date-time",
15654 "type": "string"
15655 },
15656 "ownerId": {
15657 "type": "string"
15658 },
15659 "seenAt": {
15660 "format": "date-time",
15661 "nullable": true,
15662 "type": "string"
15663 },
15664 "showAt": {
15665 "format": "date-time",
15666 "nullable": true,
15667 "type": "string"
15668 },
15669 "type": {
15670 "allOf": [
15671 {
15672 "$ref": "#/components/schemas/MemoryType"
15673 }
15674 ]
15675 },
15676 "updatedAt": {
15677 "format": "date-time",
15678 "type": "string"
15679 }
15680 },
15681 "required": [
15682 "createdAt",
15683 "data",
15684 "deletedAt",
15685 "hideAt",
15686 "id",
15687 "isSaved",
15688 "memoryAt",
15689 "ownerId",
15690 "seenAt",
15691 "showAt",
15692 "type",
15693 "updatedAt"
15694 ],
15695 "type": "object"
15696 },
15697 "SyncPartnerDeleteV1": {
15698 "properties": {
15699 "sharedById": {
15700 "type": "string"
15701 },
15702 "sharedWithId": {
15703 "type": "string"
15704 }
15705 },
15706 "required": [
15707 "sharedById",
15708 "sharedWithId"
15709 ],
15710 "type": "object"
15711 },
15712 "SyncPartnerV1": {
15713 "properties": {
15714 "inTimeline": {
15715 "type": "boolean"
15716 },
15717 "sharedById": {
15718 "type": "string"
15719 },
15720 "sharedWithId": {
15721 "type": "string"
15722 }
15723 },
15724 "required": [
15725 "inTimeline",
15726 "sharedById",
15727 "sharedWithId"
15728 ],
15729 "type": "object"
15730 },
15731 "SyncPersonDeleteV1": {
15732 "properties": {
15733 "personId": {
15734 "type": "string"
15735 }
15736 },
15737 "required": [
15738 "personId"
15739 ],
15740 "type": "object"
15741 },
15742 "SyncPersonV1": {
15743 "properties": {
15744 "birthDate": {
15745 "format": "date-time",
15746 "nullable": true,
15747 "type": "string"
15748 },
15749 "color": {
15750 "nullable": true,
15751 "type": "string"
15752 },
15753 "createdAt": {
15754 "format": "date-time",
15755 "type": "string"
15756 },
15757 "faceAssetId": {
15758 "nullable": true,
15759 "type": "string"
15760 },
15761 "id": {
15762 "type": "string"
15763 },
15764 "isFavorite": {
15765 "type": "boolean"
15766 },
15767 "isHidden": {
15768 "type": "boolean"
15769 },
15770 "name": {
15771 "type": "string"
15772 },
15773 "ownerId": {
15774 "type": "string"
15775 },
15776 "updatedAt": {
15777 "format": "date-time",
15778 "type": "string"
15779 }
15780 },
15781 "required": [
15782 "birthDate",
15783 "color",
15784 "createdAt",
15785 "faceAssetId",
15786 "id",
15787 "isFavorite",
15788 "isHidden",
15789 "name",
15790 "ownerId",
15791 "updatedAt"
15792 ],
15793 "type": "object"
15794 },
15795 "SyncRequestType": {
15796 "enum": [
15797 "AlbumsV1",
15798 "AlbumUsersV1",
15799 "AlbumToAssetsV1",
15800 "AlbumAssetsV1",
15801 "AlbumAssetExifsV1",
15802 "AssetsV1",
15803 "AssetExifsV1",
15804 "AssetMetadataV1",
15805 "AuthUsersV1",
15806 "MemoriesV1",
15807 "MemoryToAssetsV1",
15808 "PartnersV1",
15809 "PartnerAssetsV1",
15810 "PartnerAssetExifsV1",
15811 "PartnerStacksV1",
15812 "StacksV1",
15813 "UsersV1",
15814 "PeopleV1",
15815 "AssetFacesV1",
15816 "UserMetadataV1"
15817 ],
15818 "type": "string"
15819 },
15820 "SyncResetV1": {
15821 "properties": {},
15822 "type": "object"
15823 },
15824 "SyncStackDeleteV1": {
15825 "properties": {
15826 "stackId": {
15827 "type": "string"
15828 }
15829 },
15830 "required": [
15831 "stackId"
15832 ],
15833 "type": "object"
15834 },
15835 "SyncStackV1": {
15836 "properties": {
15837 "createdAt": {
15838 "format": "date-time",
15839 "type": "string"
15840 },
15841 "id": {
15842 "type": "string"
15843 },
15844 "ownerId": {
15845 "type": "string"
15846 },
15847 "primaryAssetId": {
15848 "type": "string"
15849 },
15850 "updatedAt": {
15851 "format": "date-time",
15852 "type": "string"
15853 }
15854 },
15855 "required": [
15856 "createdAt",
15857 "id",
15858 "ownerId",
15859 "primaryAssetId",
15860 "updatedAt"
15861 ],
15862 "type": "object"
15863 },
15864 "SyncStreamDto": {
15865 "properties": {
15866 "reset": {
15867 "type": "boolean"
15868 },
15869 "types": {
15870 "items": {
15871 "$ref": "#/components/schemas/SyncRequestType"
15872 },
15873 "type": "array"
15874 }
15875 },
15876 "required": [
15877 "types"
15878 ],
15879 "type": "object"
15880 },
15881 "SyncUserDeleteV1": {
15882 "properties": {
15883 "userId": {
15884 "type": "string"
15885 }
15886 },
15887 "required": [
15888 "userId"
15889 ],
15890 "type": "object"
15891 },
15892 "SyncUserMetadataDeleteV1": {
15893 "properties": {
15894 "key": {
15895 "allOf": [
15896 {
15897 "$ref": "#/components/schemas/UserMetadataKey"
15898 }
15899 ]
15900 },
15901 "userId": {
15902 "type": "string"
15903 }
15904 },
15905 "required": [
15906 "key",
15907 "userId"
15908 ],
15909 "type": "object"
15910 },
15911 "SyncUserMetadataV1": {
15912 "properties": {
15913 "key": {
15914 "allOf": [
15915 {
15916 "$ref": "#/components/schemas/UserMetadataKey"
15917 }
15918 ]
15919 },
15920 "userId": {
15921 "type": "string"
15922 },
15923 "value": {
15924 "type": "object"
15925 }
15926 },
15927 "required": [
15928 "key",
15929 "userId",
15930 "value"
15931 ],
15932 "type": "object"
15933 },
15934 "SyncUserV1": {
15935 "properties": {
15936 "avatarColor": {
15937 "allOf": [
15938 {
15939 "$ref": "#/components/schemas/UserAvatarColor"
15940 }
15941 ],
15942 "nullable": true
15943 },
15944 "deletedAt": {
15945 "format": "date-time",
15946 "nullable": true,
15947 "type": "string"
15948 },
15949 "email": {
15950 "type": "string"
15951 },
15952 "hasProfileImage": {
15953 "type": "boolean"
15954 },
15955 "id": {
15956 "type": "string"
15957 },
15958 "name": {
15959 "type": "string"
15960 },
15961 "profileChangedAt": {
15962 "format": "date-time",
15963 "type": "string"
15964 }
15965 },
15966 "required": [
15967 "avatarColor",
15968 "deletedAt",
15969 "email",
15970 "hasProfileImage",
15971 "id",
15972 "name",
15973 "profileChangedAt"
15974 ],
15975 "type": "object"
15976 },
15977 "SystemConfigBackupsDto": {
15978 "properties": {
15979 "database": {
15980 "$ref": "#/components/schemas/DatabaseBackupConfig"
15981 }
15982 },
15983 "required": [
15984 "database"
15985 ],
15986 "type": "object"
15987 },
15988 "SystemConfigDto": {
15989 "properties": {
15990 "backup": {
15991 "$ref": "#/components/schemas/SystemConfigBackupsDto"
15992 },
15993 "ffmpeg": {
15994 "$ref": "#/components/schemas/SystemConfigFFmpegDto"
15995 },
15996 "image": {
15997 "$ref": "#/components/schemas/SystemConfigImageDto"
15998 },
15999 "job": {
16000 "$ref": "#/components/schemas/SystemConfigJobDto"
16001 },
16002 "library": {
16003 "$ref": "#/components/schemas/SystemConfigLibraryDto"
16004 },
16005 "logging": {
16006 "$ref": "#/components/schemas/SystemConfigLoggingDto"
16007 },
16008 "machineLearning": {
16009 "$ref": "#/components/schemas/SystemConfigMachineLearningDto"
16010 },
16011 "map": {
16012 "$ref": "#/components/schemas/SystemConfigMapDto"
16013 },
16014 "metadata": {
16015 "$ref": "#/components/schemas/SystemConfigMetadataDto"
16016 },
16017 "newVersionCheck": {
16018 "$ref": "#/components/schemas/SystemConfigNewVersionCheckDto"
16019 },
16020 "nightlyTasks": {
16021 "$ref": "#/components/schemas/SystemConfigNightlyTasksDto"
16022 },
16023 "notifications": {
16024 "$ref": "#/components/schemas/SystemConfigNotificationsDto"
16025 },
16026 "oauth": {
16027 "$ref": "#/components/schemas/SystemConfigOAuthDto"
16028 },
16029 "passwordLogin": {
16030 "$ref": "#/components/schemas/SystemConfigPasswordLoginDto"
16031 },
16032 "reverseGeocoding": {
16033 "$ref": "#/components/schemas/SystemConfigReverseGeocodingDto"
16034 },
16035 "server": {
16036 "$ref": "#/components/schemas/SystemConfigServerDto"
16037 },
16038 "storageTemplate": {
16039 "$ref": "#/components/schemas/SystemConfigStorageTemplateDto"
16040 },
16041 "templates": {
16042 "$ref": "#/components/schemas/SystemConfigTemplatesDto"
16043 },
16044 "theme": {
16045 "$ref": "#/components/schemas/SystemConfigThemeDto"
16046 },
16047 "trash": {
16048 "$ref": "#/components/schemas/SystemConfigTrashDto"
16049 },
16050 "user": {
16051 "$ref": "#/components/schemas/SystemConfigUserDto"
16052 }
16053 },
16054 "required": [
16055 "backup",
16056 "ffmpeg",
16057 "image",
16058 "job",
16059 "library",
16060 "logging",
16061 "machineLearning",
16062 "map",
16063 "metadata",
16064 "newVersionCheck",
16065 "nightlyTasks",
16066 "notifications",
16067 "oauth",
16068 "passwordLogin",
16069 "reverseGeocoding",
16070 "server",
16071 "storageTemplate",
16072 "templates",
16073 "theme",
16074 "trash",
16075 "user"
16076 ],
16077 "type": "object"
16078 },
16079 "SystemConfigFFmpegDto": {
16080 "properties": {
16081 "accel": {
16082 "allOf": [
16083 {
16084 "$ref": "#/components/schemas/TranscodeHWAccel"
16085 }
16086 ]
16087 },
16088 "accelDecode": {
16089 "type": "boolean"
16090 },
16091 "acceptedAudioCodecs": {
16092 "items": {
16093 "$ref": "#/components/schemas/AudioCodec"
16094 },
16095 "type": "array"
16096 },
16097 "acceptedContainers": {
16098 "items": {
16099 "$ref": "#/components/schemas/VideoContainer"
16100 },
16101 "type": "array"
16102 },
16103 "acceptedVideoCodecs": {
16104 "items": {
16105 "$ref": "#/components/schemas/VideoCodec"
16106 },
16107 "type": "array"
16108 },
16109 "bframes": {
16110 "maximum": 16,
16111 "minimum": -1,
16112 "type": "integer"
16113 },
16114 "cqMode": {
16115 "allOf": [
16116 {
16117 "$ref": "#/components/schemas/CQMode"
16118 }
16119 ]
16120 },
16121 "crf": {
16122 "maximum": 51,
16123 "minimum": 0,
16124 "type": "integer"
16125 },
16126 "gopSize": {
16127 "minimum": 0,
16128 "type": "integer"
16129 },
16130 "maxBitrate": {
16131 "type": "string"
16132 },
16133 "preferredHwDevice": {
16134 "type": "string"
16135 },
16136 "preset": {
16137 "type": "string"
16138 },
16139 "refs": {
16140 "maximum": 6,
16141 "minimum": 0,
16142 "type": "integer"
16143 },
16144 "targetAudioCodec": {
16145 "allOf": [
16146 {
16147 "$ref": "#/components/schemas/AudioCodec"
16148 }
16149 ]
16150 },
16151 "targetResolution": {
16152 "type": "string"
16153 },
16154 "targetVideoCodec": {
16155 "allOf": [
16156 {
16157 "$ref": "#/components/schemas/VideoCodec"
16158 }
16159 ]
16160 },
16161 "temporalAQ": {
16162 "type": "boolean"
16163 },
16164 "threads": {
16165 "minimum": 0,
16166 "type": "integer"
16167 },
16168 "tonemap": {
16169 "allOf": [
16170 {
16171 "$ref": "#/components/schemas/ToneMapping"
16172 }
16173 ]
16174 },
16175 "transcode": {
16176 "allOf": [
16177 {
16178 "$ref": "#/components/schemas/TranscodePolicy"
16179 }
16180 ]
16181 },
16182 "twoPass": {
16183 "type": "boolean"
16184 }
16185 },
16186 "required": [
16187 "accel",
16188 "accelDecode",
16189 "acceptedAudioCodecs",
16190 "acceptedContainers",
16191 "acceptedVideoCodecs",
16192 "bframes",
16193 "cqMode",
16194 "crf",
16195 "gopSize",
16196 "maxBitrate",
16197 "preferredHwDevice",
16198 "preset",
16199 "refs",
16200 "targetAudioCodec",
16201 "targetResolution",
16202 "targetVideoCodec",
16203 "temporalAQ",
16204 "threads",
16205 "tonemap",
16206 "transcode",
16207 "twoPass"
16208 ],
16209 "type": "object"
16210 },
16211 "SystemConfigFacesDto": {
16212 "properties": {
16213 "import": {
16214 "type": "boolean"
16215 }
16216 },
16217 "required": [
16218 "import"
16219 ],
16220 "type": "object"
16221 },
16222 "SystemConfigGeneratedFullsizeImageDto": {
16223 "properties": {
16224 "enabled": {
16225 "type": "boolean"
16226 },
16227 "format": {
16228 "allOf": [
16229 {
16230 "$ref": "#/components/schemas/ImageFormat"
16231 }
16232 ]
16233 },
16234 "quality": {
16235 "maximum": 100,
16236 "minimum": 1,
16237 "type": "integer"
16238 }
16239 },
16240 "required": [
16241 "enabled",
16242 "format",
16243 "quality"
16244 ],
16245 "type": "object"
16246 },
16247 "SystemConfigGeneratedImageDto": {
16248 "properties": {
16249 "format": {
16250 "allOf": [
16251 {
16252 "$ref": "#/components/schemas/ImageFormat"
16253 }
16254 ]
16255 },
16256 "quality": {
16257 "maximum": 100,
16258 "minimum": 1,
16259 "type": "integer"
16260 },
16261 "size": {
16262 "minimum": 1,
16263 "type": "integer"
16264 }
16265 },
16266 "required": [
16267 "format",
16268 "quality",
16269 "size"
16270 ],
16271 "type": "object"
16272 },
16273 "SystemConfigImageDto": {
16274 "properties": {
16275 "colorspace": {
16276 "allOf": [
16277 {
16278 "$ref": "#/components/schemas/Colorspace"
16279 }
16280 ]
16281 },
16282 "extractEmbedded": {
16283 "type": "boolean"
16284 },
16285 "fullsize": {
16286 "$ref": "#/components/schemas/SystemConfigGeneratedFullsizeImageDto"
16287 },
16288 "preview": {
16289 "$ref": "#/components/schemas/SystemConfigGeneratedImageDto"
16290 },
16291 "thumbnail": {
16292 "$ref": "#/components/schemas/SystemConfigGeneratedImageDto"
16293 }
16294 },
16295 "required": [
16296 "colorspace",
16297 "extractEmbedded",
16298 "fullsize",
16299 "preview",
16300 "thumbnail"
16301 ],
16302 "type": "object"
16303 },
16304 "SystemConfigJobDto": {
16305 "properties": {
16306 "backgroundTask": {
16307 "$ref": "#/components/schemas/JobSettingsDto"
16308 },
16309 "faceDetection": {
16310 "$ref": "#/components/schemas/JobSettingsDto"
16311 },
16312 "library": {
16313 "$ref": "#/components/schemas/JobSettingsDto"
16314 },
16315 "metadataExtraction": {
16316 "$ref": "#/components/schemas/JobSettingsDto"
16317 },
16318 "migration": {
16319 "$ref": "#/components/schemas/JobSettingsDto"
16320 },
16321 "notifications": {
16322 "$ref": "#/components/schemas/JobSettingsDto"
16323 },
16324 "search": {
16325 "$ref": "#/components/schemas/JobSettingsDto"
16326 },
16327 "sidecar": {
16328 "$ref": "#/components/schemas/JobSettingsDto"
16329 },
16330 "smartSearch": {
16331 "$ref": "#/components/schemas/JobSettingsDto"
16332 },
16333 "thumbnailGeneration": {
16334 "$ref": "#/components/schemas/JobSettingsDto"
16335 },
16336 "videoConversion": {
16337 "$ref": "#/components/schemas/JobSettingsDto"
16338 }
16339 },
16340 "required": [
16341 "backgroundTask",
16342 "faceDetection",
16343 "library",
16344 "metadataExtraction",
16345 "migration",
16346 "notifications",
16347 "search",
16348 "sidecar",
16349 "smartSearch",
16350 "thumbnailGeneration",
16351 "videoConversion"
16352 ],
16353 "type": "object"
16354 },
16355 "SystemConfigLibraryDto": {
16356 "properties": {
16357 "scan": {
16358 "$ref": "#/components/schemas/SystemConfigLibraryScanDto"
16359 },
16360 "watch": {
16361 "$ref": "#/components/schemas/SystemConfigLibraryWatchDto"
16362 }
16363 },
16364 "required": [
16365 "scan",
16366 "watch"
16367 ],
16368 "type": "object"
16369 },
16370 "SystemConfigLibraryScanDto": {
16371 "properties": {
16372 "cronExpression": {
16373 "type": "string"
16374 },
16375 "enabled": {
16376 "type": "boolean"
16377 }
16378 },
16379 "required": [
16380 "cronExpression",
16381 "enabled"
16382 ],
16383 "type": "object"
16384 },
16385 "SystemConfigLibraryWatchDto": {
16386 "properties": {
16387 "enabled": {
16388 "type": "boolean"
16389 }
16390 },
16391 "required": [
16392 "enabled"
16393 ],
16394 "type": "object"
16395 },
16396 "SystemConfigLoggingDto": {
16397 "properties": {
16398 "enabled": {
16399 "type": "boolean"
16400 },
16401 "level": {
16402 "allOf": [
16403 {
16404 "$ref": "#/components/schemas/LogLevel"
16405 }
16406 ]
16407 }
16408 },
16409 "required": [
16410 "enabled",
16411 "level"
16412 ],
16413 "type": "object"
16414 },
16415 "SystemConfigMachineLearningDto": {
16416 "properties": {
16417 "availabilityChecks": {
16418 "$ref": "#/components/schemas/MachineLearningAvailabilityChecksDto"
16419 },
16420 "clip": {
16421 "$ref": "#/components/schemas/CLIPConfig"
16422 },
16423 "duplicateDetection": {
16424 "$ref": "#/components/schemas/DuplicateDetectionConfig"
16425 },
16426 "enabled": {
16427 "type": "boolean"
16428 },
16429 "facialRecognition": {
16430 "$ref": "#/components/schemas/FacialRecognitionConfig"
16431 },
16432 "urls": {
16433 "format": "uri",
16434 "items": {
16435 "format": "uri",
16436 "type": "string"
16437 },
16438 "minItems": 1,
16439 "type": "array"
16440 }
16441 },
16442 "required": [
16443 "availabilityChecks",
16444 "clip",
16445 "duplicateDetection",
16446 "enabled",
16447 "facialRecognition",
16448 "urls"
16449 ],
16450 "type": "object"
16451 },
16452 "SystemConfigMapDto": {
16453 "properties": {
16454 "darkStyle": {
16455 "format": "uri",
16456 "type": "string"
16457 },
16458 "enabled": {
16459 "type": "boolean"
16460 },
16461 "lightStyle": {
16462 "format": "uri",
16463 "type": "string"
16464 }
16465 },
16466 "required": [
16467 "darkStyle",
16468 "enabled",
16469 "lightStyle"
16470 ],
16471 "type": "object"
16472 },
16473 "SystemConfigMetadataDto": {
16474 "properties": {
16475 "faces": {
16476 "$ref": "#/components/schemas/SystemConfigFacesDto"
16477 }
16478 },
16479 "required": [
16480 "faces"
16481 ],
16482 "type": "object"
16483 },
16484 "SystemConfigNewVersionCheckDto": {
16485 "properties": {
16486 "enabled": {
16487 "type": "boolean"
16488 }
16489 },
16490 "required": [
16491 "enabled"
16492 ],
16493 "type": "object"
16494 },
16495 "SystemConfigNightlyTasksDto": {
16496 "properties": {
16497 "clusterNewFaces": {
16498 "type": "boolean"
16499 },
16500 "databaseCleanup": {
16501 "type": "boolean"
16502 },
16503 "generateMemories": {
16504 "type": "boolean"
16505 },
16506 "missingThumbnails": {
16507 "type": "boolean"
16508 },
16509 "startTime": {
16510 "type": "string"
16511 },
16512 "syncQuotaUsage": {
16513 "type": "boolean"
16514 }
16515 },
16516 "required": [
16517 "clusterNewFaces",
16518 "databaseCleanup",
16519 "generateMemories",
16520 "missingThumbnails",
16521 "startTime",
16522 "syncQuotaUsage"
16523 ],
16524 "type": "object"
16525 },
16526 "SystemConfigNotificationsDto": {
16527 "properties": {
16528 "smtp": {
16529 "$ref": "#/components/schemas/SystemConfigSmtpDto"
16530 }
16531 },
16532 "required": [
16533 "smtp"
16534 ],
16535 "type": "object"
16536 },
16537 "SystemConfigOAuthDto": {
16538 "properties": {
16539 "autoLaunch": {
16540 "type": "boolean"
16541 },
16542 "autoRegister": {
16543 "type": "boolean"
16544 },
16545 "buttonText": {
16546 "type": "string"
16547 },
16548 "clientId": {
16549 "type": "string"
16550 },
16551 "clientSecret": {
16552 "type": "string"
16553 },
16554 "defaultStorageQuota": {
16555 "format": "int64",
16556 "minimum": 0,
16557 "nullable": true,
16558 "type": "integer"
16559 },
16560 "enabled": {
16561 "type": "boolean"
16562 },
16563 "issuerUrl": {
16564 "type": "string"
16565 },
16566 "mobileOverrideEnabled": {
16567 "type": "boolean"
16568 },
16569 "mobileRedirectUri": {
16570 "format": "uri",
16571 "type": "string"
16572 },
16573 "profileSigningAlgorithm": {
16574 "type": "string"
16575 },
16576 "roleClaim": {
16577 "type": "string"
16578 },
16579 "scope": {
16580 "type": "string"
16581 },
16582 "signingAlgorithm": {
16583 "type": "string"
16584 },
16585 "storageLabelClaim": {
16586 "type": "string"
16587 },
16588 "storageQuotaClaim": {
16589 "type": "string"
16590 },
16591 "timeout": {
16592 "minimum": 1,
16593 "type": "integer"
16594 },
16595 "tokenEndpointAuthMethod": {
16596 "allOf": [
16597 {
16598 "$ref": "#/components/schemas/OAuthTokenEndpointAuthMethod"
16599 }
16600 ]
16601 }
16602 },
16603 "required": [
16604 "autoLaunch",
16605 "autoRegister",
16606 "buttonText",
16607 "clientId",
16608 "clientSecret",
16609 "defaultStorageQuota",
16610 "enabled",
16611 "issuerUrl",
16612 "mobileOverrideEnabled",
16613 "mobileRedirectUri",
16614 "profileSigningAlgorithm",
16615 "roleClaim",
16616 "scope",
16617 "signingAlgorithm",
16618 "storageLabelClaim",
16619 "storageQuotaClaim",
16620 "timeout",
16621 "tokenEndpointAuthMethod"
16622 ],
16623 "type": "object"
16624 },
16625 "SystemConfigPasswordLoginDto": {
16626 "properties": {
16627 "enabled": {
16628 "type": "boolean"
16629 }
16630 },
16631 "required": [
16632 "enabled"
16633 ],
16634 "type": "object"
16635 },
16636 "SystemConfigReverseGeocodingDto": {
16637 "properties": {
16638 "enabled": {
16639 "type": "boolean"
16640 }
16641 },
16642 "required": [
16643 "enabled"
16644 ],
16645 "type": "object"
16646 },
16647 "SystemConfigServerDto": {
16648 "properties": {
16649 "externalDomain": {
16650 "format": "uri",
16651 "type": "string"
16652 },
16653 "loginPageMessage": {
16654 "type": "string"
16655 },
16656 "publicUsers": {
16657 "type": "boolean"
16658 }
16659 },
16660 "required": [
16661 "externalDomain",
16662 "loginPageMessage",
16663 "publicUsers"
16664 ],
16665 "type": "object"
16666 },
16667 "SystemConfigSmtpDto": {
16668 "properties": {
16669 "enabled": {
16670 "type": "boolean"
16671 },
16672 "from": {
16673 "type": "string"
16674 },
16675 "replyTo": {
16676 "type": "string"
16677 },
16678 "transport": {
16679 "$ref": "#/components/schemas/SystemConfigSmtpTransportDto"
16680 }
16681 },
16682 "required": [
16683 "enabled",
16684 "from",
16685 "replyTo",
16686 "transport"
16687 ],
16688 "type": "object"
16689 },
16690 "SystemConfigSmtpTransportDto": {
16691 "properties": {
16692 "host": {
16693 "type": "string"
16694 },
16695 "ignoreCert": {
16696 "type": "boolean"
16697 },
16698 "password": {
16699 "type": "string"
16700 },
16701 "port": {
16702 "maximum": 65535,
16703 "minimum": 0,
16704 "type": "number"
16705 },
16706 "username": {
16707 "type": "string"
16708 }
16709 },
16710 "required": [
16711 "host",
16712 "ignoreCert",
16713 "password",
16714 "port",
16715 "username"
16716 ],
16717 "type": "object"
16718 },
16719 "SystemConfigStorageTemplateDto": {
16720 "properties": {
16721 "enabled": {
16722 "type": "boolean"
16723 },
16724 "hashVerificationEnabled": {
16725 "type": "boolean"
16726 },
16727 "template": {
16728 "type": "string"
16729 }
16730 },
16731 "required": [
16732 "enabled",
16733 "hashVerificationEnabled",
16734 "template"
16735 ],
16736 "type": "object"
16737 },
16738 "SystemConfigTemplateEmailsDto": {
16739 "properties": {
16740 "albumInviteTemplate": {
16741 "type": "string"
16742 },
16743 "albumUpdateTemplate": {
16744 "type": "string"
16745 },
16746 "welcomeTemplate": {
16747 "type": "string"
16748 }
16749 },
16750 "required": [
16751 "albumInviteTemplate",
16752 "albumUpdateTemplate",
16753 "welcomeTemplate"
16754 ],
16755 "type": "object"
16756 },
16757 "SystemConfigTemplateStorageOptionDto": {
16758 "properties": {
16759 "dayOptions": {
16760 "items": {
16761 "type": "string"
16762 },
16763 "type": "array"
16764 },
16765 "hourOptions": {
16766 "items": {
16767 "type": "string"
16768 },
16769 "type": "array"
16770 },
16771 "minuteOptions": {
16772 "items": {
16773 "type": "string"
16774 },
16775 "type": "array"
16776 },
16777 "monthOptions": {
16778 "items": {
16779 "type": "string"
16780 },
16781 "type": "array"
16782 },
16783 "presetOptions": {
16784 "items": {
16785 "type": "string"
16786 },
16787 "type": "array"
16788 },
16789 "secondOptions": {
16790 "items": {
16791 "type": "string"
16792 },
16793 "type": "array"
16794 },
16795 "weekOptions": {
16796 "items": {
16797 "type": "string"
16798 },
16799 "type": "array"
16800 },
16801 "yearOptions": {
16802 "items": {
16803 "type": "string"
16804 },
16805 "type": "array"
16806 }
16807 },
16808 "required": [
16809 "dayOptions",
16810 "hourOptions",
16811 "minuteOptions",
16812 "monthOptions",
16813 "presetOptions",
16814 "secondOptions",
16815 "weekOptions",
16816 "yearOptions"
16817 ],
16818 "type": "object"
16819 },
16820 "SystemConfigTemplatesDto": {
16821 "properties": {
16822 "email": {
16823 "$ref": "#/components/schemas/SystemConfigTemplateEmailsDto"
16824 }
16825 },
16826 "required": [
16827 "email"
16828 ],
16829 "type": "object"
16830 },
16831 "SystemConfigThemeDto": {
16832 "properties": {
16833 "customCss": {
16834 "type": "string"
16835 }
16836 },
16837 "required": [
16838 "customCss"
16839 ],
16840 "type": "object"
16841 },
16842 "SystemConfigTrashDto": {
16843 "properties": {
16844 "days": {
16845 "minimum": 0,
16846 "type": "integer"
16847 },
16848 "enabled": {
16849 "type": "boolean"
16850 }
16851 },
16852 "required": [
16853 "days",
16854 "enabled"
16855 ],
16856 "type": "object"
16857 },
16858 "SystemConfigUserDto": {
16859 "properties": {
16860 "deleteDelay": {
16861 "minimum": 1,
16862 "type": "integer"
16863 }
16864 },
16865 "required": [
16866 "deleteDelay"
16867 ],
16868 "type": "object"
16869 },
16870 "TagBulkAssetsDto": {
16871 "properties": {
16872 "assetIds": {
16873 "items": {
16874 "format": "uuid",
16875 "type": "string"
16876 },
16877 "type": "array"
16878 },
16879 "tagIds": {
16880 "items": {
16881 "format": "uuid",
16882 "type": "string"
16883 },
16884 "type": "array"
16885 }
16886 },
16887 "required": [
16888 "assetIds",
16889 "tagIds"
16890 ],
16891 "type": "object"
16892 },
16893 "TagBulkAssetsResponseDto": {
16894 "properties": {
16895 "count": {
16896 "type": "integer"
16897 }
16898 },
16899 "required": [
16900 "count"
16901 ],
16902 "type": "object"
16903 },
16904 "TagCreateDto": {
16905 "properties": {
16906 "color": {
16907 "pattern": "^#?([0-9A-F]{3}|[0-9A-F]{4}|[0-9A-F]{6}|[0-9A-F]{8})$",
16908 "type": "string"
16909 },
16910 "name": {
16911 "type": "string"
16912 },
16913 "parentId": {
16914 "format": "uuid",
16915 "nullable": true,
16916 "type": "string"
16917 }
16918 },
16919 "required": [
16920 "name"
16921 ],
16922 "type": "object"
16923 },
16924 "TagResponseDto": {
16925 "properties": {
16926 "color": {
16927 "type": "string"
16928 },
16929 "createdAt": {
16930 "format": "date-time",
16931 "type": "string"
16932 },
16933 "id": {
16934 "type": "string"
16935 },
16936 "name": {
16937 "type": "string"
16938 },
16939 "parentId": {
16940 "type": "string"
16941 },
16942 "updatedAt": {
16943 "format": "date-time",
16944 "type": "string"
16945 },
16946 "value": {
16947 "type": "string"
16948 }
16949 },
16950 "required": [
16951 "createdAt",
16952 "id",
16953 "name",
16954 "updatedAt",
16955 "value"
16956 ],
16957 "type": "object"
16958 },
16959 "TagUpdateDto": {
16960 "properties": {
16961 "color": {
16962 "nullable": true,
16963 "type": "string"
16964 }
16965 },
16966 "type": "object"
16967 },
16968 "TagUpsertDto": {
16969 "properties": {
16970 "tags": {
16971 "items": {
16972 "type": "string"
16973 },
16974 "type": "array"
16975 }
16976 },
16977 "required": [
16978 "tags"
16979 ],
16980 "type": "object"
16981 },
16982 "TagsResponse": {
16983 "properties": {
16984 "enabled": {
16985 "default": true,
16986 "type": "boolean"
16987 },
16988 "sidebarWeb": {
16989 "default": true,
16990 "type": "boolean"
16991 }
16992 },
16993 "required": [
16994 "enabled",
16995 "sidebarWeb"
16996 ],
16997 "type": "object"
16998 },
16999 "TagsUpdate": {
17000 "properties": {
17001 "enabled": {
17002 "type": "boolean"
17003 },
17004 "sidebarWeb": {
17005 "type": "boolean"
17006 }
17007 },
17008 "type": "object"
17009 },
17010 "TemplateDto": {
17011 "properties": {
17012 "template": {
17013 "type": "string"
17014 }
17015 },
17016 "required": [
17017 "template"
17018 ],
17019 "type": "object"
17020 },
17021 "TemplateResponseDto": {
17022 "properties": {
17023 "html": {
17024 "type": "string"
17025 },
17026 "name": {
17027 "type": "string"
17028 }
17029 },
17030 "required": [
17031 "html",
17032 "name"
17033 ],
17034 "type": "object"
17035 },
17036 "TestEmailResponseDto": {
17037 "properties": {
17038 "messageId": {
17039 "type": "string"
17040 }
17041 },
17042 "required": [
17043 "messageId"
17044 ],
17045 "type": "object"
17046 },
17047 "TimeBucketAssetResponseDto": {
17048 "properties": {
17049 "city": {
17050 "description": "Array of city names extracted from EXIF GPS data",
17051 "items": {
17052 "nullable": true,
17053 "type": "string"
17054 },
17055 "type": "array"
17056 },
17057 "country": {
17058 "description": "Array of country names extracted from EXIF GPS data",
17059 "items": {
17060 "nullable": true,
17061 "type": "string"
17062 },
17063 "type": "array"
17064 },
17065 "duration": {
17066 "description": "Array of video durations in HH:MM:SS format (null for images)",
17067 "items": {
17068 "nullable": true,
17069 "type": "string"
17070 },
17071 "type": "array"
17072 },
17073 "fileCreatedAt": {
17074 "description": "Array of file creation timestamps in UTC (ISO 8601 format, without timezone)",
17075 "items": {
17076 "type": "string"
17077 },
17078 "type": "array"
17079 },
17080 "id": {
17081 "description": "Array of asset IDs in the time bucket",
17082 "items": {
17083 "type": "string"
17084 },
17085 "type": "array"
17086 },
17087 "isFavorite": {
17088 "description": "Array indicating whether each asset is favorited",
17089 "items": {
17090 "type": "boolean"
17091 },
17092 "type": "array"
17093 },
17094 "isImage": {
17095 "description": "Array indicating whether each asset is an image (false for videos)",
17096 "items": {
17097 "type": "boolean"
17098 },
17099 "type": "array"
17100 },
17101 "isTrashed": {
17102 "description": "Array indicating whether each asset is in the trash",
17103 "items": {
17104 "type": "boolean"
17105 },
17106 "type": "array"
17107 },
17108 "latitude": {
17109 "description": "Array of latitude coordinates extracted from EXIF GPS data",
17110 "items": {
17111 "nullable": true,
17112 "type": "number"
17113 },
17114 "type": "array"
17115 },
17116 "livePhotoVideoId": {
17117 "description": "Array of live photo video asset IDs (null for non-live photos)",
17118 "items": {
17119 "nullable": true,
17120 "type": "string"
17121 },
17122 "type": "array"
17123 },
17124 "localOffsetHours": {
17125 "description": "Array of UTC offset hours at the time each photo was taken. Positive values are east of UTC, negative values are west of UTC. Values may be fractional (e.g., 5.5 for +05:30, -9.75 for -09:45). Applying this offset to 'fileCreatedAt' will give you the time the photo was taken from the photographer's perspective.",
17126 "items": {
17127 "type": "number"
17128 },
17129 "type": "array"
17130 },
17131 "longitude": {
17132 "description": "Array of longitude coordinates extracted from EXIF GPS data",
17133 "items": {
17134 "nullable": true,
17135 "type": "number"
17136 },
17137 "type": "array"
17138 },
17139 "ownerId": {
17140 "description": "Array of owner IDs for each asset",
17141 "items": {
17142 "type": "string"
17143 },
17144 "type": "array"
17145 },
17146 "projectionType": {
17147 "description": "Array of projection types for 360° content (e.g., \"EQUIRECTANGULAR\", \"CUBEFACE\", \"CYLINDRICAL\")",
17148 "items": {
17149 "nullable": true,
17150 "type": "string"
17151 },
17152 "type": "array"
17153 },
17154 "ratio": {
17155 "description": "Array of aspect ratios (width/height) for each asset",
17156 "items": {
17157 "type": "number"
17158 },
17159 "type": "array"
17160 },
17161 "stack": {
17162 "description": "Array of stack information as [stackId, assetCount] tuples (null for non-stacked assets)",
17163 "items": {
17164 "items": {
17165 "type": "string"
17166 },
17167 "maxItems": 2,
17168 "minItems": 2,
17169 "nullable": true,
17170 "type": "array"
17171 },
17172 "type": "array"
17173 },
17174 "thumbhash": {
17175 "description": "Array of BlurHash strings for generating asset previews (base64 encoded)",
17176 "items": {
17177 "nullable": true,
17178 "type": "string"
17179 },
17180 "type": "array"
17181 },
17182 "visibility": {
17183 "description": "Array of visibility statuses for each asset (e.g., ARCHIVE, TIMELINE, HIDDEN, LOCKED)",
17184 "items": {
17185 "$ref": "#/components/schemas/AssetVisibility"
17186 },
17187 "type": "array"
17188 }
17189 },
17190 "required": [
17191 "city",
17192 "country",
17193 "duration",
17194 "fileCreatedAt",
17195 "id",
17196 "isFavorite",
17197 "isImage",
17198 "isTrashed",
17199 "livePhotoVideoId",
17200 "localOffsetHours",
17201 "ownerId",
17202 "projectionType",
17203 "ratio",
17204 "thumbhash",
17205 "visibility"
17206 ],
17207 "type": "object"
17208 },
17209 "TimeBucketsResponseDto": {
17210 "properties": {
17211 "count": {
17212 "description": "Number of assets in this time bucket",
17213 "example": 42,
17214 "type": "integer"
17215 },
17216 "timeBucket": {
17217 "description": "Time bucket identifier in YYYY-MM-DD format representing the start of the time period",
17218 "example": "2024-01-01",
17219 "type": "string"
17220 }
17221 },
17222 "required": [
17223 "count",
17224 "timeBucket"
17225 ],
17226 "type": "object"
17227 },
17228 "ToneMapping": {
17229 "enum": [
17230 "hable",
17231 "mobius",
17232 "reinhard",
17233 "disabled"
17234 ],
17235 "type": "string"
17236 },
17237 "TranscodeHWAccel": {
17238 "enum": [
17239 "nvenc",
17240 "qsv",
17241 "vaapi",
17242 "rkmpp",
17243 "disabled"
17244 ],
17245 "type": "string"
17246 },
17247 "TranscodePolicy": {
17248 "enum": [
17249 "all",
17250 "optimal",
17251 "bitrate",
17252 "required",
17253 "disabled"
17254 ],
17255 "type": "string"
17256 },
17257 "TrashResponseDto": {
17258 "properties": {
17259 "count": {
17260 "type": "integer"
17261 }
17262 },
17263 "required": [
17264 "count"
17265 ],
17266 "type": "object"
17267 },
17268 "UpdateAlbumDto": {
17269 "properties": {
17270 "albumName": {
17271 "type": "string"
17272 },
17273 "albumThumbnailAssetId": {
17274 "format": "uuid",
17275 "type": "string"
17276 },
17277 "description": {
17278 "type": "string"
17279 },
17280 "isActivityEnabled": {
17281 "type": "boolean"
17282 },
17283 "order": {
17284 "allOf": [
17285 {
17286 "$ref": "#/components/schemas/AssetOrder"
17287 }
17288 ]
17289 }
17290 },
17291 "type": "object"
17292 },
17293 "UpdateAlbumUserDto": {
17294 "properties": {
17295 "role": {
17296 "allOf": [
17297 {
17298 "$ref": "#/components/schemas/AlbumUserRole"
17299 }
17300 ]
17301 }
17302 },
17303 "required": [
17304 "role"
17305 ],
17306 "type": "object"
17307 },
17308 "UpdateAssetDto": {
17309 "properties": {
17310 "dateTimeOriginal": {
17311 "type": "string"
17312 },
17313 "description": {
17314 "type": "string"
17315 },
17316 "isFavorite": {
17317 "type": "boolean"
17318 },
17319 "latitude": {
17320 "type": "number"
17321 },
17322 "livePhotoVideoId": {
17323 "format": "uuid",
17324 "nullable": true,
17325 "type": "string"
17326 },
17327 "longitude": {
17328 "type": "number"
17329 },
17330 "rating": {
17331 "maximum": 5,
17332 "minimum": -1,
17333 "type": "number"
17334 },
17335 "visibility": {
17336 "allOf": [
17337 {
17338 "$ref": "#/components/schemas/AssetVisibility"
17339 }
17340 ]
17341 }
17342 },
17343 "type": "object"
17344 },
17345 "UpdateLibraryDto": {
17346 "properties": {
17347 "exclusionPatterns": {
17348 "items": {
17349 "type": "string"
17350 },
17351 "maxItems": 128,
17352 "type": "array",
17353 "uniqueItems": true
17354 },
17355 "importPaths": {
17356 "items": {
17357 "type": "string"
17358 },
17359 "maxItems": 128,
17360 "type": "array",
17361 "uniqueItems": true
17362 },
17363 "name": {
17364 "type": "string"
17365 }
17366 },
17367 "type": "object"
17368 },
17369 "UsageByUserDto": {
17370 "properties": {
17371 "photos": {
17372 "type": "integer"
17373 },
17374 "quotaSizeInBytes": {
17375 "format": "int64",
17376 "nullable": true,
17377 "type": "integer"
17378 },
17379 "usage": {
17380 "format": "int64",
17381 "type": "integer"
17382 },
17383 "usagePhotos": {
17384 "format": "int64",
17385 "type": "integer"
17386 },
17387 "usageVideos": {
17388 "format": "int64",
17389 "type": "integer"
17390 },
17391 "userId": {
17392 "type": "string"
17393 },
17394 "userName": {
17395 "type": "string"
17396 },
17397 "videos": {
17398 "type": "integer"
17399 }
17400 },
17401 "required": [
17402 "photos",
17403 "quotaSizeInBytes",
17404 "usage",
17405 "usagePhotos",
17406 "usageVideos",
17407 "userId",
17408 "userName",
17409 "videos"
17410 ],
17411 "type": "object"
17412 },
17413 "UserAdminCreateDto": {
17414 "properties": {
17415 "avatarColor": {
17416 "allOf": [
17417 {
17418 "$ref": "#/components/schemas/UserAvatarColor"
17419 }
17420 ],
17421 "nullable": true
17422 },
17423 "email": {
17424 "format": "email",
17425 "type": "string"
17426 },
17427 "isAdmin": {
17428 "type": "boolean"
17429 },
17430 "name": {
17431 "type": "string"
17432 },
17433 "notify": {
17434 "type": "boolean"
17435 },
17436 "password": {
17437 "type": "string"
17438 },
17439 "quotaSizeInBytes": {
17440 "format": "int64",
17441 "minimum": 0,
17442 "nullable": true,
17443 "type": "integer"
17444 },
17445 "shouldChangePassword": {
17446 "type": "boolean"
17447 },
17448 "storageLabel": {
17449 "nullable": true,
17450 "type": "string"
17451 }
17452 },
17453 "required": [
17454 "email",
17455 "name",
17456 "password"
17457 ],
17458 "type": "object"
17459 },
17460 "UserAdminDeleteDto": {
17461 "properties": {
17462 "force": {
17463 "type": "boolean"
17464 }
17465 },
17466 "type": "object"
17467 },
17468 "UserAdminResponseDto": {
17469 "properties": {
17470 "avatarColor": {
17471 "allOf": [
17472 {
17473 "$ref": "#/components/schemas/UserAvatarColor"
17474 }
17475 ]
17476 },
17477 "createdAt": {
17478 "format": "date-time",
17479 "type": "string"
17480 },
17481 "deletedAt": {
17482 "format": "date-time",
17483 "nullable": true,
17484 "type": "string"
17485 },
17486 "email": {
17487 "type": "string"
17488 },
17489 "id": {
17490 "type": "string"
17491 },
17492 "isAdmin": {
17493 "type": "boolean"
17494 },
17495 "license": {
17496 "allOf": [
17497 {
17498 "$ref": "#/components/schemas/UserLicense"
17499 }
17500 ],
17501 "nullable": true
17502 },
17503 "name": {
17504 "type": "string"
17505 },
17506 "oauthId": {
17507 "type": "string"
17508 },
17509 "profileChangedAt": {
17510 "format": "date-time",
17511 "type": "string"
17512 },
17513 "profileImagePath": {
17514 "type": "string"
17515 },
17516 "quotaSizeInBytes": {
17517 "format": "int64",
17518 "nullable": true,
17519 "type": "integer"
17520 },
17521 "quotaUsageInBytes": {
17522 "format": "int64",
17523 "nullable": true,
17524 "type": "integer"
17525 },
17526 "shouldChangePassword": {
17527 "type": "boolean"
17528 },
17529 "status": {
17530 "allOf": [
17531 {
17532 "$ref": "#/components/schemas/UserStatus"
17533 }
17534 ]
17535 },
17536 "storageLabel": {
17537 "nullable": true,
17538 "type": "string"
17539 },
17540 "updatedAt": {
17541 "format": "date-time",
17542 "type": "string"
17543 }
17544 },
17545 "required": [
17546 "avatarColor",
17547 "createdAt",
17548 "deletedAt",
17549 "email",
17550 "id",
17551 "isAdmin",
17552 "license",
17553 "name",
17554 "oauthId",
17555 "profileChangedAt",
17556 "profileImagePath",
17557 "quotaSizeInBytes",
17558 "quotaUsageInBytes",
17559 "shouldChangePassword",
17560 "status",
17561 "storageLabel",
17562 "updatedAt"
17563 ],
17564 "type": "object"
17565 },
17566 "UserAdminUpdateDto": {
17567 "properties": {
17568 "avatarColor": {
17569 "allOf": [
17570 {
17571 "$ref": "#/components/schemas/UserAvatarColor"
17572 }
17573 ],
17574 "nullable": true
17575 },
17576 "email": {
17577 "format": "email",
17578 "type": "string"
17579 },
17580 "isAdmin": {
17581 "type": "boolean"
17582 },
17583 "name": {
17584 "type": "string"
17585 },
17586 "password": {
17587 "type": "string"
17588 },
17589 "pinCode": {
17590 "example": "123456",
17591 "nullable": true,
17592 "type": "string"
17593 },
17594 "quotaSizeInBytes": {
17595 "format": "int64",
17596 "minimum": 0,
17597 "nullable": true,
17598 "type": "integer"
17599 },
17600 "shouldChangePassword": {
17601 "type": "boolean"
17602 },
17603 "storageLabel": {
17604 "nullable": true,
17605 "type": "string"
17606 }
17607 },
17608 "type": "object"
17609 },
17610 "UserAvatarColor": {
17611 "enum": [
17612 "primary",
17613 "pink",
17614 "red",
17615 "yellow",
17616 "blue",
17617 "green",
17618 "purple",
17619 "orange",
17620 "gray",
17621 "amber"
17622 ],
17623 "type": "string"
17624 },
17625 "UserLicense": {
17626 "properties": {
17627 "activatedAt": {
17628 "format": "date-time",
17629 "type": "string"
17630 },
17631 "activationKey": {
17632 "type": "string"
17633 },
17634 "licenseKey": {
17635 "type": "string"
17636 }
17637 },
17638 "required": [
17639 "activatedAt",
17640 "activationKey",
17641 "licenseKey"
17642 ],
17643 "type": "object"
17644 },
17645 "UserMetadataKey": {
17646 "enum": [
17647 "preferences",
17648 "license",
17649 "onboarding"
17650 ],
17651 "type": "string"
17652 },
17653 "UserPreferencesResponseDto": {
17654 "properties": {
17655 "albums": {
17656 "$ref": "#/components/schemas/AlbumsResponse"
17657 },
17658 "cast": {
17659 "$ref": "#/components/schemas/CastResponse"
17660 },
17661 "download": {
17662 "$ref": "#/components/schemas/DownloadResponse"
17663 },
17664 "emailNotifications": {
17665 "$ref": "#/components/schemas/EmailNotificationsResponse"
17666 },
17667 "folders": {
17668 "$ref": "#/components/schemas/FoldersResponse"
17669 },
17670 "memories": {
17671 "$ref": "#/components/schemas/MemoriesResponse"
17672 },
17673 "people": {
17674 "$ref": "#/components/schemas/PeopleResponse"
17675 },
17676 "purchase": {
17677 "$ref": "#/components/schemas/PurchaseResponse"
17678 },
17679 "ratings": {
17680 "$ref": "#/components/schemas/RatingsResponse"
17681 },
17682 "sharedLinks": {
17683 "$ref": "#/components/schemas/SharedLinksResponse"
17684 },
17685 "tags": {
17686 "$ref": "#/components/schemas/TagsResponse"
17687 }
17688 },
17689 "required": [
17690 "albums",
17691 "cast",
17692 "download",
17693 "emailNotifications",
17694 "folders",
17695 "memories",
17696 "people",
17697 "purchase",
17698 "ratings",
17699 "sharedLinks",
17700 "tags"
17701 ],
17702 "type": "object"
17703 },
17704 "UserPreferencesUpdateDto": {
17705 "properties": {
17706 "albums": {
17707 "$ref": "#/components/schemas/AlbumsUpdate"
17708 },
17709 "avatar": {
17710 "$ref": "#/components/schemas/AvatarUpdate"
17711 },
17712 "cast": {
17713 "$ref": "#/components/schemas/CastUpdate"
17714 },
17715 "download": {
17716 "$ref": "#/components/schemas/DownloadUpdate"
17717 },
17718 "emailNotifications": {
17719 "$ref": "#/components/schemas/EmailNotificationsUpdate"
17720 },
17721 "folders": {
17722 "$ref": "#/components/schemas/FoldersUpdate"
17723 },
17724 "memories": {
17725 "$ref": "#/components/schemas/MemoriesUpdate"
17726 },
17727 "people": {
17728 "$ref": "#/components/schemas/PeopleUpdate"
17729 },
17730 "purchase": {
17731 "$ref": "#/components/schemas/PurchaseUpdate"
17732 },
17733 "ratings": {
17734 "$ref": "#/components/schemas/RatingsUpdate"
17735 },
17736 "sharedLinks": {
17737 "$ref": "#/components/schemas/SharedLinksUpdate"
17738 },
17739 "tags": {
17740 "$ref": "#/components/schemas/TagsUpdate"
17741 }
17742 },
17743 "type": "object"
17744 },
17745 "UserResponseDto": {
17746 "properties": {
17747 "avatarColor": {
17748 "allOf": [
17749 {
17750 "$ref": "#/components/schemas/UserAvatarColor"
17751 }
17752 ]
17753 },
17754 "email": {
17755 "type": "string"
17756 },
17757 "id": {
17758 "type": "string"
17759 },
17760 "name": {
17761 "type": "string"
17762 },
17763 "profileChangedAt": {
17764 "format": "date-time",
17765 "type": "string"
17766 },
17767 "profileImagePath": {
17768 "type": "string"
17769 }
17770 },
17771 "required": [
17772 "avatarColor",
17773 "email",
17774 "id",
17775 "name",
17776 "profileChangedAt",
17777 "profileImagePath"
17778 ],
17779 "type": "object"
17780 },
17781 "UserStatus": {
17782 "enum": [
17783 "active",
17784 "removing",
17785 "deleted"
17786 ],
17787 "type": "string"
17788 },
17789 "UserUpdateMeDto": {
17790 "properties": {
17791 "avatarColor": {
17792 "allOf": [
17793 {
17794 "$ref": "#/components/schemas/UserAvatarColor"
17795 }
17796 ],
17797 "nullable": true
17798 },
17799 "email": {
17800 "format": "email",
17801 "type": "string"
17802 },
17803 "name": {
17804 "type": "string"
17805 },
17806 "password": {
17807 "type": "string"
17808 }
17809 },
17810 "type": "object"
17811 },
17812 "ValidateAccessTokenResponseDto": {
17813 "properties": {
17814 "authStatus": {
17815 "type": "boolean"
17816 }
17817 },
17818 "required": [
17819 "authStatus"
17820 ],
17821 "type": "object"
17822 },
17823 "ValidateLibraryDto": {
17824 "properties": {
17825 "exclusionPatterns": {
17826 "items": {
17827 "type": "string"
17828 },
17829 "maxItems": 128,
17830 "type": "array",
17831 "uniqueItems": true
17832 },
17833 "importPaths": {
17834 "items": {
17835 "type": "string"
17836 },
17837 "maxItems": 128,
17838 "type": "array",
17839 "uniqueItems": true
17840 }
17841 },
17842 "type": "object"
17843 },
17844 "ValidateLibraryImportPathResponseDto": {
17845 "properties": {
17846 "importPath": {
17847 "type": "string"
17848 },
17849 "isValid": {
17850 "default": false,
17851 "type": "boolean"
17852 },
17853 "message": {
17854 "type": "string"
17855 }
17856 },
17857 "required": [
17858 "importPath",
17859 "isValid"
17860 ],
17861 "type": "object"
17862 },
17863 "ValidateLibraryResponseDto": {
17864 "properties": {
17865 "importPaths": {
17866 "items": {
17867 "$ref": "#/components/schemas/ValidateLibraryImportPathResponseDto"
17868 },
17869 "type": "array"
17870 }
17871 },
17872 "type": "object"
17873 },
17874 "VersionCheckStateResponseDto": {
17875 "properties": {
17876 "checkedAt": {
17877 "nullable": true,
17878 "type": "string"
17879 },
17880 "releaseVersion": {
17881 "nullable": true,
17882 "type": "string"
17883 }
17884 },
17885 "required": [
17886 "checkedAt",
17887 "releaseVersion"
17888 ],
17889 "type": "object"
17890 },
17891 "VideoCodec": {
17892 "enum": [
17893 "h264",
17894 "hevc",
17895 "vp9",
17896 "av1"
17897 ],
17898 "type": "string"
17899 },
17900 "VideoContainer": {
17901 "enum": [
17902 "mov",
17903 "mp4",
17904 "ogg",
17905 "webm"
17906 ],
17907 "type": "string"
17908 }
17909 }
17910 }
17911 }