LukeParke/plexcsharp

Fork 0

mirror of https://github.com/LukeHagar/plexcsharp.git synced 2025-12-06 12:37:46 +00:00

Files

History

speakeasybot fe81f4dff0 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.474.0

2025-01-24 00:22:18 +00:00

README.md

ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.474.0

2025-01-24 00:22:18 +00:00

README.md

Library

(Library)

Overview

API Calls interacting with Plex Media Server Libraries

Available Operations

GetFileHash - Get Hash Value
GetRecentlyAddedLibrary - Get Recently Added
GetAllLibraries - Get All Libraries
GetLibraryDetails - Get Library Details
DeleteLibrary - Delete Library Section
GetLibraryItems - Get Library Items
GetRefreshLibraryMetadata - Refresh Metadata Of The Library
GetSearchLibrary - Search Library
GetSearchAllLibraries - Search All Libraries
GetMetaDataByRatingKey - Get Metadata by RatingKey
GetMetadataChildren - Get Items Children
GetTopWatchedContent - Get Top Watched Content
GetOnDeck - Get On Deck

GetFileHash

This resource returns hash values for local files

Example Usage

using LukeHagar.PlexAPI.SDK;
using LukeHagar.PlexAPI.SDK.Models.Components;

var sdk = new PlexAPI(accessToken: "<YOUR_API_KEY_HERE>");

var res = await sdk.Library.GetFileHashAsync(
    url: "file://C:\Image.png&type=13",
    type: 4462.17D
);

// handle response

Parameters

Parameter	Type	Required	Description	Example
`Url`	string	✔️	This is the path to the local file, must be prefixed by `file://`	file://C:\Image.png&type=13
`Type`	double	➖	Item type

Response

GetFileHashResponse

Errors

Error Type	Status Code	Content Type
LukeHagar.PlexAPI.SDK.Models.Errors.GetFileHashBadRequest	400	application/json
LukeHagar.PlexAPI.SDK.Models.Errors.GetFileHashUnauthorized	401	application/json
LukeHagar.PlexAPI.SDK.Models.Errors.SDKException	4XX, 5XX	/

GetRecentlyAddedLibrary

This endpoint will return the recently added content.

Example Usage

using LukeHagar.PlexAPI.SDK;
using LukeHagar.PlexAPI.SDK.Models.Components;
using LukeHagar.PlexAPI.SDK.Models.Requests;
using System.Collections.Generic;

var sdk = new PlexAPI(accessToken: "<YOUR_API_KEY_HERE>");

GetRecentlyAddedLibraryRequest req = new GetRecentlyAddedLibraryRequest() {
    ContentDirectoryID = 2,
    PinnedContentDirectoryID = new List<long>() {
        3,
        5,
        7,
        13,
        12,
        1,
        6,
        14,
        2,
        10,
        16,
        17,
    },
    SectionID = 2,
    Type = QueryParamType.TvShow,
    IncludeMeta = QueryParamIncludeMeta.Enable,
    XPlexContainerStart = 0,
    XPlexContainerSize = 50,
};

var res = await sdk.Library.GetRecentlyAddedLibraryAsync(req);

// handle response

Parameters

Parameter	Type	Required	Description
`request`	GetRecentlyAddedLibraryRequest	✔️	The request object to use for the request.

Response

GetRecentlyAddedLibraryResponse

Errors

Error Type	Status Code	Content Type
LukeHagar.PlexAPI.SDK.Models.Errors.GetRecentlyAddedLibraryBadRequest	400	application/json
LukeHagar.PlexAPI.SDK.Models.Errors.GetRecentlyAddedLibraryUnauthorized	401	application/json
LukeHagar.PlexAPI.SDK.Models.Errors.SDKException	4XX, 5XX	/

GetAllLibraries

A library section (commonly referred to as just a library) is a collection of media. Libraries are typed, and depending on their type provide either a flat or a hierarchical view of the media. For example, a music library has an artist > albums > tracks structure, whereas a movie library is flat.

Libraries have features beyond just being a collection of media; for starters, they include information about supported types, filters and sorts. This allows a client to provide a rich interface around the media (e.g. allow sorting movies by release year).

Example Usage

using LukeHagar.PlexAPI.SDK;
using LukeHagar.PlexAPI.SDK.Models.Components;

var sdk = new PlexAPI(accessToken: "<YOUR_API_KEY_HERE>");

var res = await sdk.Library.GetAllLibrariesAsync();

// handle response

Response

GetAllLibrariesResponse

Errors

Error Type	Status Code	Content Type
LukeHagar.PlexAPI.SDK.Models.Errors.GetAllLibrariesBadRequest	400	application/json
LukeHagar.PlexAPI.SDK.Models.Errors.GetAllLibrariesUnauthorized	401	application/json
LukeHagar.PlexAPI.SDK.Models.Errors.SDKException	4XX, 5XX	/

GetLibraryDetails

Library Details Endpoint

This endpoint provides comprehensive details about the library, focusing on organizational aspects rather than the content itself.

The details include:

Directories

Organized into three categories:

Primary Directories:
- Used in some clients for quick access to media subsets (e.g., "All", "On Deck").
- Most can be replicated via media queries.
- Customizable by users.
Secondary Directories:
- Marked with secondary="1".
- Used in older clients for structured navigation.
Special Directories:
- Includes a "By Folder" entry for filesystem-based browsing.
- Contains an obsolete search="1" entry for on-the-fly search dialog creation.

Types

Each type in the library comes with a set of filters and sorts, aiding in building dynamic media controls:

Type Object Attributes:
- key: Endpoint for the media list of this type.
- type: Metadata type (if standard Plex type).
- title: Title for this content type (e.g., "Movies").
Filter Objects:
- Subset of the media query language.
- Attributes include filter (name), filterType (data type), key (endpoint for value range), and title.
Sort Objects:
- Description of sort fields.
- Attributes include defaultDirection (asc/desc), descKey and key (sort parameters), and title.

Note

: Filters and sorts are optional; without them, no filtering controls are rendered.

Example Usage

using LukeHagar.PlexAPI.SDK;
using LukeHagar.PlexAPI.SDK.Models.Components;
using LukeHagar.PlexAPI.SDK.Models.Requests;

var sdk = new PlexAPI(accessToken: "<YOUR_API_KEY_HERE>");

var res = await sdk.Library.GetLibraryDetailsAsync(
    sectionKey: 9518,
    includeDetails: IncludeDetails.Zero
);

// handle response

Parameters

Parameter	Type	Required	Description	Example
`SectionKey`	int	✔️	The unique key of the Plex library. Note: This is unique in the context of the Plex server.	9518
`IncludeDetails`	IncludeDetails	➖	Whether or not to include details for a section (types, filters, and sorts). Only exists for backwards compatibility, media providers other than the server libraries have it on always.

Response

GetLibraryDetailsResponse

Errors

Error Type	Status Code	Content Type
LukeHagar.PlexAPI.SDK.Models.Errors.GetLibraryDetailsBadRequest	400	application/json
LukeHagar.PlexAPI.SDK.Models.Errors.GetLibraryDetailsUnauthorized	401	application/json
LukeHagar.PlexAPI.SDK.Models.Errors.SDKException	4XX, 5XX	/

DeleteLibrary

Delete a library using a specific section id

Example Usage

using LukeHagar.PlexAPI.SDK;
using LukeHagar.PlexAPI.SDK.Models.Components;

var sdk = new PlexAPI(accessToken: "<YOUR_API_KEY_HERE>");

var res = await sdk.Library.DeleteLibraryAsync(sectionKey: 9518);

// handle response

Parameters

Parameter	Type	Required	Description	Example
`SectionKey`	int	✔️	The unique key of the Plex library. Note: This is unique in the context of the Plex server.	9518

Response

DeleteLibraryResponse

Errors

Error Type	Status Code	Content Type
LukeHagar.PlexAPI.SDK.Models.Errors.DeleteLibraryBadRequest	400	application/json
LukeHagar.PlexAPI.SDK.Models.Errors.DeleteLibraryUnauthorized	401	application/json
LukeHagar.PlexAPI.SDK.Models.Errors.SDKException	4XX, 5XX	/

GetLibraryItems

Fetches details from a specific section of the library identified by a section key and a tag. The tag parameter accepts the following values:

all: All items in the section.
unwatched: Items that have not been played.
newest: Items that are recently released.
recentlyAdded: Items that are recently added to the library.
recentlyViewed: Items that were recently viewed.
onDeck: Items to continue watching.
collection: Items categorized by collection.
edition: Items categorized by edition.
genre: Items categorized by genre.
year: Items categorized by year of release.
decade: Items categorized by decade.
director: Items categorized by director.
actor: Items categorized by starring actor.
country: Items categorized by country of origin.
contentRating: Items categorized by content rating.
rating: Items categorized by rating.
resolution: Items categorized by resolution.
firstCharacter: Items categorized by the first letter.
folder: Items categorized by folder.
albums: Items categorized by album.

Example Usage

using LukeHagar.PlexAPI.SDK;
using LukeHagar.PlexAPI.SDK.Models.Components;
using LukeHagar.PlexAPI.SDK.Models.Requests;

var sdk = new PlexAPI(accessToken: "<YOUR_API_KEY_HERE>");

GetLibraryItemsRequest req = new GetLibraryItemsRequest() {
    Tag = Tag.Edition,
    IncludeGuids = IncludeGuids.Enable,
    Type = GetLibraryItemsQueryParamType.TvShow,
    SectionKey = 9518,
    IncludeMeta = GetLibraryItemsQueryParamIncludeMeta.Enable,
    XPlexContainerStart = 0,
    XPlexContainerSize = 50,
};

var res = await sdk.Library.GetLibraryItemsAsync(req);

// handle response

Parameters

Parameter	Type	Required	Description
`request`	GetLibraryItemsRequest	✔️	The request object to use for the request.

Response

GetLibraryItemsResponse

Errors

Error Type	Status Code	Content Type
LukeHagar.PlexAPI.SDK.Models.Errors.GetLibraryItemsBadRequest	400	application/json
LukeHagar.PlexAPI.SDK.Models.Errors.GetLibraryItemsUnauthorized	401	application/json
LukeHagar.PlexAPI.SDK.Models.Errors.SDKException	4XX, 5XX	/

GetRefreshLibraryMetadata

This endpoint Refreshes all the Metadata of the library.

Example Usage

using LukeHagar.PlexAPI.SDK;
using LukeHagar.PlexAPI.SDK.Models.Components;
using LukeHagar.PlexAPI.SDK.Models.Requests;

var sdk = new PlexAPI(accessToken: "<YOUR_API_KEY_HERE>");

var res = await sdk.Library.GetRefreshLibraryMetadataAsync(
    sectionKey: 9518,
    force: Force.One
);

// handle response

Parameters

Parameter	Type	Required	Description	Example
`SectionKey`	int	✔️	The unique key of the Plex library. Note: This is unique in the context of the Plex server.	9518
`Force`	Force	➖	Force the refresh even if the library is already being refreshed.	0

Response

GetRefreshLibraryMetadataResponse

Errors

Error Type	Status Code	Content Type
LukeHagar.PlexAPI.SDK.Models.Errors.GetRefreshLibraryMetadataBadRequest	400	application/json
LukeHagar.PlexAPI.SDK.Models.Errors.GetRefreshLibraryMetadataUnauthorized	401	application/json
LukeHagar.PlexAPI.SDK.Models.Errors.SDKException	4XX, 5XX	/

GetSearchLibrary

Search for content within a specific section of the library.

Types

Each type in the library comes with a set of filters and sorts, aiding in building dynamic media controls:

Type Object Attributes:
- type: Metadata type (if standard Plex type).
- title: Title for this content type (e.g., "Movies").
Filter Objects:
- Subset of the media query language.
- Attributes include filter (name), filterType (data type), key (endpoint for value range), and title.
Sort Objects:
- Description of sort fields.
- Attributes include defaultDirection (asc/desc), descKey and key (sort parameters), and title.

Note

: Filters and sorts are optional; without them, no filtering controls are rendered.

Example Usage

using LukeHagar.PlexAPI.SDK;
using LukeHagar.PlexAPI.SDK.Models.Components;
using LukeHagar.PlexAPI.SDK.Models.Requests;

var sdk = new PlexAPI(accessToken: "<YOUR_API_KEY_HERE>");

var res = await sdk.Library.GetSearchLibraryAsync(
    sectionKey: 9518,
    type: GetSearchLibraryQueryParamType.TvShow
);

// handle response

Parameters

Parameter	Type	Required	Description	Example
`SectionKey`	int	✔️	The unique key of the Plex library. Note: This is unique in the context of the Plex server.	9518
`Type`	GetSearchLibraryQueryParamType	✔️	The type of media to retrieve. 1 = movie 2 = show 3 = season 4 = episode E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries	2

Response

GetSearchLibraryResponse

Errors

Error Type	Status Code	Content Type
LukeHagar.PlexAPI.SDK.Models.Errors.GetSearchLibraryBadRequest	400	application/json
LukeHagar.PlexAPI.SDK.Models.Errors.GetSearchLibraryUnauthorized	401	application/json
LukeHagar.PlexAPI.SDK.Models.Errors.SDKException	4XX, 5XX	/

GetSearchAllLibraries

Search the provided query across all library sections, or a single section, and return matches as hubs, split up by type.

Example Usage

using LukeHagar.PlexAPI.SDK;
using LukeHagar.PlexAPI.SDK.Models.Components;
using LukeHagar.PlexAPI.SDK.Models.Requests;
using System.Collections.Generic;

var sdk = new PlexAPI(accessToken: "<YOUR_API_KEY_HERE>");

GetSearchAllLibrariesRequest req = new GetSearchAllLibrariesRequest() {
    Query = "<value>",
    ClientID = "3381b62b-9ab7-4e37-827b-203e9809eb58",
    SearchTypes = new List<SearchTypes>() {
        SearchTypes.People,
    },
    IncludeCollections = QueryParamIncludeCollections.Enable,
    IncludeExternalMedia = QueryParamIncludeExternalMedia.Enable,
};

var res = await sdk.Library.GetSearchAllLibrariesAsync(req);

// handle response

Parameters

Parameter	Type	Required	Description
`request`	GetSearchAllLibrariesRequest	✔️	The request object to use for the request.

Response

GetSearchAllLibrariesResponse

Errors

Error Type	Status Code	Content Type
LukeHagar.PlexAPI.SDK.Models.Errors.GetSearchAllLibrariesBadRequest	400	application/json
LukeHagar.PlexAPI.SDK.Models.Errors.GetSearchAllLibrariesUnauthorized	401	application/json
LukeHagar.PlexAPI.SDK.Models.Errors.SDKException	4XX, 5XX	/

GetMetaDataByRatingKey

This endpoint will return the metadata of a library item specified with the ratingKey.

Example Usage

using LukeHagar.PlexAPI.SDK;
using LukeHagar.PlexAPI.SDK.Models.Components;

var sdk = new PlexAPI(accessToken: "<YOUR_API_KEY_HERE>");

var res = await sdk.Library.GetMetaDataByRatingKeyAsync(ratingKey: 9518);

// handle response

Parameters

Parameter	Type	Required	Description	Example
`RatingKey`	long	✔️	the id of the library item to return the children of.	9518

Response

GetMetaDataByRatingKeyResponse

Errors

Error Type	Status Code	Content Type
LukeHagar.PlexAPI.SDK.Models.Errors.GetMetaDataByRatingKeyBadRequest	400	application/json
LukeHagar.PlexAPI.SDK.Models.Errors.GetMetaDataByRatingKeyUnauthorized	401	application/json
LukeHagar.PlexAPI.SDK.Models.Errors.SDKException	4XX, 5XX	/

GetMetadataChildren

This endpoint will return the children of of a library item specified with the ratingKey.

Example Usage

using LukeHagar.PlexAPI.SDK;
using LukeHagar.PlexAPI.SDK.Models.Components;

var sdk = new PlexAPI(accessToken: "<YOUR_API_KEY_HERE>");

var res = await sdk.Library.GetMetadataChildrenAsync(
    ratingKey: 1539.14D,
    includeElements: "<value>"
);

// handle response

Parameters

Parameter	Type	Required	Description
`RatingKey`	double	✔️	the id of the library item to return the children of.
`IncludeElements`	string	➖	Adds additional elements to the response. Supported types are (Stream)

Response

GetMetadataChildrenResponse

Errors

Error Type	Status Code	Content Type
LukeHagar.PlexAPI.SDK.Models.Errors.GetMetadataChildrenBadRequest	400	application/json
LukeHagar.PlexAPI.SDK.Models.Errors.GetMetadataChildrenUnauthorized	401	application/json
LukeHagar.PlexAPI.SDK.Models.Errors.SDKException	4XX, 5XX	/

GetTopWatchedContent

This endpoint will return the top watched content from libraries of a certain type

Example Usage

using LukeHagar.PlexAPI.SDK;
using LukeHagar.PlexAPI.SDK.Models.Components;
using LukeHagar.PlexAPI.SDK.Models.Requests;

var sdk = new PlexAPI(accessToken: "<YOUR_API_KEY_HERE>");

var res = await sdk.Library.GetTopWatchedContentAsync(
    type: GetTopWatchedContentQueryParamType.TvShow,
    includeGuids: 1
);

// handle response

Parameters

Parameter	Type	Required	Description	Example
`Type`	GetTopWatchedContentQueryParamType	✔️	The type of media to retrieve. 1 = movie 2 = show 3 = season 4 = episode E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries	2
`IncludeGuids`	long	➖	Adds the Guids object to the response	1

Response

GetTopWatchedContentResponse

Errors

Error Type	Status Code	Content Type
LukeHagar.PlexAPI.SDK.Models.Errors.GetTopWatchedContentBadRequest	400	application/json
LukeHagar.PlexAPI.SDK.Models.Errors.GetTopWatchedContentUnauthorized	401	application/json
LukeHagar.PlexAPI.SDK.Models.Errors.SDKException	4XX, 5XX	/

GetOnDeck

This endpoint will return the on deck content.

Example Usage

using LukeHagar.PlexAPI.SDK;
using LukeHagar.PlexAPI.SDK.Models.Components;

var sdk = new PlexAPI(accessToken: "<YOUR_API_KEY_HERE>");

var res = await sdk.Library.GetOnDeckAsync();

// handle response

Response

GetOnDeckResponse

Errors

Error Type	Status Code	Content Type
LukeHagar.PlexAPI.SDK.Models.Errors.GetOnDeckBadRequest	400	application/json
LukeHagar.PlexAPI.SDK.Models.Errors.GetOnDeckUnauthorized	401	application/json
LukeHagar.PlexAPI.SDK.Models.Errors.SDKException	4XX, 5XX	/

README.md Unescape Escape

Library

Overview

Available Operations

GetFileHash

Example Usage

Parameters

Response

Errors

GetRecentlyAddedLibrary

Example Usage

Parameters

Response

Errors

GetAllLibraries

Example Usage

Response

Errors

GetLibraryDetails

Library Details Endpoint

Directories

Types

Example Usage

Parameters

Response

Errors

DeleteLibrary

Example Usage

Parameters

Response

Errors

GetLibraryItems

Example Usage

Parameters

Response

Errors

GetRefreshLibraryMetadata

Example Usage

Parameters

Response

Errors

GetSearchLibrary

Types

Example Usage

Parameters

Response

Errors

GetSearchAllLibraries

Example Usage

Parameters

Response

Errors

GetMetaDataByRatingKey

Example Usage

Parameters

Response

Errors

GetMetadataChildren

Example Usage

Parameters

Response

Errors

GetTopWatchedContent

Example Usage

Parameters

Response

Errors

GetOnDeck

Example Usage

Response

Errors

README.md