diff --git a/output/plex-media-server-spec-dereferenced.yaml b/output/plex-media-server-spec-dereferenced.yaml index adb53d92..52ff7dd3 100644 --- a/output/plex-media-server-spec-dereferenced.yaml +++ b/output/plex-media-server-spec-dereferenced.yaml @@ -2603,18 +2603,24 @@ paths: description: The number of leaf items (end nodes) under this media item. example: 14 - type: object + required: + - librarySectionID properties: librarySectionID: type: integer description: The identifier for the library section. example: 1 - type: object + required: + - librarySectionKey properties: librarySectionKey: type: string description: The key corresponding to the library section. example: /library/sections/1 - type: object + required: + - librarySectionTitle properties: librarySectionTitle: type: string @@ -3171,22 +3177,22 @@ paths: example: 1002625 streamType: type: integer - oneOf: - - title: VIDEO - const: 1 - description: Video stream - - title: AUDIO - const: 2 - description: Audio stream - - title: SUBTITLE - const: 3 - description: Subtitle stream - example: 1 + format: int32 description: | Stream type: - - VIDEO = 1 - - AUDIO = 2 - - SUBTITLE = 3 + - 1 = video + - 2 = audio + - 3 = subtitle + enum: + - 1 + - 2 + - 3 + example: 1 + x-speakeasy-unknown-values: allow + x-speakeasy-enums: + - VIDEO + - AUDIO + - SUBTITLE format: type: string description: 'Format of the stream (e.g., srt).' @@ -6123,1375 +6129,1001 @@ paths: MediaContainer: allOf: - type: object - required: - - size + description: | + The Meta object is only included in the response if the `includeMeta` parameter is set to `1`. properties: - size: - description: Number of media items returned in this response. - type: integer - format: int32 - example: 50 - - type: object - required: - - totalSize - properties: - totalSize: - description: Total number of media items in the library. - type: integer - format: int32 - example: 50 - - type: object - required: - - offset - properties: - offset: - type: integer - description: Offset value for pagination. - example: 0 - - type: object - required: - - content - properties: - content: - type: string - description: The content type or mode. - example: secondary - - type: object - required: - - allowSync - properties: - allowSync: - type: boolean - description: Indicates whether syncing is allowed. - example: false - - type: object - required: - - nocache - properties: - nocache: - type: boolean - description: Specifies whether caching is disabled. - example: true - - type: object - required: - - art - properties: - art: - type: string - description: URL for the background artwork of the media container. - example: '/:/resources/show-fanart.jpg' - - type: object - required: - - identifier - properties: - identifier: - type: string - description: An plugin identifier for the media container. - example: com.plexapp.plugins.library - - type: object - properties: - librarySectionID: - type: integer - description: The unique identifier for the library section. - example: 2 - - type: object - properties: - librarySectionTitle: - type: string - description: The title of the library section. - example: TV Series - - type: object - properties: - librarySectionUUID: - type: string - description: The universally unique identifier for the library section. - example: e69655a2-ef48-4aba-bb19-0cc34d1e7d36 - - type: object - required: - - mediaTagPrefix - properties: - mediaTagPrefix: - type: string - description: The prefix used for media tag resource paths. - example: /system/bundle/media/flags/ - - type: object - required: - - mediaTagVersion - properties: - mediaTagVersion: - type: integer - description: The version number for media tags. - example: 1734362201 - - type: object - required: - - thumb - properties: - thumb: - type: string - description: URL for the thumbnail image of the media container. - example: '/:/resources/show.png' - - type: object - required: - - title1 - properties: - title1: - type: string - description: The primary title of the media container. - example: TV Series - - type: object - required: - - title2 - properties: - title2: - type: string - description: The secondary title of the media container. - example: By Starring Actor - - type: object - required: - - viewGroup - properties: - viewGroup: - type: string - description: Identifier for the view group layout. - example: secondary - - type: object - properties: - viewMode: - type: string - description: Identifier for the view mode. - example: '131131' - - type: object - properties: - mixedParents: - type: boolean - description: Indicates if the media container has mixed parents. - example: true - - type: object - required: - - Metadata - properties: - Metadata: + Type: type: array - description: An array of metadata items. items: + type: object + required: + - key + - type + - title + - active + properties: + key: + type: string + example: /library/sections/2/all?type=2 + type: + type: string + example: filter + subtype: + type: string + example: clip + title: + type: string + example: TV Shows + active: + type: boolean + example: false + Filter: + type: array + items: + type: object + required: + - filter + - filterType + - key + - title + - type + properties: + filter: + type: string + example: genre + filterType: + type: string + example: string + key: + type: string + example: /library/sections/2/genre?type=2 + title: + type: string + example: Genre + type: + type: string + example: filter + advanced: + type: boolean + example: true + Sort: + type: array + items: + type: object + required: + - key + - title + - defaultDirection + properties: + default: + type: string + example: asc + active: + type: boolean + example: false + activeDirection: + type: string + enum: + - asc + - desc + example: asc + default: asc + description: | + The direction of the sort. Can be either `asc` or `desc`. + x-speakeasy-enums: + - ASCENDING + - DESCENDING + defaultDirection: + type: string + enum: + - asc + - desc + example: asc + default: asc + description: | + The direction of the sort. Can be either `asc` or `desc`. + x-speakeasy-enums: + - ASCENDING + - DESCENDING + descKey: + type: string + example: 'titleSort:desc' + firstCharacterKey: + type: string + example: /library/sections/2/firstCharacter + key: + type: string + example: titleSort + title: + type: string + example: Title + Field: + type: array + items: + type: object + required: + - key + - title + - type + properties: + key: + type: string + example: show.title + title: + type: string + example: Show Title + type: + type: string + example: string + subType: + type: string + example: rating + FieldType: + type: array + items: + type: object required: - type - allOf: - - type: object - required: - - ratingKey - properties: - ratingKey: - type: string - description: 'The rating key (Media ID) of this media item. Note: Although this is always an integer, it is represented as a string in the API.' - example: '58683' - - type: object - required: - - key - properties: - key: - type: string - description: The unique key for the media item. - example: /library/metadata/58683 - - type: object - required: - - guid - properties: - guid: - type: string - description: The globally unique identifier for the media item. - example: 'plex://movie/5d7768ba96b655001fdc0408' - - type: object - required: - - slug - properties: - slug: - type: string - description: A URL‐friendly version of the media title. - example: 4-for-texas - - type: object - properties: - studio: - type: string - description: The studio that produced the media item. - example: 20th Century Studios - - type: object - required: - - type - properties: - type: - allOf: - - type: string - x-speakeasy-unknown-values: allow - enum: - - movie - - show - - season - - episode - - artist - - album - - track - - photoalbum - - photo - - collection - example: movie - description: | - The type of media content in the Plex library. This can represent videos, music, or photos. - x-speakeasy-enums: - - MOVIE - - TV_SHOW - - SEASON - - EPISODE - - ARTIST - - ALBUM - - TRACK - - PHOTO_ALBUM - - PHOTO - - COLLECTION - - type: object - required: - - title - properties: - title: - type: string - description: The title of the media item. - example: 'Avatar: The Way of Water' - - type: object - required: - - banner - properties: - banner: - type: string - description: The banner image URL for the media item. - example: /library/metadata/58683/banner/1703239236 - - type: object - required: - - titleSort - properties: - titleSort: - type: string - description: The sort title used for ordering media items. - example: Whale - - type: object - properties: - contentRating: - type: string - description: The content rating for the media item. - example: PG-13 - - type: object - required: - - summary - properties: - summary: - type: string - description: A synopsis of the media item. - example: | - Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. - Once a familiar threat returns to finish what was previously started, Jake must - work with Neytiri and the army of the Na'vi race to protect their home. - - type: object - required: - - rating - properties: - rating: - type: number - format: float - description: The critic rating for the media item. - example: 7.6 - - type: object - required: - - audienceRating - properties: - audienceRating: - type: number - description: The audience rating for the media item. - example: 9.2 - - type: object - properties: - year: - type: integer - format: int32 - description: The release year of the media item. - example: 2022 - - type: object - required: - - tagline - properties: - tagline: - type: string - description: A brief tagline for the media item. - example: Return to Pandora. - - type: object - required: - - thumb - properties: - thumb: - type: string - description: The thumbnail image URL for the media item. - example: /library/metadata/58683/thumb/1703239236 - - type: object - required: - - art - properties: - art: - type: string - description: The art image URL for the media item. - example: /library/metadata/58683/art/1703239236 - - type: object - required: - - theme - properties: - theme: - type: string - description: The theme URL for the media item. - example: /library/metadata/1/theme/1705636920 - - type: object - required: - - index - properties: - index: - type: integer - format: int32 - description: The index position of the media item. - example: 1 - - type: object - properties: - leafCount: - type: integer - format: int32 - description: The number of leaf items (end nodes) under this media item. - example: 14 - - type: object - properties: - viewedLeafCount: - type: integer - format: int32 - description: The number of leaf items that have been viewed. - example: 0 - - type: object - required: - - childCount - properties: - childCount: - type: integer - format: int32 - description: The number of child items associated with this media item. - example: 1 - - type: object - required: - - seasonCount - properties: - seasonCount: - type: integer - format: int32 - description: The total number of seasons (for TV shows). - example: 2022 - - type: object - required: - - duration - properties: - duration: - type: integer - format: int32 - description: The duration of the media item in milliseconds. - example: 11558112 - - type: object - required: - - originallyAvailableAt - properties: - originallyAvailableAt: - type: string - format: date - description: The original release date of the media item. - example: '2022-12-14' - - type: object - required: - - addedAt - properties: - addedAt: - allOf: - - description: Unix timestamp when the item was added. - - type: - - integer - example: 1556281940 - description: Unix epoch datetime in seconds - format: int64 - - type: object - properties: - updatedAt: - type: - - integer - example: 1556281940 - description: Unix epoch datetime in seconds - format: int64 - - type: object - properties: - audienceRatingImage: - type: string - description: The URL for the audience rating image. - example: 'rottentomatoes://image.rating.upright' - - type: object - properties: - chapterSource: - type: string - description: The source from which chapter data is derived. - example: media - - type: object - properties: - primaryExtraKey: - type: string - description: The primary extra key associated with this media item. - example: /library/metadata/58684 - - type: object - properties: - originalTitle: - type: string - description: The original title of the media item (if different). - example: 映画 ブラッククローバー 魔法帝の剣 - - type: object - properties: - parentRatingKey: - type: string - description: The rating key of the parent media item. - example: '66' - - type: object - properties: - grandparentRatingKey: - type: string - description: The rating key of the grandparent media item. - example: '66' - - type: object - properties: - parentGuid: - type: string - description: The GUID of the parent media item. - example: 'plex://show/5d9c081b170e24001f2a7be4' - - type: object - properties: - grandparentGuid: - type: string - description: The GUID of the grandparent media item. - example: 'plex://show/5d9c081b170e24001f2a7be4' - - type: object - properties: - grandparentSlug: - type: string - description: The slug for the grandparent media item. - example: alice-in-borderland-2020 - - type: object - properties: - grandparentKey: - type: string - description: The key of the grandparent media item. - example: /library/metadata/66 - - type: object - properties: - parentKey: - type: string - description: The key of the parent media item. - example: /library/metadata/66 - - type: object - properties: - grandparentTitle: - type: string - description: The title of the grandparent media item. - example: Caprica - - type: object - properties: - grandparentThumb: - type: string - description: The thumbnail URL for the grandparent media item. - example: /library/metadata/66/thumb/1705716261 - - type: object - properties: - grandparentTheme: - type: string - description: The theme URL for the grandparent media item. - example: /library/metadata/66/theme/1705716261 - - type: object - properties: - grandparentArt: - type: string - description: The art URL for the grandparent media item. - example: /library/metadata/66/art/1705716261 - - type: object - properties: - parentTitle: - type: string - description: The title of the parent media item. - example: Caprica - - type: object - properties: - parentIndex: - type: integer - format: int32 - description: The index position of the parent media item. - example: 1 - - type: object - properties: - parentThumb: - type: string - description: The thumbnail URL for the parent media item. - example: /library/metadata/66/thumb/1705716261 - - type: object - properties: - ratingImage: - type: string - description: The URL for the rating image. - example: 'rottentomatoes://image.rating.ripe' - - type: object - properties: - viewCount: - type: integer - format: int32 - description: The number of times this media item has been viewed. - example: 1 - - type: object - properties: - viewOffset: - type: integer - format: int32 - description: The current playback offset (in milliseconds). - example: 5222500 - - type: object - properties: - skipCount: - type: integer - format: int32 - description: The number of times this media item has been skipped. - example: 1 - - type: object - properties: - subtype: - type: string - description: 'A classification that further describes the type of media item. For example, ''clip'' indicates that the item is a short video clip.' - example: clip - - type: object - properties: - lastRatedAt: - type: integer - format: int64 - description: The Unix timestamp representing the last time the item was rated. - example: 1721813113 - - type: object - properties: - createdAtAccuracy: - type: string - description: 'The accuracy of the creation timestamp. This value indicates the format(s) provided (for example, ''epoch,local'' means both epoch and local time formats are available).' - example: 'epoch,local' - - type: object - properties: - createdAtTZOffset: - type: string - description: 'The time zone offset for the creation timestamp, represented as a string. This offset indicates the difference from UTC.' - example: '0' - - type: object - properties: - lastViewedAt: - type: integer - format: int32 - description: Unix timestamp for when the media item was last viewed. - example: 1682752242 - - type: object - properties: - userRating: - type: number - format: float - description: The rating provided by a user for the item. This value is expressed as a decimal number. - example: 10 - - type: object + - Operator + properties: + type: + type: string + example: tag + Operator: + type: array + items: + type: object + required: + - key + - title + properties: + key: + type: string + example: '=' + title: + type: string + example: is + - type: object + required: + - size + - totalSize + - offset + - content + - allowSync + - art + - content + - identifier + - librarySectionID + - librarySectionTitle + - librarySectionUUID + - mediaTagPrefix + - mediaTagVersion + - thumb + - title1 + - title2 + - viewGroup + properties: + size: + type: integer + format: int32 + example: 70 + totalSize: + type: integer + format: int32 + example: 170 + offset: + type: integer + format: int32 + example: 0 + content: + type: string + example: secondary + allowSync: + type: boolean + example: true + nocache: + type: boolean + example: true + art: + type: string + example: '/:/resources/movie-fanart.jpg' + identifier: + type: string + example: com.plexapp.plugins.library + librarySectionID: + type: integer + examples: + - 1 + librarySectionTitle: + type: string + example: Movies + librarySectionUUID: + type: string + example: 322a231a-b7f7-49f5-920f-14c61199cd30 + mediaTagPrefix: + type: string + example: /system/bundle/media/flags/ + mediaTagVersion: + type: integer + format: int32 + example: 1701731894 + thumb: + type: string + example: '/:/resources/movie.png' + title1: + type: string + example: Movies + title2: + type: string + example: Recently Released + viewGroup: + type: string + example: movie + viewMode: + type: integer + format: int32 + example: 65592 + mixedParents: + type: boolean + example: true + Metadata: + type: array + items: + type: object + required: + - ratingKey + - key + - guid + - title + - type + - addedAt + - summary + properties: + ratingKey: + type: string + example: '58683' description: | - The available images for this media item - properties: - Image: - type: array - items: - type: object - required: - - alt - - type - - url - properties: - alt: - type: string - example: Episode 1 - type: - type: string - x-speakeasy-unknown-values: allow + The rating key (Media ID) of this media item. + Note: This is always an integer, but is represented as a string in the API. + key: + type: string + example: /library/metadata/58683 + guid: + type: string + example: 'plex://movie/5d7768ba96b655001fdc0408' + studio: + type: string + example: 20th Century Studios + skipChildren: + type: boolean + example: false + librarySectionID: + type: integer + examples: + - 1 + librarySectionTitle: + type: string + example: Movies + librarySectionKey: + type: string + example: /library/sections/1 + type: + type: string + x-speakeasy-unknown-values: allow + enum: + - movie + - show + - season + - episode + - artist + - album + - track + - photoalbum + - photo + - collection + example: movie + description: | + The type of media content in the Plex library. This can represent videos, music, or photos. + x-speakeasy-enums: + - MOVIE + - TV_SHOW + - SEASON + - EPISODE + - ARTIST + - ALBUM + - TRACK + - PHOTO_ALBUM + - PHOTO + - COLLECTION + title: + type: string + example: 'Avatar: The Way of Water' + slug: + type: string + example: 4-for-texas + contentRating: + type: string + example: PG-13 + summary: + type: string + example: 'Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na''vi race to protect their home.' + rating: + type: number + example: 7.6 + audienceRating: + type: number + example: 9.2 + year: + type: integer + format: int32 + example: 2022 + seasonCount: + type: integer + format: int32 + example: 2022 + tagline: + type: string + example: Return to Pandora. + flattenSeasons: + type: string + description: 'Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show).' + x-speakeasy-unknown-values: allow + enum: + - '-1' + - '0' + - '1' + x-speakeasy-enums: + - LIBRARY_DEFAULT + - HIDE + - SHOW + example: '1' + episodeSort: + type: string + description: 'Setting that indicates how episodes are sorted for the show. (-1 = Library default, 0 = Oldest first, 1 = Newest first).' + x-speakeasy-unknown-values: allow + enum: + - '-1' + - '0' + - '1' + x-speakeasy-enums: + - LIBRARY_DEFAULT + - OLDEST_FIRST + - NEWEST_FIRST + example: '0' + enableCreditsMarkerGeneration: + type: string + description: 'Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled).' + x-speakeasy-unknown-values: allow + enum: + - '-1' + - '0' + x-speakeasy-enums: + - LIBRARY_DEFAULT + - DISABLED + example: '-1' + showOrdering: + type: string + description: | + Setting that indicates the episode ordering for the show. + None = Library default, + tmdbAiring = The Movie Database (Aired), + aired = TheTVDB (Aired), + dvd = TheTVDB (DVD), + absolute = TheTVDB (Absolute)). + x-speakeasy-unknown-values: allow + enum: + - None + - tmdbAiring + - aired + - dvd + - absolute + x-speakeasy-enums: + - NONE + - TMDB_AIRING + - TVDB_AIRED + - TVDB_DVD + - TVDB_ABSOLUTE + example: absolute + thumb: + type: string + example: /library/metadata/58683/thumb/1703239236 + art: + type: string + example: /library/metadata/58683/art/1703239236 + banner: + type: string + example: /library/metadata/58683/banner/1703239236 + duration: + type: integer + format: int32 + example: 11558112 + originallyAvailableAt: + type: string + format: date + example: 2022-12-14T00:00:00.000Z + addedAt: + type: + - integer + example: 1556281940 + description: Unix epoch datetime in seconds + format: int64 + updatedAt: + type: + - integer + example: 1556281940 + description: Unix epoch datetime in seconds + format: int64 + audienceRatingImage: + type: string + example: 'rottentomatoes://image.rating.upright' + chapterSource: + type: string + example: media + primaryExtraKey: + type: string + example: /library/metadata/58684 + ratingImage: + type: string + example: 'rottentomatoes://image.rating.ripe' + grandparentRatingKey: + type: string + example: '66' + grandparentGuid: + type: string + example: 'plex://show/5d9c081b170e24001f2a7be4' + grandparentKey: + type: string + example: /library/metadata/66 + grandparentTitle: + type: string + example: Caprica + grandparentThumb: + type: string + example: /library/metadata/66/thumb/1705716261 + parentSlug: + type: string + example: alice-in-borderland-2020 + grandparentSlug: + type: string + example: alice-in-borderland-2020 + grandparentArt: + type: string + example: /library/metadata/66/art/1705716261 + grandparentTheme: + type: string + example: /library/metadata/66/theme/1705716261 + Media: + description: | + The Media object is only included when type query is `4` or higher. + type: array + items: + type: object + required: + - id + - container + - Part + properties: + id: + type: integer + format: int32 + example: 119534 + duration: + type: integer + format: int32 + example: 11558112 + bitrate: + type: integer + format: int32 + example: 25025 + width: + type: integer + format: int32 + example: 3840 + height: + type: integer + format: int32 + example: 2072 + aspectRatio: + type: number + example: 1.85 + audioProfile: + type: string + example: dts + audioChannels: + type: integer + format: int32 + example: 6 + audioCodec: + type: string + example: eac3 + videoCodec: + type: string + example: hevc + videoResolution: + type: string + example: 4k + container: + type: string + example: mkv + videoFrameRate: + type: string + example: 24p + videoProfile: + type: string + example: main 10 + hasVoiceActivity: + type: boolean + example: false + optimizedForStreaming: + allOf: + - type: integer + format: int32 enum: - - coverPoster - - background - - snapshot - - clearLogo - example: background - url: - type: string - example: /library/metadata/45521/thumb/1644710589 - - type: object - description: | - Unknown - properties: - UltraBlurColors: - type: object - required: - - topLeft - - topRight - - bottomRight - - bottomLeft - properties: - topLeft: - type: string - example: 11333b - topRight: - type: string - example: 0a232d - bottomRight: - type: string - example: 073958 - bottomLeft: - type: string - example: 1f5066 - - type: object - properties: - Guid: - x-speakeasy-name-override: guids - type: array - items: - type: object - required: - - id - properties: - id: - type: string - description: | - The unique identifier for the Guid. Can be prefixed with imdb://, tmdb://, tvdb:// - pattern: '^(imdb|tmdb|tvdb)://.+$' - example: - imdbExample: - summary: IMDB example - value: 'imdb://tt13015952' - tmdbExample: - summary: TMDB example - value: 'tmdb://2434012' - tvdbExample: - summary: TVDB example - value: 'tvdb://7945991' - - type: object - properties: - librarySectionID: - type: integer - description: The identifier for the library section. - example: 1 - - type: object - properties: - librarySectionTitle: - type: string - description: The title of the library section. - example: Movies - - type: object - properties: - librarySectionKey: - type: string - description: The key corresponding to the library section. - example: /library/sections/1 - - type: object - properties: - showOrdering: - type: string - description: | - Setting that indicates the episode ordering for the show. - Options: - - None = Library default - - tmdbAiring = The Movie Database (Aired) - - aired = TheTVDB (Aired) - - dvd = TheTVDB (DVD) - - absolute = TheTVDB (Absolute) - x-speakeasy-unknown-values: allow - enum: - - None - - tmdbAiring - - aired - - dvd - - absolute - x-speakeasy-enums: - - NONE - - TMDB_AIRING - - TVDB_AIRED - - TVDB_DVD - - TVDB_ABSOLUTE - example: absolute - - type: object - properties: - flattenSeasons: - type: string - description: | - Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show). - x-speakeasy-unknown-values: allow - enum: - - '-1' - - '0' - - '1' - x-speakeasy-enums: - - LIBRARY_DEFAULT - - HIDE - - SHOW - example: '1' - - type: object - properties: - skipChildren: - type: boolean - description: Indicates whether child items should be skipped. - example: false - - type: object - properties: - Media: - type: array - items: - allOf: - - type: object - required: - - id - properties: - id: - type: integer - description: Unique media identifier. - example: 387322 - - type: object - required: - - duration - properties: - duration: - type: integer - format: int32 - description: Duration of the media in milliseconds. - example: 9610350 - - type: object - required: - - bitrate - properties: - bitrate: - type: integer - format: int32 - description: Bitrate in bits per second. - example: 25512 - - type: object - required: - - width - properties: - width: - type: integer - format: int32 - description: Video width in pixels. - example: 3840 - - type: object - required: - - height - properties: - height: - type: integer - format: int32 - description: Video height in pixels. - example: 1602 - - type: object - required: - - aspectRatio - properties: - aspectRatio: - type: number - format: float - description: Aspect ratio of the video. - example: 2.35 - - type: object - required: - - audioChannels - properties: - audioChannels: - type: integer - format: int32 - description: Number of audio channels. - example: 6 - - type: object - required: - - displayOffset - properties: - displayOffset: - type: integer - format: int32 - example: 50 - - type: object - required: - - audioCodec - properties: - audioCodec: - type: string - description: Audio codec used. - example: aac - - type: object - required: - - videoCodec - properties: - videoCodec: - type: string - description: Video codec used. - example: hevc - - type: object - required: - - videoResolution - properties: - videoResolution: - type: string - description: 'Video resolution (e.g., 4k).' - example: 4k - - type: object - required: - - container - properties: - container: - type: string - description: Container format of the media. - example: mp4 - - type: object - properties: - videoFrameRate: - type: string - description: | - Frame rate of the video. Values found include NTSC, PAL, 24p - example: 24p - - type: object - properties: - videoProfile: - type: string - description: 'Video profile (e.g., main 10).' - example: main 10 - - type: object - properties: - hasVoiceActivity: - type: boolean - description: Indicates whether voice activity is detected. - example: false - - type: object - properties: - audioProfile: - type: string - description: 'The audio profile used for the media (e.g., DTS, Dolby Digital, etc.).' - example: dts - - type: object - properties: - optimizedForStreaming: - description: 'Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true' - oneOf: - - type: integer - format: int32 - enum: - - 0 - - 1 - - type: boolean - enum: - - true - - false - - type: object - properties: - has64bitOffsets: - description: | - Indicates whether the media has 64-bit offsets. - This is relevant for media files that may require larger offsets than what 32-bit integers can provide. - type: boolean - example: false - - type: object - properties: - Part: - type: array - items: - allOf: - - type: object - required: - - accessible - properties: - accessible: - type: boolean - description: Indicates if the part is accessible. - example: true - - type: object - properties: - exists: - type: boolean - description: Indicates if the part exists. - example: true - - type: object - required: - - id - properties: - id: - type: integer - description: Unique part identifier. - example: 418385 - - type: object - required: - - key - properties: - key: - type: string - description: Key to access this part. - example: /library/parts/418385/1735864239/file.mkv - - type: object - required: - - indexes - properties: - indexes: - type: string - example: sd - - type: object - required: - - duration - properties: - duration: - type: integer - format: int32 - description: Duration of the part in milliseconds. - example: 9610350 - - type: object - required: - - file - properties: - file: - type: string - description: File path for the part. - example: /mnt/Movies_1/W/Wicked (2024).mkv - - type: object - required: - - size - properties: - size: - description: File size in bytes. - type: integer - example: 30649952104 - - type: object - required: - - packetLength - properties: - packetLength: - type: integer - format: int32 - example: 188 - - type: object - required: - - container - properties: - container: - type: string - description: Container format of the part. - example: mkv - - type: object - properties: - videoProfile: - type: string - description: Video profile for the part. - example: main 10 - - type: object - properties: - audioProfile: - type: string - description: 'The audio profile used for the media (e.g., DTS, Dolby Digital, etc.).' - example: dts - - type: object - properties: - has64bitOffsets: - type: boolean - example: false - - type: object - properties: - optimizedForStreaming: - description: | - Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true - oneOf: - - type: integer - format: int32 - enum: - - 0 - - 1 - - type: boolean - enum: - - true - - false - - type: object - properties: - hasThumbnail: - allOf: - - description: | - Indicates if the part has a thumbnail. - - type: string - enum: - - '0' - - '1' - example: '1' - default: '0' - x-speakeasy-enums: - - false - - true - Genre: - type: array - items: - allOf: - - type: object - required: - - id - properties: - id: - description: | - The unique identifier for the genre. - NOTE: This is different for each Plex server and is not globally unique. - type: integer - format: int32 - minimum: 1 - example: 259 - - type: object - required: - - tag - properties: - tag: - type: string - description: | - The genre name of this media-item - example: Crime - Country: - type: array - items: - allOf: - - type: object - required: - - id - properties: - id: - description: | - The unique identifier for the country. - NOTE: This is different for each Plex server and is not globally unique. - type: integer - format: int32 - minimum: 1 - example: 259 - - type: object - required: - - tag - properties: - tag: - type: string - description: The country of origin of this media item - example: United States of America - Director: - type: array - items: - allOf: - - type: object - required: - - id - properties: - id: - description: Unique identifier for the director. - type: integer - format: int32 - minimum: 1 - example: 126522 - - type: object - required: - - tag - properties: - tag: - type: string - description: The role of Director - example: Danny Boyle - - type: object - properties: - thumb: - description: The absolute URL of the thumbnail image for the director. - type: string - example: 'https://metadata-static.plex.tv/8/people/8d65fa96804802e08f2de09fe014408e.jpg' - Writer: - type: array - items: - allOf: - - type: object - required: - - id - properties: - id: - description: Unique identifier for the writer. - type: integer - format: int32 - minimum: 1 - example: 126522 - - type: object - required: - - tag - properties: - tag: - type: string - description: The role of Writer - example: Jamie P. Hanson - - type: object - properties: - thumb: - description: The absolute URL of the thumbnail image for the writer. - type: string - example: 'https://metadata-static.plex.tv/8/people/8d65fa96804802e08f2de09fe014408e.jpg' - Producer: - type: array - items: - allOf: - - type: object - required: - - id - - filter - - tag - - tagKey - properties: - id: - type: integer - description: The unique role identifier. - example: 109501 - filter: - type: string - description: The filter string for the role. - example: actor=109501 - tag: - type: string - description: The actor's name. - example: Bob Odenkirk - tagKey: - type: string - description: A key associated with the actor tag. - example: 5d77683254f42c001f8c3f69 - role: - type: string - description: The character name or role. - example: Jimmy McGill - thumb: - type: string - description: URL for the role thumbnail image. - example: 'https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg' - Collection: - type: array - items: - allOf: - - type: object - required: - - tag - properties: - tag: - type: string - description: The user-made collection this media item belongs to - example: My Awesome Collection - Role: - type: array - items: - allOf: - - type: object - required: - - id - properties: - id: - description: | - The unique identifier for the role. - NOTE: This is different for each Plex server and is not globally unique. - type: integer - format: int32 - minimum: 1 - example: 126522 - - type: object - required: - - tag - properties: - tag: - description: The display tag for the actor (typically the actor's name). - type: string - example: Teller - - type: object - properties: - role: - description: The role played by the actor in the media item. - type: string - example: Self - Judge - - type: object - properties: - thumb: - description: The absolute URL of the thumbnail image for the actor. - type: string - example: 'https://metadata-static.plex.tv/7/people/708568fd018d7aa8b1032dcf867747e8.jpg' - Rating: - x-speakeasy-name-override: Ratings - type: array - items: - type: object - required: - - image - - value - - type - properties: - image: - type: string - description: The image or reference for the rating. - example: 'imdb://image.rating' - value: - type: number - format: float - description: The rating value. - example: 9 - type: - type: string - description: 'The type of rating (e.g., audience, critic).' - example: audience - Similar: - type: array - items: - type: object - required: - - id - - filter - - tag - properties: - id: - type: integer - description: The unique similar item identifier. - example: 26 - filter: - type: string - description: The filter string for similar items. - example: similar=26 - tag: - type: string - description: The tag or title of the similar content. - example: Breaking Bad - Location: - type: array - items: - allOf: - - type: object - required: - - path - - type: object - required: - - path - description: The folder path for the media item. - properties: - path: - type: string - example: /TV Shows/Clarkson's Farm - Chapter: - type: array - items: - allOf: - - type: object - required: - - id - description: The identifier for the chapter - properties: - id: - type: integer - example: 4 - - type: object - required: - - filter - description: The filter for the chapter - properties: - filter: - type: string - example: thumb=4 - - type: object - required: - - index - description: The index for the chapter - properties: - index: - type: integer - example: 1 - - type: object - required: - - startTimeOffset - description: The start time offset for the chapter - properties: - startTimeOffset: - type: integer - example: 0 - - type: object - required: - - endTimeOffset - description: The end time offset for the chapter - properties: - endTimeOffset: - type: integer - example: 100100 - - type: object - required: - - thumb - description: The thumbnail for the chapter - properties: - thumb: - type: string - example: /library/media/46883/chapterImages/1 - Marker: - type: array - items: - allOf: - - type: object - required: - - id - description: The identifier for the marker - properties: - id: - type: integer - example: 306970 - - type: object - required: - - type - description: The type of the marker - properties: - type: - type: string - example: credits - - type: object - required: - - startTimeOffset - description: The start time offset for the marker - properties: - startTimeOffset: - type: integer - example: 4176050 - - type: object - required: - - endTimeOffset - description: The end time offset for the marker - properties: - endTimeOffset: - type: integer - example: 4393389 - - type: object - description: The final status of the marker - properties: - final: - type: boolean - example: true - - type: object - properties: - Attributes: + - 0 + - 1 + example: 1 + default: 0 + x-speakeasy-enums: + - DISABLE + - ENABLE + has64bitOffsets: + type: boolean + example: false + Part: + type: array + items: + type: object + required: + - id + - key + - file + - size + - container + properties: + id: + type: integer + format: int32 + example: 119542 + key: + type: string + example: /library/parts/119542/1680457526/file.mkv + duration: + type: integer + format: int32 + example: 11558112 + file: + type: string + example: /movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv + size: + type: integer + format: int64 + example: 36158371307 + container: + type: string + description: | + The container format of the media file. + example: mkv + audioProfile: + type: string + example: dts + has64bitOffsets: + type: boolean + example: false + optimizedForStreaming: + type: boolean + example: false + videoProfile: + type: string + example: main 10 + indexes: + type: string + example: sd + hasThumbnail: + type: string + enum: + - '0' + - '1' + example: '1' + default: '0' + x-speakeasy-enums: + - false + - true + Stream: + type: array + items: type: object - description: Attributes associated with the marker. required: - id + - streamType + - codec + - index properties: id: type: integer - description: The identifier for the attributes. - example: 306970 - version: + example: 272796 + streamType: type: integer - description: The version number of the marker attributes. + description: 'Type of stream (1 = video, 2 = audio, 3 = subtitle)' + example: 1 + default: + type: boolean + description: Indicates if this is the default stream + example: true + selected: + type: boolean + description: Indicates if the stream is selected + example: true + codec: + type: string + description: Codec used by the stream + example: h264 + index: + type: integer + description: The index of the stream + example: 0 + bitrate: + type: integer + description: The bitrate of the stream in kbps + example: 6273 + colorPrimaries: + type: string + description: The color primaries of the video stream + example: bt709 + colorRange: + type: string + description: The color range of the video stream + example: tv + colorSpace: + type: string + description: The color space of the video stream + example: bt709 + colorTrc: + type: string + description: The transfer characteristics (TRC) of the video stream + example: bt709 + bitDepth: + type: integer + description: The bit depth of the video stream + example: 8 + chromaLocation: + type: string + description: The chroma location of the video stream + example: left + streamIdentifier: + type: string + description: The identifier of the video stream + example: '2' + chromaSubsampling: + type: string + description: The chroma subsampling format + example: '4:2:0' + codedHeight: + type: integer + description: The coded height of the video stream + example: 1088 + codedWidth: + type: integer + description: The coded width of the video stream + example: 1920 + frameRate: + type: number + description: The frame rate of the video stream + example: 29.97 + hasScalingMatrix: + type: boolean + description: Indicates if the stream has a scaling matrix + example: false + hearingImpaired: + type: boolean + example: false + closedCaptions: + type: boolean + example: false + embeddedInVideo: + type: string + example: '1' + height: + type: integer + description: The height of the video stream + example: 1080 + level: + type: integer + description: The level of the video codec + example: 40 + profile: + type: string + description: The profile of the video codec + example: main + refFrames: + type: integer + description: Number of reference frames example: 4 - Extras: - type: object - properties: - size: - type: integer - description: The size of the extras. - example: 1 + scanType: + type: string + description: The scan type (progressive or interlaced) + example: progressive + width: + type: integer + description: The width of the video stream + example: 1920 + displayTitle: + type: string + description: Display title of the stream + example: 1080p (H.264) + extendedDisplayTitle: + type: string + description: Extended display title of the stream + example: 1080p (H.264) + channels: + type: integer + description: Number of audio channels (for audio streams) + example: 2 + language: + type: string + description: The language of the stream (for audio/subtitle streams) + example: English + languageTag: + type: string + description: Language tag of the stream + example: en + languageCode: + type: string + description: Language code of the stream + example: eng + audioChannelLayout: + type: string + description: The audio channel layout + example: stereo + samplingRate: + type: integer + description: Sampling rate of the audio stream in Hz + example: 48000 + title: + type: string + description: Title of the subtitle track (for subtitle streams) + example: English + canAutoSync: + type: boolean + description: Indicates if the subtitle stream can auto-sync + example: false + Genre: + type: array + items: + type: object + properties: + tag: + type: string + example: Adventure + Country: + type: array + items: + type: object + properties: + tag: + type: string + example: United States of America + Director: + type: array + items: + type: object + properties: + tag: + type: string + example: James Cameron + Writer: + type: array + items: + type: object + properties: + tag: + type: string + example: James Cameron + Collection: + type: array + items: + type: object + properties: + tag: + type: string + example: Working NL Subs + Role: + type: array + items: + type: object + properties: + id: + type: integer + description: The ID of the tag or actor. + example: 294129 + filter: + type: string + description: The filter used to find the actor or tag. + example: actor=294129 + thumb: + type: string + description: The thumbnail of the actor + example: 'https://metadata-static.plex.tv/2/people/27b85844536c39f3f9ac943aaad46608.jpg' + tag: + type: string + description: The name of the tag or actor. + example: Mike Smith + tagKey: + type: string + description: Unique identifier for the tag. + example: 668e7e7b22bcad9064350c91 + role: + type: string + description: The role of the actor or tag in the media. + example: Self + Location: + type: array + items: + type: object + properties: + path: + type: string + example: /TV Shows/House + Guid: + x-speakeasy-name-override: MediaGuid + description: | + The Guid object is only included in the response if the `includeGuids` parameter is set to `1`. + type: array + items: + type: object + required: + - id + properties: + id: + type: string + description: | + Can be one of the following formats: + imdb://tt13015952, tmdb://2434012, tvdb://7945991 + example: 'imdb://tt13015952' + UltraBlurColors: + type: object + required: + - topLeft + - topRight + - bottomRight + - bottomLeft + properties: + topLeft: + type: string + example: 11333b + topRight: + type: string + example: 0a232d + bottomRight: + type: string + example: 073958 + bottomLeft: + type: string + example: 1f5066 + Rating: + x-speakeasy-name-override: MetaDataRating + type: array + items: + type: object + required: + - image + - value + - type + properties: + image: + type: string + description: A URI or path to the rating image. + example: 'themoviedb://image.rating' + value: + type: number + format: float + description: The value of the rating. + example: 3 + type: + type: string + description: 'The type of rating (e.g., audience, critic).' + example: audience + Image: + type: array + items: + type: object + required: + - alt + - type + - url + properties: + alt: + type: string + example: Episode 1 + type: + type: string + x-speakeasy-unknown-values: allow + enum: + - coverPoster + - background + - snapshot + - clearLogo + example: background + url: + type: string + example: /library/metadata/45521/thumb/1644710589 + titleSort: + type: string + example: Whale + viewCount: + type: integer + format: int32 + example: 1 + lastViewedAt: + type: integer + format: int32 + example: 1682752242 + originalTitle: + type: string + example: 映画 ブラッククローバー 魔法帝の剣 + viewOffset: + type: integer + format: int32 + example: 5222500 + skipCount: + type: integer + format: int32 + example: 1 + index: + type: integer + format: int32 + example: 1 + theme: + type: string + example: /library/metadata/1/theme/1705636920 + leafCount: + type: integer + format: int32 + example: 14 + viewedLeafCount: + type: integer + format: int32 + example: 0 + childCount: + type: integer + format: int32 + example: 1 + hasPremiumExtras: + type: string + example: '1' + hasPremiumPrimaryExtra: + type: string + example: '1' + parentRatingKey: + type: string + description: | + The rating key of the parent item. + example: '66' + parentGuid: + type: string + example: 'plex://show/5d9c081b170e24001f2a7be4' + parentStudio: + type: string + example: UCP + parentKey: + type: string + example: /library/metadata/66 + parentTitle: + type: string + example: Caprica + parentIndex: + type: integer + format: int32 + example: 1 + parentYear: + type: integer + format: int32 + example: 2010 + parentThumb: + type: string + example: /library/metadata/66/thumb/1705716261 + parentTheme: + type: string + example: /library/metadata/66/theme/1705716261 Meta: description: | The Meta object is only included in the response if the `includeMeta` parameter is set to `1`. @@ -7916,18 +7548,24 @@ paths: description: An plugin identifier for the media container. example: com.plexapp.plugins.library - type: object + required: + - librarySectionID properties: librarySectionID: type: integer description: The unique identifier for the library section. example: 2 - type: object + required: + - librarySectionTitle properties: librarySectionTitle: type: string description: The title of the library section. example: TV Series - type: object + required: + - librarySectionTitle properties: librarySectionUUID: type: string @@ -8846,22 +8484,22 @@ paths: example: 1002625 streamType: type: integer - oneOf: - - title: VIDEO - const: 1 - description: Video stream - - title: AUDIO - const: 2 - description: Audio stream - - title: SUBTITLE - const: 3 - description: Subtitle stream - example: 1 + format: int32 description: | Stream type: - - VIDEO = 1 - - AUDIO = 2 - - SUBTITLE = 3 + - 1 = video + - 2 = audio + - 3 = subtitle + enum: + - 1 + - 2 + - 3 + example: 1 + x-speakeasy-unknown-values: allow + x-speakeasy-enums: + - VIDEO + - AUDIO + - SUBTITLE format: type: string description: 'Format of the stream (e.g., srt).' @@ -10208,6 +9846,8 @@ paths: description: Identifier for the view group layout. example: secondary - type: object + required: + - viewMode properties: viewMode: type: string @@ -10395,1198 +10035,780 @@ paths: - MediaContainer properties: MediaContainer: - allOf: - - type: object - required: - - size - properties: - size: - description: Number of media items returned in this response. - type: integer - format: int32 - example: 50 - - type: object - required: - - allowSync - properties: - allowSync: - type: boolean - description: Indicates whether syncing is allowed. - example: false - - type: object - required: - - identifier - properties: - identifier: - type: string - description: An plugin identifier for the media container. - example: com.plexapp.plugins.library - - type: object - properties: - librarySectionID: - type: integer - description: The unique identifier for the library section. - example: 2 - - type: object - properties: - librarySectionTitle: - type: string - description: The title of the library section. - example: TV Series - - type: object - properties: - librarySectionUUID: - type: string - description: The universally unique identifier for the library section. - example: e69655a2-ef48-4aba-bb19-0cc34d1e7d36 - - type: object - required: - - mediaTagPrefix - properties: - mediaTagPrefix: - type: string - description: The prefix used for media tag resource paths. - example: /system/bundle/media/flags/ - - type: object - required: - - mediaTagVersion - properties: - mediaTagVersion: - type: integer - description: The version number for media tags. - example: 1734362201 - - type: object - required: - - SearchResult - properties: - SearchResult: - type: array - items: - allOf: - - type: object - required: - - score - - type: object - properties: - score: - description: 'The score of the search result, typically a float value between 0 and 1.' - type: number - format: float - example: 0.92 - - type: object - properties: - Directory: - allOf: - - type: object + type: object + required: + - size + - SearchResult + properties: + size: + type: number + SearchResult: + type: array + items: + type: object + required: + - score + - Metadata + properties: + score: + type: number + format: float + Metadata: + type: object + required: + - ratingKey + - key + - guid + - title + - type + - addedAt + - summary + properties: + ratingKey: + type: string + example: '58683' + description: | + The rating key (Media ID) of this media item. + Note: This is always an integer, but is represented as a string in the API. + key: + type: string + example: /library/metadata/58683 + guid: + type: string + example: 'plex://movie/5d7768ba96b655001fdc0408' + studio: + type: string + example: 20th Century Studios + skipChildren: + type: boolean + example: false + librarySectionID: + type: integer + examples: + - 1 + librarySectionTitle: + type: string + example: Movies + librarySectionKey: + type: string + example: /library/sections/1 + type: + type: string + x-speakeasy-unknown-values: allow + enum: + - movie + - show + - season + - episode + - artist + - album + - track + - photoalbum + - photo + - collection + example: movie + description: | + The type of media content in the Plex library. This can represent videos, music, or photos. + x-speakeasy-enums: + - MOVIE + - TV_SHOW + - SEASON + - EPISODE + - ARTIST + - ALBUM + - TRACK + - PHOTO_ALBUM + - PHOTO + - COLLECTION + title: + type: string + example: 'Avatar: The Way of Water' + slug: + type: string + example: 4-for-texas + contentRating: + type: string + example: PG-13 + summary: + type: string + example: 'Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na''vi race to protect their home.' + rating: + type: number + example: 7.6 + audienceRating: + type: number + example: 9.2 + year: + type: integer + format: int32 + example: 2022 + seasonCount: + type: integer + format: int32 + example: 2022 + tagline: + type: string + example: Return to Pandora. + flattenSeasons: + type: string + description: 'Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show).' + x-speakeasy-unknown-values: allow + enum: + - '-1' + - '0' + - '1' + x-speakeasy-enums: + - LIBRARY_DEFAULT + - HIDE + - SHOW + example: '1' + episodeSort: + type: string + description: 'Setting that indicates how episodes are sorted for the show. (-1 = Library default, 0 = Oldest first, 1 = Newest first).' + x-speakeasy-unknown-values: allow + enum: + - '-1' + - '0' + - '1' + x-speakeasy-enums: + - LIBRARY_DEFAULT + - OLDEST_FIRST + - NEWEST_FIRST + example: '0' + enableCreditsMarkerGeneration: + type: string + description: 'Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled).' + x-speakeasy-unknown-values: allow + enum: + - '-1' + - '0' + x-speakeasy-enums: + - LIBRARY_DEFAULT + - DISABLED + example: '-1' + showOrdering: + type: string + description: | + Setting that indicates the episode ordering for the show. + None = Library default, + tmdbAiring = The Movie Database (Aired), + aired = TheTVDB (Aired), + dvd = TheTVDB (DVD), + absolute = TheTVDB (Absolute)). + x-speakeasy-unknown-values: allow + enum: + - None + - tmdbAiring + - aired + - dvd + - absolute + x-speakeasy-enums: + - NONE + - TMDB_AIRING + - TVDB_AIRED + - TVDB_DVD + - TVDB_ABSOLUTE + example: absolute + thumb: + type: string + example: /library/metadata/58683/thumb/1703239236 + art: + type: string + example: /library/metadata/58683/art/1703239236 + banner: + type: string + example: /library/metadata/58683/banner/1703239236 + duration: + type: integer + format: int32 + example: 11558112 + originallyAvailableAt: + type: string + format: date + example: 2022-12-14T00:00:00.000Z + addedAt: + type: + - integer + example: 1556281940 + description: Unix epoch datetime in seconds + format: int64 + updatedAt: + type: + - integer + example: 1556281940 + description: Unix epoch datetime in seconds + format: int64 + audienceRatingImage: + type: string + example: 'rottentomatoes://image.rating.upright' + chapterSource: + type: string + example: media + primaryExtraKey: + type: string + example: /library/metadata/58684 + ratingImage: + type: string + example: 'rottentomatoes://image.rating.ripe' + grandparentRatingKey: + type: string + example: '66' + grandparentGuid: + type: string + example: 'plex://show/5d9c081b170e24001f2a7be4' + grandparentKey: + type: string + example: /library/metadata/66 + grandparentTitle: + type: string + example: Caprica + grandparentThumb: + type: string + example: /library/metadata/66/thumb/1705716261 + parentSlug: + type: string + example: alice-in-borderland-2020 + grandparentSlug: + type: string + example: alice-in-borderland-2020 + grandparentArt: + type: string + example: /library/metadata/66/art/1705716261 + grandparentTheme: + type: string + example: /library/metadata/66/theme/1705716261 + Media: + description: | + The Media object is only included when type query is `4` or higher. + type: array + items: + type: object + required: + - id + - container + - Part + properties: + id: + type: integer + format: int32 + example: 119534 + duration: + type: integer + format: int32 + example: 11558112 + bitrate: + type: integer + format: int32 + example: 25025 + width: + type: integer + format: int32 + example: 3840 + height: + type: integer + format: int32 + example: 2072 + aspectRatio: + type: number + example: 1.85 + audioProfile: + type: string + example: dts + audioChannels: + type: integer + format: int32 + example: 6 + audioCodec: + type: string + example: eac3 + videoCodec: + type: string + example: hevc + videoResolution: + type: string + example: 4k + container: + type: string + example: mkv + videoFrameRate: + type: string + example: 24p + videoProfile: + type: string + example: main 10 + hasVoiceActivity: + type: boolean + example: false + optimizedForStreaming: + allOf: + - type: integer + format: int32 + enum: + - 0 + - 1 + example: 1 + default: 0 + x-speakeasy-enums: + - DISABLE + - ENABLE + has64bitOffsets: + type: boolean + example: false + Part: + type: array + items: + type: object required: - - key - - librarySectionID - - librarySectionKey - - librarySectionTitle - - type - id - - tag - - type: object - properties: - key: - description: The unique identifier path for the search result item. - type: string - example: /library/sections/3/all?actor=197429 - - type: object - properties: - librarySectionID: - type: integer - description: The identifier for the library section. - example: 1 - - type: object - properties: - librarySectionKey: - type: string - description: The key corresponding to the library section. - example: /library/sections/1 - - type: object - properties: - librarySectionTitle: - type: string - description: The title of the library section. - example: Movies - - type: object - properties: - librarySectionType: - type: integer - oneOf: - - const: 1 - title: Movie - - const: 2 - title: TV Show - - type: object - properties: - type: - description: The type of the directory. - type: string - example: tag - - type: object + - key + - file + - size + - container properties: id: type: integer - example: 197429 - - type: object - properties: - filter: - description: The filter string used to query this specific item in the library. - type: string - example: actor=197429 - - type: object - properties: - tag: - type: string - example: Ben Stiller - - type: object - properties: - tagType: - description: 'The type of tag associated with this search result (e.g., Director, Actor).' - type: integer - oneOf: - - const: 4 - title: Director - - const: 6 - title: Actor - - type: object - properties: - tagKey: - description: The unique identifier for the tag associated with this search result. - type: string - example: 5d776826999c64001ec2c606 - - type: object - properties: - thumb: - description: The URL to the thumbnail image associated with this search result. - type: string - format: uri - example: 'https://metadata-static.plex.tv/5/people/57bd7c7d6c5c9e2881251b30e5603d3d.jpg' - - type: object - properties: - count: - description: The number of items associated with this search result. - type: integer - example: 10 - Metadata: - type: object - allOf: - - type: object - required: - - ratingKey - properties: - ratingKey: - type: string - description: 'The rating key (Media ID) of this media item. Note: Although this is always an integer, it is represented as a string in the API.' - example: '58683' - - type: object - required: - - key - properties: + format: int32 + example: 119542 key: type: string - description: The unique key for the media item. - example: /library/metadata/58683 - - type: object - required: - - guid - properties: - guid: - type: string - description: The globally unique identifier for the media item. - example: 'plex://movie/5d7768ba96b655001fdc0408' - - type: object - required: - - slug - properties: - slug: - type: string - description: A URL‐friendly version of the media title. - example: 4-for-texas - - type: object - properties: - studio: - type: string - description: The studio that produced the media item. - example: 20th Century Studios - - type: object - required: - - type - properties: - type: - allOf: - - type: string - x-speakeasy-unknown-values: allow - enum: - - movie - - show - - season - - episode - - artist - - album - - track - - photoalbum - - photo - - collection - example: movie - description: | - The type of media content in the Plex library. This can represent videos, music, or photos. - x-speakeasy-enums: - - MOVIE - - TV_SHOW - - SEASON - - EPISODE - - ARTIST - - ALBUM - - TRACK - - PHOTO_ALBUM - - PHOTO - - COLLECTION - - type: object - required: - - title - properties: - title: - type: string - description: The title of the media item. - example: 'Avatar: The Way of Water' - - type: object - required: - - banner - properties: - banner: - type: string - description: The banner image URL for the media item. - example: /library/metadata/58683/banner/1703239236 - - type: object - required: - - titleSort - properties: - titleSort: - type: string - description: The sort title used for ordering media items. - example: Whale - - type: object - properties: - contentRating: - type: string - description: The content rating for the media item. - example: PG-13 - - type: object - required: - - summary - properties: - summary: - type: string - description: A synopsis of the media item. - example: | - Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. - Once a familiar threat returns to finish what was previously started, Jake must - work with Neytiri and the army of the Na'vi race to protect their home. - - type: object - required: - - rating - properties: - rating: - type: number - format: float - description: The critic rating for the media item. - example: 7.6 - - type: object - required: - - audienceRating - properties: - audienceRating: - type: number - description: The audience rating for the media item. - example: 9.2 - - type: object - properties: - year: - type: integer - format: int32 - description: The release year of the media item. - example: 2022 - - type: object - required: - - tagline - properties: - tagline: - type: string - description: A brief tagline for the media item. - example: Return to Pandora. - - type: object - required: - - thumb - properties: - thumb: - type: string - description: The thumbnail image URL for the media item. - example: /library/metadata/58683/thumb/1703239236 - - type: object - required: - - art - properties: - art: - type: string - description: The art image URL for the media item. - example: /library/metadata/58683/art/1703239236 - - type: object - required: - - theme - properties: - theme: - type: string - description: The theme URL for the media item. - example: /library/metadata/1/theme/1705636920 - - type: object - required: - - index - properties: - index: - type: integer - format: int32 - description: The index position of the media item. - example: 1 - - type: object - properties: - leafCount: - type: integer - format: int32 - description: The number of leaf items (end nodes) under this media item. - example: 14 - - type: object - properties: - viewedLeafCount: - type: integer - format: int32 - description: The number of leaf items that have been viewed. - example: 0 - - type: object - required: - - childCount - properties: - childCount: - type: integer - format: int32 - description: The number of child items associated with this media item. - example: 1 - - type: object - required: - - seasonCount - properties: - seasonCount: - type: integer - format: int32 - description: The total number of seasons (for TV shows). - example: 2022 - - type: object - required: - - duration - properties: + example: /library/parts/119542/1680457526/file.mkv duration: type: integer format: int32 - description: The duration of the media item in milliseconds. example: 11558112 - - type: object - required: - - originallyAvailableAt - properties: - originallyAvailableAt: + file: type: string - format: date - description: The original release date of the media item. - example: '2022-12-14' - - type: object - required: - - addedAt - properties: - addedAt: - allOf: - - description: Unix timestamp when the item was added. - - type: - - integer - example: 1556281940 - description: Unix epoch datetime in seconds - format: int64 - - type: object - properties: - updatedAt: - type: - - integer - example: 1556281940 - description: Unix epoch datetime in seconds - format: int64 - - type: object - properties: - parentYear: - type: integer - format: int32 - description: The release year of the parent media item. - example: 2010 - - type: object - properties: - audienceRatingImage: - type: string - description: The URL for the audience rating image. - example: 'rottentomatoes://image.rating.upright' - - type: object - properties: - chapterSource: - type: string - description: The source from which chapter data is derived. - example: media - - type: object - properties: - primaryExtraKey: - type: string - description: The primary extra key associated with this media item. - example: /library/metadata/58684 - - type: object - properties: - originalTitle: - type: string - description: The original title of the media item (if different). - example: 映画 ブラッククローバー 魔法帝の剣 - - type: object - properties: - parentRatingKey: - type: string - description: The rating key of the parent media item. - example: '66' - - type: object - properties: - grandparentRatingKey: - type: string - description: The rating key of the grandparent media item. - example: '66' - - type: object - properties: - parentGuid: - type: string - description: The GUID of the parent media item. - example: 'plex://show/5d9c081b170e24001f2a7be4' - - type: object - properties: - grandparentGuid: - type: string - description: The GUID of the grandparent media item. - example: 'plex://show/5d9c081b170e24001f2a7be4' - - type: object - properties: - grandparentSlug: - type: string - description: The slug for the grandparent media item. - example: alice-in-borderland-2020 - - type: object - properties: - grandparentKey: - type: string - description: The key of the grandparent media item. - example: /library/metadata/66 - - type: object - properties: - parentKey: - type: string - description: The key of the parent media item. - example: /library/metadata/66 - - type: object - properties: - grandparentTitle: - type: string - description: The title of the grandparent media item. - example: Caprica - - type: object - properties: - grandparentThumb: - type: string - description: The thumbnail URL for the grandparent media item. - example: /library/metadata/66/thumb/1705716261 - - type: object - properties: - grandparentTheme: - type: string - description: The theme URL for the grandparent media item. - example: /library/metadata/66/theme/1705716261 - - type: object - properties: - grandparentArt: - type: string - description: The art URL for the grandparent media item. - example: /library/metadata/66/art/1705716261 - - type: object - properties: - parentTitle: - type: string - description: The title of the parent media item. - example: Caprica - - type: object - properties: - parentIndex: - type: integer - format: int32 - description: The index position of the parent media item. - example: 1 - - type: object - properties: - parentThumb: - type: string - description: The thumbnail URL for the parent media item. - example: /library/metadata/66/thumb/1705716261 - - type: object - properties: - ratingImage: - type: string - description: The URL for the rating image. - example: 'rottentomatoes://image.rating.ripe' - - type: object - properties: - viewCount: - type: integer - format: int32 - description: The number of times this media item has been viewed. - example: 1 - - type: object - properties: - viewOffset: - type: integer - format: int32 - description: The current playback offset (in milliseconds). - example: 5222500 - - type: object - properties: - skipCount: - type: integer - format: int32 - description: The number of times this media item has been skipped. - example: 1 - - type: object - properties: - subtype: - type: string - description: 'A classification that further describes the type of media item. For example, ''clip'' indicates that the item is a short video clip.' - example: clip - - type: object - properties: - lastRatedAt: + example: /movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv + size: type: integer format: int64 - description: The Unix timestamp representing the last time the item was rated. - example: 1721813113 - - type: object - properties: - createdAtAccuracy: + example: 36158371307 + container: type: string - description: 'The accuracy of the creation timestamp. This value indicates the format(s) provided (for example, ''epoch,local'' means both epoch and local time formats are available).' - example: 'epoch,local' - - type: object - properties: - createdAtTZOffset: + description: | + The container format of the media file. + example: mkv + audioProfile: type: string - description: 'The time zone offset for the creation timestamp, represented as a string. This offset indicates the difference from UTC.' - example: '0' - - type: object - properties: - lastViewedAt: - type: integer - format: int32 - description: Unix timestamp for when the media item was last viewed. - example: 1682752242 - - type: object - properties: - userRating: - type: number - format: float - description: The rating provided by a user for the item. This value is expressed as a decimal number. - example: 10 - - type: object - description: | - The available images for this media item - properties: - Image: - type: array - items: - type: object - required: - - alt - - type - - url - properties: - alt: - type: string - example: Episode 1 - type: - type: string - x-speakeasy-unknown-values: allow - enum: - - coverPoster - - background - - snapshot - - clearLogo - example: background - url: - type: string - example: /library/metadata/45521/thumb/1644710589 - - type: object - description: | - Unknown - properties: - UltraBlurColors: - type: object - required: - - topLeft - - topRight - - bottomRight - - bottomLeft - properties: - topLeft: - type: string - example: 11333b - topRight: - type: string - example: 0a232d - bottomRight: - type: string - example: 073958 - bottomLeft: - type: string - example: 1f5066 - - type: object - properties: - Guid: - x-speakeasy-name-override: guids + example: dts + has64bitOffsets: + type: boolean + example: false + optimizedForStreaming: + type: boolean + example: false + videoProfile: + type: string + example: main 10 + indexes: + type: string + example: sd + hasThumbnail: + type: string + enum: + - '0' + - '1' + example: '1' + default: '0' + x-speakeasy-enums: + - false + - true + Stream: type: array items: type: object required: - id + - streamType + - codec + - index properties: id: + type: integer + example: 272796 + streamType: + type: integer + description: 'Type of stream (1 = video, 2 = audio, 3 = subtitle)' + example: 1 + default: + type: boolean + description: Indicates if this is the default stream + example: true + selected: + type: boolean + description: Indicates if the stream is selected + example: true + codec: type: string - description: | - The unique identifier for the Guid. Can be prefixed with imdb://, tmdb://, tvdb:// - pattern: '^(imdb|tmdb|tvdb)://.+$' - example: - imdbExample: - summary: IMDB example - value: 'imdb://tt13015952' - tmdbExample: - summary: TMDB example - value: 'tmdb://2434012' - tvdbExample: - summary: TVDB example - value: 'tvdb://7945991' - - type: object - properties: - librarySectionID: - type: integer - description: The identifier for the library section. - example: 1 - - type: object - properties: - librarySectionTitle: - type: string - description: The title of the library section. - example: Movies - - type: object - properties: - librarySectionKey: - type: string - description: The key corresponding to the library section. - example: /library/sections/1 - - type: object - properties: - showOrdering: - type: string - description: | - Setting that indicates the episode ordering for the show. - Options: - - None = Library default - - tmdbAiring = The Movie Database (Aired) - - aired = TheTVDB (Aired) - - dvd = TheTVDB (DVD) - - absolute = TheTVDB (Absolute) - x-speakeasy-unknown-values: allow - enum: - - None - - tmdbAiring - - aired - - dvd - - absolute - x-speakeasy-enums: - - NONE - - TMDB_AIRING - - TVDB_AIRED - - TVDB_DVD - - TVDB_ABSOLUTE - example: absolute - - type: object - properties: - flattenSeasons: - type: string - description: | - Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show). - x-speakeasy-unknown-values: allow - enum: - - '-1' - - '0' - - '1' - x-speakeasy-enums: - - LIBRARY_DEFAULT - - HIDE - - SHOW - example: '1' - - type: object - properties: - skipChildren: - type: boolean - description: Indicates whether child items should be skipped. - example: false - - type: object - properties: - Media: - type: array - items: - allOf: - - type: object - required: - - id - properties: - id: - type: integer - description: Unique media identifier. - example: 387322 - - type: object - required: - - duration - properties: - duration: - type: integer - format: int32 - description: Duration of the media in milliseconds. - example: 9610350 - - type: object - required: - - bitrate - properties: - bitrate: - type: integer - format: int32 - description: Bitrate in bits per second. - example: 25512 - - type: object - required: - - width - properties: - width: - type: integer - format: int32 - description: Video width in pixels. - example: 3840 - - type: object - required: - - height - properties: - height: - type: integer - format: int32 - description: Video height in pixels. - example: 1602 - - type: object - required: - - aspectRatio - properties: - aspectRatio: - type: number - format: float - description: Aspect ratio of the video. - example: 2.35 - - type: object - required: - - audioChannels - properties: - audioChannels: - type: integer - format: int32 - description: Number of audio channels. - example: 6 - - type: object - required: - - displayOffset - properties: - displayOffset: - type: integer - format: int32 - example: 50 - - type: object - required: - - audioCodec - properties: - audioCodec: - type: string - description: Audio codec used. - example: aac - - type: object - required: - - videoCodec - properties: - videoCodec: - type: string - description: Video codec used. - example: hevc - - type: object - required: - - videoResolution - properties: - videoResolution: - type: string - description: 'Video resolution (e.g., 4k).' - example: 4k - - type: object - required: - - container - properties: - container: - type: string - description: Container format of the media. - example: mp4 - - type: object - properties: - videoFrameRate: - type: string - description: | - Frame rate of the video. Values found include NTSC, PAL, 24p - example: 24p - - type: object - properties: - videoProfile: - type: string - description: 'Video profile (e.g., main 10).' - example: main 10 - - type: object - properties: - hasVoiceActivity: - type: boolean - description: Indicates whether voice activity is detected. - example: false - - type: object - properties: - audioProfile: - type: string - description: 'The audio profile used for the media (e.g., DTS, Dolby Digital, etc.).' - example: dts - - type: object - properties: - optimizedForStreaming: - description: 'Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true' - oneOf: - - type: integer - format: int32 - enum: - - 0 - - 1 - - type: boolean - enum: - - true - - false - - type: object - properties: - has64bitOffsets: - description: | - Indicates whether the media has 64-bit offsets. - This is relevant for media files that may require larger offsets than what 32-bit integers can provide. - type: boolean - example: false - - type: object - properties: - Part: - type: array - items: - allOf: - - type: object - required: - - accessible - properties: - accessible: - type: boolean - description: Indicates if the part is accessible. - example: true - - type: object - properties: - exists: - type: boolean - description: Indicates if the part exists. - example: true - - type: object - required: - - id - properties: - id: - type: integer - description: Unique part identifier. - example: 418385 - - type: object - required: - - key - properties: - key: - type: string - description: Key to access this part. - example: /library/parts/418385/1735864239/file.mkv - - type: object - required: - - indexes - properties: - indexes: - type: string - example: sd - - type: object - required: - - duration - properties: - duration: - type: integer - format: int32 - description: Duration of the part in milliseconds. - example: 9610350 - - type: object - required: - - file - properties: - file: - type: string - description: File path for the part. - example: /mnt/Movies_1/W/Wicked (2024).mkv - - type: object - required: - - size - properties: - size: - description: File size in bytes. - type: integer - example: 30649952104 - - type: object - required: - - packetLength - properties: - packetLength: - type: integer - format: int32 - example: 188 - - type: object - required: - - container - properties: - container: - type: string - description: Container format of the part. - example: mkv - - type: object - properties: - videoProfile: - type: string - description: Video profile for the part. - example: main 10 - - type: object - properties: - audioProfile: - type: string - description: 'The audio profile used for the media (e.g., DTS, Dolby Digital, etc.).' - example: dts - - type: object - properties: - has64bitOffsets: - type: boolean - example: false - - type: object - properties: - optimizedForStreaming: - description: | - Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true - oneOf: - - type: integer - format: int32 - enum: - - 0 - - 1 - - type: boolean - enum: - - true - - false - - type: object - properties: - hasThumbnail: - allOf: - - description: | - Indicates if the part has a thumbnail. - - type: string - enum: - - '0' - - '1' - example: '1' - default: '0' - x-speakeasy-enums: - - false - - true - Genre: - type: array - items: - allOf: - - type: object - required: - - id - properties: - id: - description: | - The unique identifier for the genre. - NOTE: This is different for each Plex server and is not globally unique. - type: integer - format: int32 - minimum: 1 - example: 259 - - type: object - required: - - tag - properties: - tag: - type: string - description: | - The genre name of this media-item - example: Crime - Country: - type: array - items: - allOf: - - type: object - required: - - id - properties: - id: - description: | - The unique identifier for the country. - NOTE: This is different for each Plex server and is not globally unique. - type: integer - format: int32 - minimum: 1 - example: 259 - - type: object - required: - - tag - properties: - tag: - type: string - description: The country of origin of this media item - example: United States of America - Director: - type: array - items: - allOf: - - type: object - required: - - id - properties: - id: - description: Unique identifier for the director. - type: integer - format: int32 - minimum: 1 - example: 126522 - - type: object - required: - - tag - properties: - tag: - type: string - description: The role of Director - example: Danny Boyle - - type: object - properties: - thumb: - description: The absolute URL of the thumbnail image for the director. - type: string - example: 'https://metadata-static.plex.tv/8/people/8d65fa96804802e08f2de09fe014408e.jpg' - Writer: - type: array - items: - allOf: - - type: object - required: - - id - properties: - id: - description: Unique identifier for the writer. - type: integer - format: int32 - minimum: 1 - example: 126522 - - type: object - required: - - tag - properties: - tag: - type: string - description: The role of Writer - example: Jamie P. Hanson - - type: object - properties: - thumb: - description: The absolute URL of the thumbnail image for the writer. - type: string - example: 'https://metadata-static.plex.tv/8/people/8d65fa96804802e08f2de09fe014408e.jpg' - Role: - type: array - items: - allOf: - - type: object - required: - - id - properties: - id: - description: | - The unique identifier for the role. - NOTE: This is different for each Plex server and is not globally unique. - type: integer - format: int32 - minimum: 1 - example: 126522 - - type: object - required: - - tag - properties: - tag: - description: The display tag for the actor (typically the actor's name). - type: string - example: Teller - - type: object - properties: - role: - description: The role played by the actor in the media item. - type: string - example: Self - Judge - - type: object - properties: - thumb: - description: The absolute URL of the thumbnail image for the actor. - type: string - example: 'https://metadata-static.plex.tv/7/people/708568fd018d7aa8b1032dcf867747e8.jpg' - Location: - type: array - items: - allOf: - - type: object - required: - - path - - type: object - required: - - path - description: The folder path for the media item. - properties: - path: - type: string - example: /TV Shows/Clarkson's Farm + description: Codec used by the stream + example: h264 + index: + type: integer + description: The index of the stream + example: 0 + bitrate: + type: integer + description: The bitrate of the stream in kbps + example: 6273 + colorPrimaries: + type: string + description: The color primaries of the video stream + example: bt709 + colorRange: + type: string + description: The color range of the video stream + example: tv + colorSpace: + type: string + description: The color space of the video stream + example: bt709 + colorTrc: + type: string + description: The transfer characteristics (TRC) of the video stream + example: bt709 + bitDepth: + type: integer + description: The bit depth of the video stream + example: 8 + chromaLocation: + type: string + description: The chroma location of the video stream + example: left + streamIdentifier: + type: string + description: The identifier of the video stream + example: '2' + chromaSubsampling: + type: string + description: The chroma subsampling format + example: '4:2:0' + codedHeight: + type: integer + description: The coded height of the video stream + example: 1088 + codedWidth: + type: integer + description: The coded width of the video stream + example: 1920 + frameRate: + type: number + description: The frame rate of the video stream + example: 29.97 + hasScalingMatrix: + type: boolean + description: Indicates if the stream has a scaling matrix + example: false + hearingImpaired: + type: boolean + example: false + closedCaptions: + type: boolean + example: false + embeddedInVideo: + type: string + example: '1' + height: + type: integer + description: The height of the video stream + example: 1080 + level: + type: integer + description: The level of the video codec + example: 40 + profile: + type: string + description: The profile of the video codec + example: main + refFrames: + type: integer + description: Number of reference frames + example: 4 + scanType: + type: string + description: The scan type (progressive or interlaced) + example: progressive + width: + type: integer + description: The width of the video stream + example: 1920 + displayTitle: + type: string + description: Display title of the stream + example: 1080p (H.264) + extendedDisplayTitle: + type: string + description: Extended display title of the stream + example: 1080p (H.264) + channels: + type: integer + description: Number of audio channels (for audio streams) + example: 2 + language: + type: string + description: The language of the stream (for audio/subtitle streams) + example: English + languageTag: + type: string + description: Language tag of the stream + example: en + languageCode: + type: string + description: Language code of the stream + example: eng + audioChannelLayout: + type: string + description: The audio channel layout + example: stereo + samplingRate: + type: integer + description: Sampling rate of the audio stream in Hz + example: 48000 + title: + type: string + description: Title of the subtitle track (for subtitle streams) + example: English + canAutoSync: + type: boolean + description: Indicates if the subtitle stream can auto-sync + example: false + Genre: + type: array + items: + type: object + properties: + tag: + type: string + example: Adventure + Country: + type: array + items: + type: object + properties: + tag: + type: string + example: United States of America + Director: + type: array + items: + type: object + properties: + tag: + type: string + example: James Cameron + Writer: + type: array + items: + type: object + properties: + tag: + type: string + example: James Cameron + Collection: + type: array + items: + type: object + properties: + tag: + type: string + example: Working NL Subs + Role: + type: array + items: + type: object + properties: + id: + type: integer + description: The ID of the tag or actor. + example: 294129 + filter: + type: string + description: The filter used to find the actor or tag. + example: actor=294129 + thumb: + type: string + description: The thumbnail of the actor + example: 'https://metadata-static.plex.tv/2/people/27b85844536c39f3f9ac943aaad46608.jpg' + tag: + type: string + description: The name of the tag or actor. + example: Mike Smith + tagKey: + type: string + description: Unique identifier for the tag. + example: 668e7e7b22bcad9064350c91 + role: + type: string + description: The role of the actor or tag in the media. + example: Self + Location: + type: array + items: + type: object + properties: + path: + type: string + example: /TV Shows/House + Guid: + x-speakeasy-name-override: MediaGuid + description: | + The Guid object is only included in the response if the `includeGuids` parameter is set to `1`. + type: array + items: + type: object + required: + - id + properties: + id: + type: string + description: | + Can be one of the following formats: + imdb://tt13015952, tmdb://2434012, tvdb://7945991 + example: 'imdb://tt13015952' + UltraBlurColors: + type: object + required: + - topLeft + - topRight + - bottomRight + - bottomLeft + properties: + topLeft: + type: string + example: 11333b + topRight: + type: string + example: 0a232d + bottomRight: + type: string + example: 073958 + bottomLeft: + type: string + example: 1f5066 + Rating: + x-speakeasy-name-override: MetaDataRating + type: array + items: + type: object + required: + - image + - value + - type + properties: + image: + type: string + description: A URI or path to the rating image. + example: 'themoviedb://image.rating' + value: + type: number + format: float + description: The value of the rating. + example: 3 + type: + type: string + description: 'The type of rating (e.g., audience, critic).' + example: audience + Image: + type: array + items: + type: object + required: + - alt + - type + - url + properties: + alt: + type: string + example: Episode 1 + type: + type: string + x-speakeasy-unknown-values: allow + enum: + - coverPoster + - background + - snapshot + - clearLogo + example: background + url: + type: string + example: /library/metadata/45521/thumb/1644710589 + titleSort: + type: string + example: Whale + viewCount: + type: integer + format: int32 + example: 1 + lastViewedAt: + type: integer + format: int32 + example: 1682752242 + originalTitle: + type: string + example: 映画 ブラッククローバー 魔法帝の剣 + viewOffset: + type: integer + format: int32 + example: 5222500 + skipCount: + type: integer + format: int32 + example: 1 + index: + type: integer + format: int32 + example: 1 + theme: + type: string + example: /library/metadata/1/theme/1705636920 + leafCount: + type: integer + format: int32 + example: 14 + viewedLeafCount: + type: integer + format: int32 + example: 0 + childCount: + type: integer + format: int32 + example: 1 + hasPremiumExtras: + type: string + example: '1' + hasPremiumPrimaryExtra: + type: string + example: '1' + parentRatingKey: + type: string + description: | + The rating key of the parent item. + example: '66' + parentGuid: + type: string + example: 'plex://show/5d9c081b170e24001f2a7be4' + parentStudio: + type: string + example: UCP + parentKey: + type: string + example: /library/metadata/66 + parentTitle: + type: string + example: Caprica + parentIndex: + type: integer + format: int32 + example: 1 + parentYear: + type: integer + format: int32 + example: 2010 + parentThumb: + type: string + example: /library/metadata/66/thumb/1705716261 + parentTheme: + type: string + example: /library/metadata/66/theme/1705716261 '400': description: 'Bad Request - A parameter was not specified, or was specified incorrectly.' content: @@ -11782,18 +11004,24 @@ paths: description: An plugin identifier for the media container. example: com.plexapp.plugins.library - type: object + required: + - librarySectionID properties: librarySectionID: type: integer description: The unique identifier for the library section. example: 2 - type: object + required: + - librarySectionTitle properties: librarySectionTitle: type: string description: The title of the library section. example: TV Series - type: object + required: + - librarySectionTitle properties: librarySectionUUID: type: string @@ -12293,18 +11521,24 @@ paths: type: string example: 1f5066 - type: object + required: + - librarySectionID properties: librarySectionID: type: integer description: The identifier for the library section. example: 1 - type: object + required: + - librarySectionTitle properties: librarySectionTitle: type: string description: The title of the library section. example: Movies - type: object + required: + - librarySectionKey properties: librarySectionKey: type: string @@ -12338,10 +11572,11 @@ paths: - type: object properties: Media: - type: array - items: - allOf: - - type: object + allOf: + - type: array + description: An array of media file data items. + items: + type: object required: - id properties: @@ -12349,115 +11584,65 @@ paths: type: integer description: Unique media identifier. example: 387322 - - type: object - required: - - duration - properties: duration: type: integer format: int32 description: Duration of the media in milliseconds. example: 9610350 - - type: object - required: - - bitrate - properties: bitrate: type: integer format: int32 description: Bitrate in bits per second. example: 25512 - - type: object - required: - - width - properties: width: type: integer - format: int32 description: Video width in pixels. example: 3840 - - type: object - required: - - height - properties: + format: int32 height: type: integer - format: int32 description: Video height in pixels. example: 1602 - - type: object - required: - - aspectRatio - properties: + format: int32 aspectRatio: type: number format: float description: Aspect ratio of the video. example: 2.35 - - type: object - required: - - audioChannels - properties: audioChannels: type: integer - format: int32 description: Number of audio channels. example: 6 - - type: object - required: - - displayOffset - properties: + format: int32 displayOffset: type: integer format: int32 example: 50 - - type: object - required: - - audioCodec - properties: audioCodec: type: string description: Audio codec used. - example: aac - - type: object - required: - - videoCodec - properties: + example: eac3 videoCodec: type: string description: Video codec used. example: hevc - - type: object - required: - - videoResolution - properties: videoResolution: type: string description: 'Video resolution (e.g., 4k).' example: 4k - - type: object - required: - - container - properties: container: type: string - description: Container format of the media. - example: mp4 - - type: object - properties: + description: File container type. + example: mkv videoFrameRate: type: string description: | Frame rate of the video. Values found include NTSC, PAL, 24p example: 24p - - type: object - properties: videoProfile: type: string description: 'Video profile (e.g., main 10).' example: main 10 - - type: object - properties: hasVoiceActivity: type: boolean description: Indicates whether voice activity is detected.