forked from agregarr/agregarr
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathagregarr-api.yml
More file actions
14828 lines (14722 loc) · 475 KB
/
agregarr-api.yml
File metadata and controls
14828 lines (14722 loc) · 475 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: '3.0.2'
info:
title: 'Agregarr API'
version: '1.0.0'
description: |
This is the documentation for the Agregarr API backend.
Two primary authentication methods are supported:
- **Cookie Authentication**: A valid sign-in to the `/auth/plex` or `/auth/local` will generate a valid authentication cookie.
- **API Key Authentication**: Sign-in is also possible by passing an `X-Api-Key` header along with a valid API Key generated by Agregarr.
contact:
name: Agregarr Team
url: https://github.com/agregarr/agregarr
license:
name: MIT
url: https://github.com/agregarr/agregarr/blob/main/LICENSE
tags:
- name: public
description: Public API endpoints requiring no authentication.
- name: auth
description: Endpoints related to logging in or out, and the currently authenticated user.
- name: users
description: Endpoints related to user management.
- name: settings-general
description: General application settings, initialization, and public configuration.
- name: settings-plex
description: Plex media server configuration and library management.
- name: settings-services
description: Download service configurations (Radarr & Sonarr).
- name: settings-integrations
description: External service integrations for collection sources (Tautulli, Trakt, MDBList, MyAnimeList, Overseerr).
- name: settings-system
description: System management including jobs, cache, and logs.
- name: search
description: Endpoints related to search and discovery.
- name: movies
description: Endpoints related to retrieving movies and their details.
- name: tv
description: Endpoints related to retrieving TV series and their details.
- name: other
description: Endpoints related to other TMDB data.
- name: tmdb
description: Endpoints related to retrieving TMDB assets, media, genres, and countries.
- name: media
description: Endpoints related to media management.
- name: collections
description: User-created collection management including CRUD operations, syncing, and reordering.
- name: collections-utility
description: Collection utility operations including preview, template validation, and source data fetching.
- name: collections-posters
description: Collection poster operations including upload, generation, and download.
- name: default-hubs
description: Default Plex algorithmic hub configuration (Recently Added, Continue Watching, etc.) including visibility and reordering.
- name: pre-existing-collections
description: Pre-existing Plex collection management including discovery, visibility configuration, and custom posters.
- name: hubs
description: Plex hub management and configuration operations.
- name: service
description: Endpoints related to getting service (Radarr/Sonarr) details.
- name: missing-items
description: Endpoints related to missing item request tracking and management.
- name: dashboard
description: Endpoints related to dashboard statistics and analytics.
- name: poster-templates
description: Poster template management including CRUD operations, validation, preview, and import/export.
- name: poster-assets
description: Poster icon and asset management including upload, download, and file serving.
- name: poster-saved
description: Saved poster instance management.
- name: source-colors
description: Managing global source color schemes for poster generation.
- name: exclusions
description: Managing global item exclusions for collections.
- name: overlays
description: Unified overlay template system for applying customizable badges, banners, and metadata to library posters. Create reusable templates with ratings, directors, resolution info, and more.
servers:
- url: '{server}/api/v1'
variables:
server:
default: http://localhost:7171
components:
schemas:
User:
type: object
properties:
id:
type: integer
example: 1
readOnly: true
email:
type: string
example: 'hey@itsme.com'
readOnly: true
username:
type: string
plexToken:
type: string
readOnly: true
plexUsername:
type: string
readOnly: true
userType:
type: integer
example: 1
readOnly: true
permissions:
type: number
example: 0
avatar:
type: string
readOnly: true
createdAt:
type: string
example: '2020-09-02T05:02:23.000Z'
readOnly: true
updatedAt:
type: string
example: '2020-09-02T05:02:23.000Z'
readOnly: true
requestCount:
type: number
example: 5
readOnly: true
required:
- id
- email
- createdAt
- updatedAt
UserSettings:
type: object
properties:
locale:
type: string
region:
type: string
originalLanguage:
type: string
MainSettings:
type: object
properties:
apiKey:
type: string
readOnly: true
appLanguage:
type: string
example: en
applicationTitle:
type: string
example: Agregarr
applicationUrl:
type: string
example: https://os.example.com
trustProxy:
type: boolean
example: true
csrfProtection:
type: boolean
example: false
hideAvailable:
type: boolean
example: false
partialRequestsEnabled:
type: boolean
example: false
localLogin:
type: boolean
example: true
newPlexLogin:
type: boolean
example: true
placeholderMovieRootFolders:
type: object
additionalProperties:
type: string
description: Per-library movie placeholder root folders (libraryKey -> path)
example:
'1': /data/media/movies
'3': /data/media/movies-4k
placeholderTVRootFolders:
type: object
additionalProperties:
type: string
description: Per-library TV placeholder root folders (libraryKey -> path)
example:
'2': /data/media/tv
'4': /data/media/anime
skipYoutubeTrailerDownloads:
type: boolean
description: If true, skip YouTube trailer downloads and use hardcoded placeholder video only (speeds up sync)
example: false
PlexLibrary:
type: object
properties:
id:
type: string
name:
type: string
example: Movies
enabled:
type: boolean
example: false
required:
- id
- name
- enabled
PlexSettings:
type: object
properties:
name:
type: string
example: 'Main Server'
readOnly: true
machineId:
type: string
example: '1234123412341234'
readOnly: true
ip:
type: string
example: '127.0.0.1'
port:
type: number
example: 32400
useSsl:
type: boolean
nullable: true
libraries:
type: array
readOnly: true
items:
$ref: '#/components/schemas/PlexLibrary'
webAppUrl:
type: string
nullable: true
example: 'https://app.plex.tv/desktop'
required:
- name
- machineId
- ip
- port
CollectionConfig:
type: object
properties:
id:
type: string
description: 'Unique collection identifier (sequential number starting from 10000)'
example: '10000'
name:
type: string
example: 'User Requests'
type:
type: string
enum:
[
'overseerr',
'tautulli',
'trakt',
'tmdb',
'imdb',
'mdblist',
'letterboxd',
'networks',
'originals',
'plex',
'multi-source',
'anilist',
'myanimelist',
'radarrtag',
'sonarrtag',
'comingsoon',
'filtered_hub',
]
example: 'overseerr'
subtype:
type: string
example: 'users'
template:
type: string
example: "{nickname}'s Requests"
customMovieTemplate:
type: string
description: "Custom template for movie collections when mediaType is 'both'"
example: "{nickname}'s Movie Requests"
nullable: true
customTVTemplate:
type: string
description: "Custom template for TV collections when mediaType is 'both'"
example: "{nickname}'s TV Requests"
nullable: true
customPoster:
oneOf:
- type: string
description: 'Filename of custom poster image (legacy format)'
example: 'f47ac10b-58cc-4372-a567-0e02b2c3d479.jpg'
- type: object
description: 'Per-library poster mapping (libraryId -> filename)'
additionalProperties:
type: string
example:
lib1: 'f47ac10b-58cc-4372-a567-0e02b2c3d479.jpg'
lib2: 'a12bc34d-58cc-4372-a567-0e02b2c3d480.jpg'
nullable: true
autoPoster:
type: boolean
description: 'Auto-generate poster during sync'
example: true
nullable: true
autoPosterTemplate:
type: integer
description: 'Template ID for auto-generated posters (null for default template)'
example: 1
nullable: true
useTmdbFranchisePoster:
type: boolean
description: 'Use TMDB franchise poster instead of auto-generated poster (only for TMDB auto_franchise collections)'
example: false
nullable: true
hideIndividualItems:
type: boolean
description: 'Hide individual items, show collection (collectionMode = 1, only for TMDB auto_franchise collections)'
example: false
nullable: true
applyOverlaysDuringSync:
type: boolean
description: 'Apply item overlays during sync (for Coming Soon collections)'
example: true
nullable: true
customWallpaper:
oneOf:
- type: string
description: 'Filename of custom wallpaper image (art)'
example: 'wallpaper-12345.jpg'
- type: object
description: 'Per-library wallpaper mapping (libraryId -> filename)'
additionalProperties:
type: string
example:
lib1: 'wallpaper-12345.jpg'
lib2: 'wallpaper-67890.jpg'
nullable: true
customSummary:
type: string
description: 'Custom summary/description text for the collection'
example: 'A curated collection of the best movies'
nullable: true
customTheme:
oneOf:
- type: string
description: 'Filename of custom theme music file'
example: 'theme-12345.mp3'
- type: object
description: 'Per-library theme mapping (libraryId -> filename)'
additionalProperties:
type: string
example:
lib1: 'theme-12345.mp3'
lib2: 'theme-67890.mp3'
nullable: true
enableCustomWallpaper:
type: boolean
description: 'Enable custom wallpaper sync to Plex'
example: false
nullable: true
enableCustomSummary:
type: boolean
description: 'Enable custom summary sync to Plex'
example: false
nullable: true
enableCustomTheme:
type: boolean
description: 'Enable custom theme sync to Plex'
example: false
nullable: true
visibilityConfig:
type: object
properties:
usersHome:
type: boolean
description: "Show on shared users' home screens"
example: true
serverOwnerHome:
type: boolean
description: "Show on server owner's home screen"
example: false
libraryRecommended:
type: boolean
description: 'Show in library recommended section'
example: false
required:
- usersHome
- serverOwnerHome
- libraryRecommended
maxItems:
type: integer
example: 20
mediaType:
type: string
enum: ['movie', 'tv', 'both']
example: 'both'
libraryIds:
type: array
items:
type: string
description: "Array of selected library IDs (['all'] for all libraries)"
example: ['1', '2']
nullable: true
libraryName:
type: string
description: 'Selected library name for display'
example: 'Movies'
nullable: true
sortOrderHome:
type: integer
description: 'Order for Plex home screen (creation time based)'
example: 0
nullable: true
sortOrderLibrary:
type: integer
description: 'Position in library (0 for A-Z section, 1+ for promoted section)'
example: 0
nullable: true
isLibraryPromoted:
type: boolean
description: 'true = promoted section (uses exclamation marks), false = A-Z section'
example: true
randomizeHomeOrder:
type: boolean
description: 'If true, randomize position amongst other randomized items on home screen'
example: false
nullable: true
parentConfigId:
type: integer
description: "Reference to original config when expanded from 'all' libraries"
example: 1
nullable: true
isExpandedConfig:
type: boolean
description: "True if this config was auto-generated from a parent 'all' config"
example: false
nullable: true
customDays:
type: integer
description: 'Number of days for Tautulli collections (required for Tautulli type)'
example: 30
nullable: true
createPlaceholdersForMissing:
type: boolean
description: 'Create placeholder files for missing items (enabled by default for Coming Soon collections)'
example: false
nullable: true
placeholderDaysAhead:
type: integer
description: 'Days to look ahead for release dates when creating placeholders (default: 360)'
example: 360
nullable: true
placeholderReleasedDays:
type: integer
description: 'Days to keep released items with overlay before cleanup (default: 7)'
example: 7
nullable: true
includeAllReleasedItems:
type: boolean
description: 'If true, include all released items regardless of release date (default: true for new configs)'
example: true
nullable: true
comingSoonDays:
type: integer
description: 'DEPRECATED: Use placeholderDaysAhead instead'
deprecated: true
example: 360
nullable: true
comingSoonReleasedDays:
type: integer
description: 'DEPRECATED: Use placeholderReleasedDays instead'
deprecated: true
example: 7
nullable: true
minimumPlays:
type: integer
description: 'Minimum play count for Tautulli collections (defaults to 3 if not set, 1-100)'
example: 3
nullable: true
tautulliStatType:
type: string
enum: ['plays', 'duration']
description: 'Tautulli statistic type: plays (play count) or duration (watch time)'
example: 'plays'
nullable: true
searchMissingMovies:
type: boolean
description: 'Auto-request missing movies'
example: false
nullable: true
searchMissingTV:
type: boolean
description: 'Auto-request missing TV shows'
example: false
nullable: true
autoApproveMovies:
type: boolean
description: 'Auto-approve movie requests'
example: false
nullable: true
autoApproveTV:
type: boolean
description: 'Auto-approve TV show requests'
example: false
nullable: true
maxSeasonsToRequest:
type: integer
description: 'Max seasons for auto-approval (TV shows with more seasons require manual approval)'
example: 5
nullable: true
seasonsPerShowLimit:
type: integer
description: 'Limit each TV show to only the first X seasons (0 = all seasons)'
example: 2
nullable: true
seasonGrabOrder:
type: string
enum:
- first
- latest
- airing
description: 'Order to grab seasons: first N seasons (default), N latest seasons (including unreleased), or N most recently aired seasons'
example: 'first'
nullable: true
minimumYear:
type: integer
description: 'Only process movies/TV shows released on or after this year (0 = no limit)'
example: 2010
nullable: true
minimumImdbRating:
type: number
format: float
description: 'Only process movies/TV shows with IMDb rating >= this value (0 = no limit)'
example: 6.8
minimum: 0
maximum: 10
nullable: true
minimumRottenTomatoesRating:
type: number
format: float
description: 'Only process movies/TV shows with Rotten Tomatoes critics score >= this value (0 = no limit)'
example: 70
minimum: 0
maximum: 100
nullable: true
minimumRottenTomatoesAudienceRating:
type: number
format: float
description: 'Only process movies/TV shows with Rotten Tomatoes audience score >= this value (0 = no limit)'
example: 75
minimum: 0
maximum: 100
nullable: true
filterSettings:
type: object
description: 'Unified filter settings with include/exclude modes'
properties:
genres:
type: object
properties:
mode:
type: string
enum: ['exclude', 'include']
description: 'Filter mode: exclude items with these genres, or include only items with these genres'
example: 'exclude'
values:
type: array
items:
type: integer
description: 'TMDB genre IDs'
example: [28, 53]
countries:
type: object
properties:
mode:
type: string
enum: ['exclude', 'include']
description: 'Filter mode: exclude items from these countries, or include only items from these countries'
example: 'exclude'
values:
type: array
items:
type: string
description: 'ISO 3166-1 country codes'
example: ['JP', 'KR']
languages:
type: object
properties:
mode:
type: string
enum: ['exclude', 'include']
description: 'Filter mode: exclude items with these languages, or include only items with these languages'
example: 'exclude'
values:
type: array
items:
type: string
description: 'ISO 639-1 language codes'
example: ['ja', 'ko']
nullable: true
traktCustomListUrl:
type: string
description: 'Custom Trakt list URL (e.g., https://trakt.tv/users/username/lists/list-name or https://app.trakt.tv/users/username/lists/list-name)'
example: 'https://trakt.tv/users/username/lists/my-list'
nullable: true
tmdbCustomCollectionUrl:
type: string
description: 'Custom TMDB collection or list URL (e.g., https://www.themoviedb.org/collection/123456 or https://www.themoviedb.org/list/310)'
example: 'https://www.themoviedb.org/list/310-my-movie-list'
nullable: true
imdbCustomListUrl:
type: string
description: 'Custom IMDb list or watchlist URL (e.g., https://www.imdb.com/list/ls123456789/ or https://www.imdb.com/user/ur12345678/watchlist)'
example: 'https://www.imdb.com/list/ls123456789/'
nullable: true
mdblistCustomListUrl:
type: string
description: 'Custom MDBList list URL (e.g., https://mdblist.com/lists/username/listname)'
example: 'https://mdblist.com/lists/garycrawfordgc/netflix-shows'
nullable: true
sortOrder:
type: string
enum:
- default
- reverse
- random
- imdb_rating_desc
- imdb_rating_asc
- release_date_desc
- release_date_asc
- date_added_desc
- date_added_asc
- alphabetical_asc
- alphabetical_desc
description: 'Sort order for collection items'
example: 'default'
default: 'default'
nullable: true
personMinimumItems:
type: number
description: 'Unified minimum items required to create actor/director collections'
example: 3
nullable: true
useSeparator:
type: boolean
description: 'Create a separator collection for auto actor/director collections'
example: false
nullable: true
separatorTitle:
type: string
description: 'Title for the separator collection'
example: 'Actors Collections'
nullable: true
excludeFromCollections:
type: array
items:
type: string
description: 'Array of collection IDs to exclude items from (mutual exclusion)'
example: ['10001', '10002']
nullable: true
timeRestriction:
type: object
description: 'Time restriction settings for the collection'
properties:
alwaysActive:
type: boolean
description: 'If true, collection is always active (default)'
example: true
removeFromPlexWhenInactive:
type: boolean
description: 'If true, completely remove from Plex when inactive (old behavior)'
example: false
nullable: true
inactiveVisibilityConfig:
type: object
description: 'Visibility settings to use when collection is inactive (only used if removeFromPlexWhenInactive is false)'
properties:
usersHome:
type: boolean
description: "Show on shared users' home screens when inactive"
example: false
serverOwnerHome:
type: boolean
description: "Show on server owner's home screen when inactive"
example: false
libraryRecommended:
type: boolean
description: 'Show in library recommended section when inactive'
example: true
required:
- usersHome
- serverOwnerHome
- libraryRecommended
nullable: true
dateRanges:
type: array
description: 'Date ranges when collection should be active (repeated annually)'
items:
type: object
properties:
startDate:
type: string
description: "DD-MM format (e.g., '05-12' for 5th December)"
example: '05-12'
endDate:
type: string
description: "DD-MM format (e.g., '26-12' for 26th December)"
example: '26-12'
required:
- startDate
- endDate
nullable: true
weeklySchedule:
type: object
description: 'Days of the week when collection should be active'
properties:
monday:
type: boolean
example: true
tuesday:
type: boolean
example: true
wednesday:
type: boolean
example: true
thursday:
type: boolean
example: true
friday:
type: boolean
example: true
saturday:
type: boolean
example: false
sunday:
type: boolean
example: false
nullable: true
nullable: true
isActive:
type: boolean
description: 'Whether collection is currently active (time restrictions met)'
example: true
readOnly: true
collectionType:
type: string
enum: ['default_plex_hub', 'agregarr_created', 'pre_existing']
description: 'Backend categorization system for different collection types'
example: 'agregarr_created'
nullable: true
isLinked:
type: boolean
description: 'Whether collection is actively linked to other collections'
example: true
nullable: true
isUnlinked:
type: boolean
description: 'True if this collection was deliberately unlinked and should not be grouped with siblings'
example: false
nullable: true
missing:
type: boolean
description: 'True if collection no longer exists in Plex'
example: false
lastSyncedAt:
type: string
format: date-time
description: 'ISO timestamp of last successful sync to Plex'
example: '2024-01-15T10:30:00.000Z'
nullable: true
lastModifiedAt:
type: string
format: date-time
description: 'ISO timestamp when config was last modified'
example: '2024-01-15T09:15:00.000Z'
nullable: true
needsSync:
type: boolean
description: 'True if collection has been modified and needs to be synced to Plex'
example: false
nullable: true
showUnwatchedOnly:
type: boolean
description: 'Create a smart collection that shows only unwatched items from this collection'
example: false
nullable: true
smartCollectionSort:
type: object
description: 'Sort option for smart collections'
properties:
value:
type: string
description: "The sort parameter value (e.g., 'year:desc', 'titleSort', 'rating:desc')"
example: 'year:desc'
label:
type: string
description: 'Human-readable label for the dropdown'
example: 'Year (Newest First)'
nullable: true
required:
- id
- name
- type
- subtype
- template
- visibilityConfig
- maxItems
CollectionConfigCreate:
type: object
description: 'Schema for creating a new collection configuration'
properties:
id:
type: string
description: 'Empty string for new collections (will be assigned sequential number by backend)'
example: ''
name:
type: string
example: 'User Requests'
type:
type: string
enum:
[
'overseerr',
'tautulli',
'trakt',
'tmdb',
'imdb',
'mdblist',
'letterboxd',
'networks',
'originals',
'plex',
'multi-source',
'anilist',
'myanimelist',
'radarrtag',
'sonarrtag',
'comingsoon',
'filtered_hub',
]
example: 'overseerr'
subtype:
type: string
example: 'users'
template:
type: string
example: "{nickname}'s Requests"
customMovieTemplate:
type: string
description: "Custom template for movie collections when mediaType is 'both'"
example: "{nickname}'s Movie Requests"
nullable: true
customTVTemplate:
type: string
description: "Custom template for TV collections when mediaType is 'both'"
example: "{nickname}'s TV Requests"
nullable: true
customPoster:
oneOf:
- type: string
description: 'Filename of custom poster image (legacy format)'
example: 'f47ac10b-58cc-4372-a567-0e02b2c3d479.jpg'
- type: object
description: 'Per-library poster mapping (libraryId -> filename)'
additionalProperties:
type: string
example:
lib1: 'f47ac10b-58cc-4372-a567-0e02b2c3d479.jpg'
lib2: 'a12bc34d-58cc-4372-a567-0e02b2c3d480.jpg'
nullable: true
autoPoster:
type: boolean
description: 'Auto-generate poster during sync'
example: true
nullable: true
autoPosterTemplate:
type: integer
description: 'Template ID for auto-generated posters (null for default template)'
example: 1
nullable: true
useTmdbFranchisePoster:
type: boolean
description: 'Use TMDB franchise poster instead of auto-generated poster (only for TMDB auto_franchise collections)'
example: false
nullable: true
hideIndividualItems:
type: boolean
description: 'Hide individual items, show collection (collectionMode = 1, only for TMDB auto_franchise collections)'
example: false
nullable: true
applyOverlaysDuringSync:
type: boolean
description: 'Apply item overlays during sync (for Coming Soon collections)'
example: true
nullable: true
customWallpaper:
oneOf:
- type: string
description: 'Filename of custom wallpaper image (art)'
example: 'wallpaper-12345.jpg'
- type: object
description: 'Per-library wallpaper mapping (libraryId -> filename)'
additionalProperties:
type: string
example:
lib1: 'wallpaper-12345.jpg'
lib2: 'wallpaper-67890.jpg'
nullable: true
customSummary:
type: string
description: 'Custom summary/description text for the collection'
example: 'A curated collection of the best movies'
nullable: true
customTheme:
oneOf:
- type: string
description: 'Filename of custom theme music file'
example: 'theme-12345.mp3'
- type: object
description: 'Per-library theme mapping (libraryId -> filename)'
additionalProperties:
type: string
example:
lib1: 'theme-12345.mp3'
lib2: 'theme-67890.mp3'
nullable: true
enableCustomWallpaper:
type: boolean
description: 'Enable custom wallpaper sync to Plex'
example: false
nullable: true
enableCustomSummary:
type: boolean
description: 'Enable custom summary sync to Plex'
example: false
nullable: true
enableCustomTheme:
type: boolean
description: 'Enable custom theme sync to Plex'
example: false
nullable: true
visibilityConfig:
type: object
properties:
usersHome:
type: boolean
description: "Show on shared users' home screens"
example: true
serverOwnerHome:
type: boolean
description: "Show on server owner's home screen"
example: false
libraryRecommended:
type: boolean
description: 'Show in library recommended section'
example: false
required:
- usersHome
- serverOwnerHome
- libraryRecommended
maxItems:
type: integer
example: 20
mediaType:
type: string
enum: ['movie', 'tv', 'both']
example: 'both'
libraryId:
type: string
description: "Selected library ID - each config is for exactly one library (optional when mediaType is 'both')"
example: '1'
libraryName:
type: string
description: "Selected library name for display (optional when mediaType is 'both')"
example: 'Movies'
libraryIds:
type: array
items:
type: string
description: "Array of library IDs when mediaType is 'both' (backend expands into individual configs)"
example: ['1', '2']
libraryNames:
type: array
items:
type: string
description: "Array of library names when mediaType is 'both' (backend expands into individual configs)"
example: ['Movies', 'TV Shows']
sortOrderHome:
type: integer
description: 'Order for Plex home screen (creation time based)'
example: 0
nullable: true
sortOrderLibrary:
type: integer
description: 'Order for Plex library tab (sortTitle based)'
example: 0