declare(strict_types=1);
require 'vendor/autoload.php';
use LukeHagar\Plex_API;
use LukeHagar\Plex_API\Models\Operations;
$sdk = Plex_API\PlexAPI::builder()
->setSecurity(
'<YOUR_API_KEY_HERE>'
)
->build();
$request = new Operations\GetMediaMetaDataRequest(
ratingKey: 9518,
includeConcerts: true,
includeExtras: true,
includeOnDeck: true,
includePopularLeaves: true,
includePreferences: true,
includeReviews: true,
includeChapters: true,
includeStations: true,
includeExternalMedia: true,
asyncAugmentMetadata: true,
asyncCheckFiles: true,
asyncRefreshAnalysis: true,
asyncRefreshLocalMediaAgent: true,
);
$response = $sdk->library->getMediaMetaData(
request: $request
);
if ($response->object !== null) {
// handle response
}
{
"MediaContainer": {
"size": 50,
"allowSync": false,
"identifier": "com.plexapp.plugins.library",
"librarySectionID": 2,
"librarySectionTitle": "TV Series",
"librarySectionUUID": "e69655a2-ef48-4aba-bb19-0cc34d1e7d36",
"mediaTagPrefix": "/system/bundle/media/flags/",
"mediaTagVersion": 1734362201,
"Metadata": [
{
"ratingKey": "44288",
"parentRatingKey": "48047",
"grandparentRatingKey": "45520",
"parentGuid": "plex://season/618b89208dde18df707ad15c",
"grandparentGuid": "plex://show/5e16253691c20300412003a8",
"grandparentSlug": "alice-in-borderland-2020",
"grandparentKey": "/library/metadata/45520",
"parentKey": "/library/metadata/48047",
"key": "/library/metadata/44288/children",
"guid": "plex://show/5d9c08254eefaa001f5d6dcb",
"slug": "better-call-saul",
"studio": "Sony Pictures Television",
"type": "show",
"title": "Better Call Saul",
"originalTitle": "Wicked: Part I",
"librarySectionTitle": "TV Series ",
"librarySectionID": 2,
"librarySectionKey": "/library/sections/2",
"contentRating": "TV-MA",
"summary": "Before Saul Goodman, he was Jimmy McGill. And if you're calling Jimmy, you're in real trouble. The prequel to \"Breaking Bad\" follows small-time attorney, Jimmy McGill, as he transforms into Walter White's morally challenged lawyer, Saul Goodman.",
"index": 1,
"grandparentTitle": "Alice in Borderland",
"parentTitle": "Season 2",
"audienceRating": 8.7,
"viewCount": 4,
"skipCount": 1,
"lastViewedAt": 1625764795,
"year": 2015,
"rating": 6,
"ratingImage": "rottentomatoes://image.rating.ripe",
"tagline": "Make the call",
"chapterSource": "media",
"primaryExtraKey": "/library/metadata/134704",
"thumb": "/library/metadata/44288/thumb/1736487993",
"art": "/library/metadata/44288/art/1736487993",
"theme": "/library/metadata/44288/theme/1736487993",
"duration": 2700000,
"originallyAvailableAt": "2015-02-08",
"leafCount": 63,
"viewedLeafCount": 4,
"childCount": 6,
"addedAt": 1556281940,
"updatedAt": 1556281940,
"audienceRatingImage": "themoviedb://image.rating",
"parentIndex": 2,
"parentThumb": "/library/metadata/48047/thumb/1671800243",
"grandparentThumb": "/library/metadata/45520/thumb/1736488003",
"grandparentArt": "/library/metadata/45520/art/1736488003",
"Media": [
{
"id": 387322,
"duration": 9610350,
"bitrate": 25512,
"width": 3840,
"height": 1602,
"aspectRatio": 2.35,
"audioChannels": 6,
"displayOffset": 50,
"audioCodec": "eac3",
"videoCodec": "hevc",
"videoResolution": "4k",
"container": "mkv",
"videoFrameRate": "24p",
"videoProfile": "main 10",
"hasVoiceActivity": false,
"audioProfile": "dts",
"optimizedForStreaming": 0,
"has64bitOffsets": false,
"Part": [
{
"accessible": true,
"exists": true,
"id": 418385,
"key": "/library/parts/418385/1735864239/file.mkv",
"indexes": "sd",
"duration": 9610350,
"file": "/mnt/Movies_1/W/Wicked (2024).mkv",
"size": 30649952104,
"packetLength": 188,
"container": "mkv",
"videoProfile": "main 10",
"audioProfile": "dts",
"has64bitOffsets": false,
"optimizedForStreaming": 0,
"hasThumbnail": "1",
"Stream": [
{
"id": 1002625,
"streamType": 1,
"default": true,
"codec": "hevc",
"index": 0,
"bitrate": 24743,
"language": "English",
"languageTag": "en",
"languageCode": "eng",
"headerCompression": true,
"DOVIBLCompatID": 1,
"DOVIBLPresent": true,
"DOVIELPresent": false,
"DOVILevel": 6,
"DOVIPresent": true,
"DOVIProfile": 8,
"DOVIRPUPresent": true,
"DOVIVersion": "1.0",
"bitDepth": 10,
"chromaLocation": "topleft",
"chromaSubsampling": "4:2:0",
"codedHeight": 1608,
"codedWidth": 3840,
"colorPrimaries": "bt2020",
"colorRange": "tv",
"colorSpace": "bt2020nc",
"colorTrc": "smpte2084",
"frameRate": 23.976,
"height": 1602,
"level": 150,
"original": true,
"hasScalingMatrix": false,
"profile": "main 10",
"scanType": "progressive",
"refFrames": 1,
"width": 3840,
"displayTitle": "4K DoVi/HDR10 (HEVC Main 10)",
"extendedDisplayTitle": "4K DoVi/HDR10 (HEVC Main 10)",
"selected": true,
"forced": true,
"channels": 6,
"audioChannelLayout": "5.1(side)",
"samplingRate": 48000,
"canAutoSync": false,
"hearingImpaired": true,
"dub": true,
"title": "SDH"
}
]
}
]
}
],
"Image": [
{
"alt": "Better Call Saul",
"type": "coverPoster",
"url": "/library/metadata/44288/thumb/1736487993"
}
],
"UltraBlurColors": {
"topLeft": "11333a",
"topRight": "1d2721",
"bottomRight": "5c451d",
"bottomLeft": "372c10"
},
"Genre": [
{
"id": 1057,
"filter": "genre=1057",
"tag": "Crime"
}
],
"Country": [
{
"id": 58591,
"filter": "country=58591",
"tag": "United States of America"
}
],
"Guid": [
{
"id": "imdb://tt3032476"
}
],
"Rating": [
{
"image": "imdb://image.rating",
"value": 9,
"type": "audience"
}
],
"Role": [
{
"id": 109501,
"filter": "actor=109501",
"tag": "Bob Odenkirk",
"tagKey": "5d77683254f42c001f8c3f69",
"role": "Jimmy McGill",
"thumb": "https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg"
}
],
"Director": [
{
"id": 109501,
"filter": "actor=109501",
"tag": "Bob Odenkirk",
"tagKey": "5d77683254f42c001f8c3f69",
"role": "Jimmy McGill",
"thumb": "https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg"
}
],
"Writer": [
{
"id": 109501,
"filter": "actor=109501",
"tag": "Bob Odenkirk",
"tagKey": "5d77683254f42c001f8c3f69",
"role": "Jimmy McGill",
"thumb": "https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg"
}
],
"Producer": [
{
"id": 109501,
"filter": "actor=109501",
"tag": "Bob Odenkirk",
"tagKey": "5d77683254f42c001f8c3f69",
"role": "Jimmy McGill",
"thumb": "https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg"
}
],
"Similar": [
{
"id": 26,
"filter": "similar=26",
"tag": "Breaking Bad"
}
],
"Location": [
{
"path": "/TV Shows/Better Call Saul"
}
]
}
]
}
}
This endpoint will return all the (meta)data of a library item specified with by the ratingKey.
declare(strict_types=1);
require 'vendor/autoload.php';
use LukeHagar\Plex_API;
use LukeHagar\Plex_API\Models\Operations;
$sdk = Plex_API\PlexAPI::builder()
->setSecurity(
'<YOUR_API_KEY_HERE>'
)
->build();
$request = new Operations\GetMediaMetaDataRequest(
ratingKey: 9518,
includeConcerts: true,
includeExtras: true,
includeOnDeck: true,
includePopularLeaves: true,
includePreferences: true,
includeReviews: true,
includeChapters: true,
includeStations: true,
includeExternalMedia: true,
asyncAugmentMetadata: true,
asyncCheckFiles: true,
asyncRefreshAnalysis: true,
asyncRefreshLocalMediaAgent: true,
);
$response = $sdk->library->getMediaMetaData(
request: $request
);
if ($response->object !== null) {
// handle response
}
{
"MediaContainer": {
"size": 50,
"allowSync": false,
"identifier": "com.plexapp.plugins.library",
"librarySectionID": 2,
"librarySectionTitle": "TV Series",
"librarySectionUUID": "e69655a2-ef48-4aba-bb19-0cc34d1e7d36",
"mediaTagPrefix": "/system/bundle/media/flags/",
"mediaTagVersion": 1734362201,
"Metadata": [
{
"ratingKey": "44288",
"parentRatingKey": "48047",
"grandparentRatingKey": "45520",
"parentGuid": "plex://season/618b89208dde18df707ad15c",
"grandparentGuid": "plex://show/5e16253691c20300412003a8",
"grandparentSlug": "alice-in-borderland-2020",
"grandparentKey": "/library/metadata/45520",
"parentKey": "/library/metadata/48047",
"key": "/library/metadata/44288/children",
"guid": "plex://show/5d9c08254eefaa001f5d6dcb",
"slug": "better-call-saul",
"studio": "Sony Pictures Television",
"type": "show",
"title": "Better Call Saul",
"originalTitle": "Wicked: Part I",
"librarySectionTitle": "TV Series ",
"librarySectionID": 2,
"librarySectionKey": "/library/sections/2",
"contentRating": "TV-MA",
"summary": "Before Saul Goodman, he was Jimmy McGill. And if you're calling Jimmy, you're in real trouble. The prequel to \"Breaking Bad\" follows small-time attorney, Jimmy McGill, as he transforms into Walter White's morally challenged lawyer, Saul Goodman.",
"index": 1,
"grandparentTitle": "Alice in Borderland",
"parentTitle": "Season 2",
"audienceRating": 8.7,
"viewCount": 4,
"skipCount": 1,
"lastViewedAt": 1625764795,
"year": 2015,
"rating": 6,
"ratingImage": "rottentomatoes://image.rating.ripe",
"tagline": "Make the call",
"chapterSource": "media",
"primaryExtraKey": "/library/metadata/134704",
"thumb": "/library/metadata/44288/thumb/1736487993",
"art": "/library/metadata/44288/art/1736487993",
"theme": "/library/metadata/44288/theme/1736487993",
"duration": 2700000,
"originallyAvailableAt": "2015-02-08",
"leafCount": 63,
"viewedLeafCount": 4,
"childCount": 6,
"addedAt": 1556281940,
"updatedAt": 1556281940,
"audienceRatingImage": "themoviedb://image.rating",
"parentIndex": 2,
"parentThumb": "/library/metadata/48047/thumb/1671800243",
"grandparentThumb": "/library/metadata/45520/thumb/1736488003",
"grandparentArt": "/library/metadata/45520/art/1736488003",
"Media": [
{
"id": 387322,
"duration": 9610350,
"bitrate": 25512,
"width": 3840,
"height": 1602,
"aspectRatio": 2.35,
"audioChannels": 6,
"displayOffset": 50,
"audioCodec": "eac3",
"videoCodec": "hevc",
"videoResolution": "4k",
"container": "mkv",
"videoFrameRate": "24p",
"videoProfile": "main 10",
"hasVoiceActivity": false,
"audioProfile": "dts",
"optimizedForStreaming": 0,
"has64bitOffsets": false,
"Part": [
{
"accessible": true,
"exists": true,
"id": 418385,
"key": "/library/parts/418385/1735864239/file.mkv",
"indexes": "sd",
"duration": 9610350,
"file": "/mnt/Movies_1/W/Wicked (2024).mkv",
"size": 30649952104,
"packetLength": 188,
"container": "mkv",
"videoProfile": "main 10",
"audioProfile": "dts",
"has64bitOffsets": false,
"optimizedForStreaming": 0,
"hasThumbnail": "1",
"Stream": [
{
"id": 1002625,
"streamType": 1,
"default": true,
"codec": "hevc",
"index": 0,
"bitrate": 24743,
"language": "English",
"languageTag": "en",
"languageCode": "eng",
"headerCompression": true,
"DOVIBLCompatID": 1,
"DOVIBLPresent": true,
"DOVIELPresent": false,
"DOVILevel": 6,
"DOVIPresent": true,
"DOVIProfile": 8,
"DOVIRPUPresent": true,
"DOVIVersion": "1.0",
"bitDepth": 10,
"chromaLocation": "topleft",
"chromaSubsampling": "4:2:0",
"codedHeight": 1608,
"codedWidth": 3840,
"colorPrimaries": "bt2020",
"colorRange": "tv",
"colorSpace": "bt2020nc",
"colorTrc": "smpte2084",
"frameRate": 23.976,
"height": 1602,
"level": 150,
"original": true,
"hasScalingMatrix": false,
"profile": "main 10",
"scanType": "progressive",
"refFrames": 1,
"width": 3840,
"displayTitle": "4K DoVi/HDR10 (HEVC Main 10)",
"extendedDisplayTitle": "4K DoVi/HDR10 (HEVC Main 10)",
"selected": true,
"forced": true,
"channels": 6,
"audioChannelLayout": "5.1(side)",
"samplingRate": 48000,
"canAutoSync": false,
"hearingImpaired": true,
"dub": true,
"title": "SDH"
}
]
}
]
}
],
"Image": [
{
"alt": "Better Call Saul",
"type": "coverPoster",
"url": "/library/metadata/44288/thumb/1736487993"
}
],
"UltraBlurColors": {
"topLeft": "11333a",
"topRight": "1d2721",
"bottomRight": "5c451d",
"bottomLeft": "372c10"
},
"Genre": [
{
"id": 1057,
"filter": "genre=1057",
"tag": "Crime"
}
],
"Country": [
{
"id": 58591,
"filter": "country=58591",
"tag": "United States of America"
}
],
"Guid": [
{
"id": "imdb://tt3032476"
}
],
"Rating": [
{
"image": "imdb://image.rating",
"value": 9,
"type": "audience"
}
],
"Role": [
{
"id": 109501,
"filter": "actor=109501",
"tag": "Bob Odenkirk",
"tagKey": "5d77683254f42c001f8c3f69",
"role": "Jimmy McGill",
"thumb": "https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg"
}
],
"Director": [
{
"id": 109501,
"filter": "actor=109501",
"tag": "Bob Odenkirk",
"tagKey": "5d77683254f42c001f8c3f69",
"role": "Jimmy McGill",
"thumb": "https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg"
}
],
"Writer": [
{
"id": 109501,
"filter": "actor=109501",
"tag": "Bob Odenkirk",
"tagKey": "5d77683254f42c001f8c3f69",
"role": "Jimmy McGill",
"thumb": "https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg"
}
],
"Producer": [
{
"id": 109501,
"filter": "actor=109501",
"tag": "Bob Odenkirk",
"tagKey": "5d77683254f42c001f8c3f69",
"role": "Jimmy McGill",
"thumb": "https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg"
}
],
"Similar": [
{
"id": 26,
"filter": "similar=26",
"tag": "Breaking Bad"
}
],
"Location": [
{
"path": "/TV Shows/Better Call Saul"
}
]
}
]
}
}
Plex Authentication Token
the id of the library item to return the children of.
9518
Include concerts data if set to true.
true
Include extra content (e.g. bonus features).
true
Include on-deck items.
true
Include popular leaves (episodes/chapters).
true
Include preferences information.
true
Include reviews for the content.
true
Include chapter details.
true
Include station data.
true
Include external media data.
true
Trigger asynchronous metadata augmentation.
true
Trigger asynchronous file checking.
true
Trigger asynchronous refresh of analysis.
true
Trigger asynchronous refresh of the local media agent.
true
The metadata of the library item.
The response is of type object
.