mirror of
https://github.com/LukeHagar/plex-api-spec.git
synced 2025-12-07 20:47:47 +00:00
delete
This commit is contained in:
JasonLandbridge
@@ -1,715 +0,0 @@
|
||||
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:
|
||||
$ref: "../models/common/PlexMediaTypeString.yaml"
|
||||
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-14
|
||||
addedAt:
|
||||
$ref: "../models/common/PlexDateTime.yaml"
|
||||
updatedAt:
|
||||
$ref: "../models/common/PlexDateTime.yaml"
|
||||
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:
|
||||
- $ref: "../models/common/PlexBoolean.yaml"
|
||||
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:
|
||||
$ref: "../models/common/PlexBooleanString.yaml"
|
||||
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: 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.0
|
||||
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
|
||||
Reference in New Issue
Block a user