LukeParke/plex-sdk-docs
1
0
Fork 0
mirror of https://github.com/LukeHagar/plex-sdk-docs.git synced 2025-12-10 04:20:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

ci: regenerated with OpenAPI Doc 0.0.3, Speakeasy CLI 1.303.0

Browse Source
This commit is contained in:
speakeasybot
2024-06-11 00:33:50 +00:00
parent 6748e94a9a
commit e74bc056f6
491 changed files with 4181 additions and 2758 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
content/pages/01-reference/curl/resources/library/get_file_hash/_usage.mdx
View File

@@ -1,7 +1,7 @@
<CH.Code>
```bash Example Request
curl http://10.10.10.47:32400/library/hashes?type=8360.79&url=file%3A%2F%2FC%3A%5CImage.png%26type%3D13 \
curl http://10.10.10.47:32400/library/hashes?type=4236.55&url=file%3A%2F%2FC%3A%5CImage.png%26type%3D13 \
--header 'Accept: application/json' \
--header 'X-Plex-Token: YOUR_API_KEY_HERE'
```

31
content/pages/01-reference/curl/resources/library/get_libraries/_usage.mdx
View File

@@ -13,7 +13,36 @@ curl http://10.10.10.47:32400/library/sections \
"size": 5,
"allowSync": false,
"title1": "Plex Library",
"Directory": []
"Directory": [
{
"allowSync": true,
"art": "/:/resources/movie-fanart.jpg",
"composite": "/library/sections/1/composite/1705615584",
"filters": true,
"refreshing": false,
"thumb": "/:/resources/movie.png",
"key": "1",
"type": "movie",
"title": "Movies",
"agent": "tv.plex.agents.movie",
"scanner": "Plex Movie",
"language": "en-US",
"uuid": "322a231a-b7f7-49f5-920f-14c61199cd30",
"updatedAt": 1705615634,
"createdAt": 1654131312,
"scannedAt": 1705615584,
"content": true,
"directory": true,
"contentChangedAt": 3192854,
"hidden": 0,
"Location": [
{
"id": 1,
"path": "/movies"
}
]
}
]
}
}
```

58
content/pages/01-reference/curl/resources/library/get_library/_usage.mdx
View File

@@ -22,9 +22,61 @@ curl http://10.10.10.47:32400/library/sections/1000 \
"title1": "Movies",
"viewGroup": "secondary",
"viewMode": 65592,
"Directory": [],
"Type": [],
"FieldType": []
"Directory": [
{
"key": "search?type=1",
"title": "Search...",
"secondary": true,
"prompt": "Search Movies",
"search": true
}
],
"Type": [
{
"key": "/library/sections/1/all?type=1",
"type": "movie",
"title": "Movies",
"active": false,
"Filter": [
{
"filter": "label",
"filterType": "string",
"key": "/library/sections/1/label",
"title": "Labels",
"type": "filter"
}
],
"Sort": [
{
"default": "asc",
"defaultDirection": "desc",
"descKey": "random:desc",
"firstCharacterKey": "/library/sections/1/firstCharacter",
"key": "random",
"title": "Randomly"
}
],
"Field": [
{
"key": "label",
"title": "Label",
"type": "tag",
"subType": "bitrate"
}
]
}
],
"FieldType": [
{
"type": "resolution",
"Operator": [
{
"key": "=",
"title": "is"
}
]
}
]
}
}
```

2
content/pages/01-reference/curl/resources/library/get_library_items/_parameters.mdx
View File

@@ -5,6 +5,8 @@ import Labels from "/src/lib/labels";
##### `sectionId` _integer_
the Id of the library to query
<br/>
**Example:** `1`
---
##### `tag` _enumeration_

13
content/pages/01-reference/curl/resources/library/get_library_items/_response.mdx
View File

@@ -17,6 +17,19 @@ import StatusCode from '@/src/components/StatusCode';
<GetLibraryItemsMediaContainer/>
</Collapsible>
</Collapsible>
</Tab>
{/* prettier-ignore */}
<Tab title={<StatusCode code={"400"} />}>
_No response body._
</Tab>
{/* prettier-ignore */}
<Tab title={<StatusCode code={"401"} />}>
*JSON object*
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
##### `errors` _array (optional)_
</Collapsible>
</Tab>
</TabbedSection>

111
content/pages/01-reference/curl/resources/library/get_library_items/_usage.mdx
View File

@@ -1,7 +1,7 @@
<CH.Code>
```bash Example Request
curl http://10.10.10.47:32400/library/sections/71036/{{tag}} \
curl http://10.10.10.47:32400/library/sections/1/{{tag}} \
--header 'Accept: application/json' \
--header 'X-Plex-Token: YOUR_API_KEY_HERE'
```
@@ -25,7 +25,114 @@ curl http://10.10.10.47:32400/library/sections/71036/{{tag}} \
"viewGroup": "movie",
"viewMode": 65592,
"mixedParents": true,
"Metadata": []
"Metadata": [
{
"ratingKey": "58683",
"key": "/library/metadata/58683",
"guid": "plex://movie/5d7768ba96b655001fdc0408",
"studio": "20th Century Studios",
"type": "movie",
"title": "Avatar: The Way of Water",
"contentRating": "PG-13",
"summary": "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": 7.6,
"audienceRating": 9.2,
"year": 2022,
"tagline": "Return to Pandora.",
"thumb": "/library/metadata/58683/thumb/1703239236",
"art": "/library/metadata/58683/art/1703239236",
"duration": 11558112,
"originallyAvailableAt": "2022-12-14T00:00:00Z",
"addedAt": 1680457607,
"updatedAt": 1703239236,
"audienceRatingImage": "rottentomatoes://image.rating.upright",
"chapterSource": "media",
"primaryExtraKey": "/library/metadata/58684",
"ratingImage": "rottentomatoes://image.rating.ripe",
"grandparentRatingKey": "66",
"grandparentGuid": "plex://show/5d9c081b170e24001f2a7be4",
"grandparentKey": "/library/metadata/66",
"grandparentTitle": "Caprica",
"grandparentThumb": "/library/metadata/66/thumb/1705716261",
"grandparentArt": "/library/metadata/66/art/1705716261",
"grandparentTheme": "/library/metadata/66/theme/1705716261",
"Media": [
{
"id": 119534,
"duration": 11558112,
"bitrate": 25025,
"width": 3840,
"height": 2072,
"aspectRatio": 1.85,
"audioChannels": 6,
"audioCodec": "eac3",
"videoCodec": "hevc",
"videoResolution": "4k",
"container": "mkv",
"videoFrameRate": "24p",
"videoProfile": "main 10",
"Part": [
{
"id": 119542,
"key": "/library/parts/119542/1680457526/file.mkv",
"duration": 11558112,
"file": "/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": 36158371307,
"container": "mkv",
"videoProfile": "main 10"
}
]
}
],
"Genre": [
{
"tag": "Adventure"
}
],
"Country": [
{
"tag": "United States of America"
}
],
"Director": [
{
"tag": "James Cameron"
}
],
"Writer": [
{
"tag": "James Cameron"
}
],
"Role": [
{
"tag": "Sigourney Weaver"
}
],
"titleSort": "Whale",
"viewCount": 1,
"lastViewedAt": 1682752242,
"originalTitle": "映画 ブラッククローバー 魔法帝の剣",
"viewOffset": 5222500,
"skipCount": 1,
"index": 1,
"theme": "/library/metadata/1/theme/1705636920",
"leafCount": 14,
"viewedLeafCount": 0,
"childCount": 1,
"hasPremiumExtras": "1",
"hasPremiumPrimaryExtra": "1",
"parentRatingKey": "66",
"parentGuid": "plex://show/5d9c081b170e24001f2a7be4",
"parentStudio": "UCP",
"parentKey": "/library/metadata/66",
"parentTitle": "Caprica",
"parentIndex": 1,
"parentYear": 2010,
"parentThumb": "/library/metadata/66/thumb/1705716261",
"parentTheme": "/library/metadata/66/theme/1705716261"
}
]
}
}
```

164
content/pages/01-reference/curl/resources/library/get_metadata/_usage.mdx
View File

@@ -1,7 +1,7 @@
<CH.Code>
```bash Example Request
curl http://10.10.10.47:32400/library/metadata/6481.72 \
curl http://10.10.10.47:32400/library/metadata/3843.82 \
--header 'Accept: application/json' \
--header 'X-Plex-Token: YOUR_API_KEY_HERE'
```
@@ -18,7 +18,167 @@ curl http://10.10.10.47:32400/library/metadata/6481.72 \
"librarySectionUUID": "cfc899d7-3000-46f6-8489-b9592714ada5",
"mediaTagPrefix": "/system/bundle/media/flags/",
"mediaTagVersion": 1698860922,
"Metadata": []
"Metadata": [
{
"ratingKey": "17",
"key": "/library/metadata/17",
"guid": "plex://movie/5d77683f6f4521001ea9dc53",
"studio": "Universal Pictures",
"type": "movie",
"title": "Serenity",
"librarySectionTitle": "Movies",
"librarySectionID": 1,
"librarySectionKey": "/library/sections/1",
"contentRating": "PG-13",
"summary": "Serenity continues the story of the TV series it was based upon (\"Firefly\"). River Tam had a secret - one in which she's not even aware - so dangerous, no one's safe, as an Alliance operative's sent to capture her, and all others are considered irrelevant to his job.",
"rating": 8.2,
"audienceRating": 9.1,
"year": 2005,
"tagline": "They aim to misbehave.",
"thumb": "/library/metadata/17/thumb/1705637165",
"art": "/library/metadata/17/art/1705637165",
"duration": 141417,
"originallyAvailableAt": "2005-09-29T00:00:00Z",
"addedAt": 1705637164,
"updatedAt": 1705637165,
"audienceRatingImage": "rottentomatoes://image.rating.upright",
"hasPremiumPrimaryExtra": "1",
"ratingImage": "rottentomatoes://image.rating.ripe",
"Media": [
{
"id": 15,
"duration": 141417,
"bitrate": 2278,
"width": 1920,
"height": 814,
"aspectRatio": 2.35,
"audioChannels": 2,
"audioCodec": "aac",
"videoCodec": "h264",
"videoResolution": "1080",
"container": "mp4",
"videoFrameRate": "24p",
"optimizedForStreaming": 0,
"audioProfile": "lc",
"has64bitOffsets": false,
"videoProfile": "high",
"Part": [
{
"id": 15,
"key": "/library/parts/15/1705637151/file.mp4",
"duration": 141417,
"file": "/movies/Serenity (2005)/Serenity (2005).mp4",
"size": 40271948,
"audioProfile": "lc",
"container": "mp4",
"has64bitOffsets": false,
"optimizedForStreaming": false,
"videoProfile": "high",
"Stream": [
{
"id": 29,
"streamType": 2,
"default": true,
"codec": "aac",
"index": 0,
"bitrate": 128,
"bitDepth": 8,
"chromaLocation": "left",
"chromaSubsampling": "14520",
"codedHeight": 816,
"codedWidth": 1920,
"colorPrimaries": "bt709",
"colorRange": "tv",
"colorSpace": "bt709",
"colorTrc": "bt709",
"frameRate": 24,
"hasScalingMatrix": false,
"height": 814,
"level": 40,
"profile": "lc",
"refFrames": 4,
"scanType": "progressive",
"streamIdentifier": "1",
"width": 1920,
"displayTitle": "English (AAC Stereo)",
"extendedDisplayTitle": "English (AAC Stereo)",
"selected": true,
"channels": 2,
"language": "English",
"languageTag": "en",
"languageCode": "eng",
"samplingRate": 44100
}
]
}
]
}
],
"Genre": [
{
"id": 184,
"filter": "genre=184",
"tag": "Thriller"
}
],
"Country": [
{
"id": 116,
"filter": "country=116",
"tag": "United States of America"
}
],
"guids": [
{
"id": "tvdb://2337"
}
],
"ratings": [
{
"image": "themoviedb://image.rating",
"value": 7.4,
"type": "audience"
}
],
"Director": [
{
"id": 130,
"filter": "director=130",
"tag": "Joss Whedon",
"tagKey": "5d776828880197001ec90e8f",
"thumb": "https://metadata-static.plex.tv/people/5d776828880197001ec90e8f.jpg"
}
],
"Writer": [
{
"id": 132,
"filter": "writer=132",
"tag": "Joss Whedon",
"tagKey": "5d776828880197001ec90e8f",
"thumb": "https://metadata-static.plex.tv/people/5d776828880197001ec90e8f.jpg"
}
],
"Role": [
{
"id": 220,
"filter": "actor=220",
"tag": "Dennis Keiffer",
"tagKey": "5d77683554f42c001f8c4708",
"role": "Bar Guy (uncredited)",
"thumb": "https://metadata-static.plex.tv/6/people/648e9a7ea1d537bccfcd7615134b78ce.jpg"
}
],
"Producer": [
{
"id": 221,
"filter": "producer=221",
"tag": "Barry Mendel",
"tagKey": "5d776826961905001eb90e2b",
"thumb": "https://metadata-static.plex.tv/8/people/87877371326a964634d18556d94547e1.jpg"
}
]
}
]
}
}
```

34
content/pages/01-reference/curl/resources/library/get_metadata_children/_usage.mdx
View File

@@ -1,7 +1,7 @@
<CH.Code>
```bash Example Request
curl http://10.10.10.47:32400/library/metadata/202.18/children \
curl http://10.10.10.47:32400/library/metadata/4375.87/children \
--header 'Accept: application/json' \
--header 'X-Plex-Token: YOUR_API_KEY_HERE'
```
@@ -32,7 +32,37 @@ curl http://10.10.10.47:32400/library/metadata/202.18/children \
"viewGroup": "season",
"viewMode": 65593,
"Directory": [],
"Metadata": []
"Metadata": [
{
"ratingKey": "66488",
"key": "/library/metadata/66488/children",
"parentRatingKey": "30072",
"guid": "plex://season/652aea6549508477c34c6000",
"parentGuid": "plex://show/5d9c09190aaccd001f8f42f0",
"parentStudio": "Amazon Studios",
"type": "season",
"title": "Season 2",
"parentKey": "/library/metadata/30072",
"parentTitle": "Reacher",
"summary": "Based on\"Bad Luck and Trouble,\" when members of Reacher's old military unit start turning up dead, Reacher has just one thing on his mind—revenge.",
"index": 2,
"parentIndex": 1,
"viewCount": 11,
"lastViewedAt": 1705646565,
"parentYear": 2022,
"thumb": "/library/metadata/66488/thumb/1703065033",
"art": "/library/metadata/30072/art/1705739923",
"parentThumb": "/library/metadata/30072/thumb/1705739923",
"parentTheme": "/library/metadata/30072/theme/1705739923",
"leafCount": 8,
"viewedLeafCount": 8,
"addedAt": 1702602021,
"updatedAt": 1703065033,
"userRating": 9,
"skipCount": 1,
"lastRatedAt": 1703881224
}
]
}
}
```

2
content/pages/01-reference/curl/resources/library/refresh_library/_usage.mdx
View File

@@ -1,7 +1,7 @@
<CH.Code>
```bash Example Request
curl http://10.10.10.47:32400/library/sections/3373.96/refresh \
curl http://10.10.10.47:32400/library/sections/6235.64/refresh \
--header 'Accept: application/json' \
--header 'X-Plex-Token: YOUR_API_KEY_HERE'
```

13
content/pages/01-reference/curl/resources/library/search_library/_response.mdx
View File

@@ -17,6 +17,19 @@ import StatusCode from '@/src/components/StatusCode';
<SearchLibraryMediaContainer/>
</Collapsible>
</Collapsible>
</Tab>
{/* prettier-ignore */}
<Tab title={<StatusCode code={"400"} />}>
_No response body._
</Tab>
{/* prettier-ignore */}
<Tab title={<StatusCode code={"401"} />}>
*JSON object*
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
##### `errors` _array (optional)_
</Collapsible>
</Tab>
</TabbedSection>

27
content/pages/01-reference/curl/resources/library/search_library/_usage.mdx
View File

@@ -1,7 +1,7 @@
<CH.Code>
```bash Example Request
curl http://10.10.10.47:32400/library/sections/87129/search \
curl http://10.10.10.47:32400/library/sections/645894/search \
--header 'Accept: application/json' \
--header 'X-Plex-Token: YOUR_API_KEY_HERE'
```
@@ -22,7 +22,30 @@ curl http://10.10.10.47:32400/library/sections/87129/search \
"title2": "Search for ''",
"viewGroup": "season",
"viewMode": 65593,
"Metadata": []
"Metadata": [
{
"ratingKey": "2",
"key": "/library/metadata/2/children",
"parentRatingKey": "1",
"guid": "plex://season/602e67e766dfdb002c0a1b5b",
"parentGuid": "plex://show/5d9c086c7d06d9001ffd27aa",
"parentStudio": "Mutant Enemy Productions",
"type": "season",
"title": "Season 1",
"parentKey": "/library/metadata/1",
"parentTitle": "Firefly",
"summary": "Captain Malcolm 'Mal' Reynolds is a former galactic war veteran who is the captain of the transport ship \"Serenity\". Mal and his crew, ensign Zoe Alleyne Washburne; Zoe's husband, pilot Hoban 'Wash' Washburne; muscular mercenary Jayne Cobb; young mechanic Kaylee Frye; former Alliance medical officer Simon Tam; his disturbed teenage sister River (both on the run from the interplanetary government \"The Alliance\"); the beautiful courtesan Inara Serra; and preacher Shepherd Book do any jobs, legal or illegal, they can find as the Serenity crew travels across the outskirts of outer space.",
"index": 1,
"parentIndex": 1,
"parentYear": 2002,
"thumb": "/library/metadata/2/thumb/1705636920",
"art": "/library/metadata/1/art/1705636920",
"parentThumb": "/library/metadata/1/thumb/1705636920",
"parentTheme": "/library/metadata/1/theme/1705636920",
"addedAt": 1705636916,
"updatedAt": 1705636920
}
]
}
}
```