LukeParke/plexcsharp

Fork 0

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

Files

speakeasybot ec1b25e152 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.383.2

2024-08-30 00:10:10 +00:00

30 KiB

Raw Blame History

Library

(Library)

Overview

API Calls interacting with Plex Media Server Libraries

Available Operations

GetFileHash - Get Hash Value
GetRecentlyAdded - 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
SearchLibrary - Search Library
GetMetadata - Get Items Metadata
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 PlexAPI;
using PlexAPI.Models.Requests;
using PlexAPI.Models.Components;

var sdk = new PlexAPISDK(
    accessToken: "<YOUR_API_KEY_HERE>",
    xPlexClientIdentifier: "Postman"
);

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 Object	Status Code	Content Type
PlexAPI.Models.Errors.GetFileHashResponseBody	401	application/json
PlexAPI.Models.Errors.SDKException	4xx-5xx	/

GetRecentlyAdded

This endpoint will return the recently added content.

Example Usage

using PlexAPI;
using PlexAPI.Models.Components;

var sdk = new PlexAPISDK(
    accessToken: "<YOUR_API_KEY_HERE>",
    xPlexClientIdentifier: "Postman"
);

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

// handle response

Response

GetRecentlyAddedResponse

Errors

Error Object	Status Code	Content Type
PlexAPI.Models.Errors.GetRecentlyAddedResponseBody	401	application/json
PlexAPI.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 PlexAPI;
using PlexAPI.Models.Components;

var sdk = new PlexAPISDK(
    accessToken: "<YOUR_API_KEY_HERE>",
    xPlexClientIdentifier: "Postman"
);

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

// handle response

Response

GetAllLibrariesResponse

Errors

Error Object	Status Code	Content Type
PlexAPI.Models.Errors.GetAllLibrariesResponseBody	401	application/json
PlexAPI.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 PlexAPI;
using PlexAPI.Models.Requests;
using PlexAPI.Models.Components;

var sdk = new PlexAPISDK(
    accessToken: "<YOUR_API_KEY_HERE>",
    xPlexClientIdentifier: "Postman"
);

var res = await sdk.Library.GetLibraryDetailsAsync(
    sectionId: 15D,
    includeDetails: PlexAPI.Models.Requests.IncludeDetails.Zero
);

// handle response

Parameters

Parameter	Type	Required	Description	Example
`SectionId`	double	✔️	The id of the library	15
`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 Object	Status Code	Content Type
PlexAPI.Models.Errors.GetLibraryDetailsResponseBody	401	application/json
PlexAPI.Models.Errors.SDKException	4xx-5xx	/

DeleteLibrary

Delete a library using a specific section id

Example Usage

using PlexAPI;
using PlexAPI.Models.Requests;
using PlexAPI.Models.Components;

var sdk = new PlexAPISDK(
    accessToken: "<YOUR_API_KEY_HERE>",
    xPlexClientIdentifier: "Postman"
);

var res = await sdk.Library.DeleteLibraryAsync(sectionId: 15D);

// handle response

Parameters

Parameter	Type	Required	Description	Example
`SectionId`	double	✔️	The id of the library	15

Response

DeleteLibraryResponse

Errors

Error Object	Status Code	Content Type
PlexAPI.Models.Errors.DeleteLibraryResponseBody	401	application/json
PlexAPI.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.

Example Usage

using PlexAPI;
using PlexAPI.Models.Requests;
using PlexAPI.Models.Components;

var sdk = new PlexAPISDK(
    accessToken: "<YOUR_API_KEY_HERE>",
    xPlexClientIdentifier: "Postman"
);

var res = await sdk.Library.GetLibraryItemsAsync(
    sectionId: "<value>",
    tag: PlexAPI.Models.Requests.Tag.Genre,
    includeGuids: 1
);

// handle response

Parameters

Parameter	Type	Required	Description	Example
`SectionId`	object	✔️	the Id of the library to query
`Tag`	Tag	✔️	A key representing a specific tag within the section.
`IncludeGuids`	long	➖	Adds the Guids object to the response	1

Response

GetLibraryItemsResponse

Errors

Error Object	Status Code	Content Type
PlexAPI.Models.Errors.GetLibraryItemsResponseBody	401	application/json
PlexAPI.Models.Errors.SDKException	4xx-5xx	/

GetRefreshLibraryMetadata

This endpoint Refreshes all the Metadata of the library.

Example Usage

using PlexAPI;
using PlexAPI.Models.Requests;
using PlexAPI.Models.Components;

var sdk = new PlexAPISDK(
    accessToken: "<YOUR_API_KEY_HERE>",
    xPlexClientIdentifier: "Postman"
);

var res = await sdk.Library.GetRefreshLibraryMetadataAsync(
    sectionId: 15D,
    force: PlexAPI.Models.Requests.Force.One
);

// handle response

Parameters

Parameter	Type	Required	Description	Example
`SectionId`	double	✔️	The id of the library	15
`Force`	Force	➖	Force the refresh even if the library is already being refreshed.	0

Response

GetRefreshLibraryMetadataResponse

Errors

Error Object	Status Code	Content Type
PlexAPI.Models.Errors.GetRefreshLibraryMetadataResponseBody	401	application/json
PlexAPI.Models.Errors.SDKException	4xx-5xx	/

SearchLibrary

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 PlexAPI;
using PlexAPI.Models.Requests;
using PlexAPI.Models.Components;

var sdk = new PlexAPISDK(
    accessToken: "<YOUR_API_KEY_HERE>",
    xPlexClientIdentifier: "Postman"
);

var res = await sdk.Library.SearchLibraryAsync(
    sectionId: 933505,
    type: PlexAPI.Models.Requests.Type.Four
);

// handle response

Parameters

Parameter	Type	Required	Description
`SectionId`	long	✔️	the Id of the library to query
`Type`	Models.Requests.Type	✔️	Plex content type to search for

Response

SearchLibraryResponse

Errors

Error Object	Status Code	Content Type
PlexAPI.Models.Errors.SearchLibraryResponseBody	401	application/json
PlexAPI.Models.Errors.SDKException	4xx-5xx	/

GetMetadata

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

Example Usage

using PlexAPI;
using PlexAPI.Models.Requests;
using PlexAPI.Models.Components;

var sdk = new PlexAPISDK(
    accessToken: "<YOUR_API_KEY_HERE>",
    xPlexClientIdentifier: "Postman"
);

var res = await sdk.Library.GetMetadataAsync(ratingKey: 8382.31D);

// handle response

Parameters

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

Response

GetMetadataResponse

Errors

Error Object	Status Code	Content Type
PlexAPI.Models.Errors.GetMetadataResponseBody	401	application/json
PlexAPI.Models.Errors.SDKException	4xx-5xx	/

GetMetadataChildren

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

Example Usage

using PlexAPI;
using PlexAPI.Models.Requests;
using PlexAPI.Models.Components;

var sdk = new PlexAPISDK(
    accessToken: "<YOUR_API_KEY_HERE>",
    xPlexClientIdentifier: "Postman"
);

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 Object	Status Code	Content Type
PlexAPI.Models.Errors.GetMetadataChildrenResponseBody	401	application/json
PlexAPI.Models.Errors.SDKException	4xx-5xx	/

GetTopWatchedContent

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

Example Usage

using PlexAPI;
using PlexAPI.Models.Requests;
using PlexAPI.Models.Components;

var sdk = new PlexAPISDK(
    accessToken: "<YOUR_API_KEY_HERE>",
    xPlexClientIdentifier: "Postman"
);

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

// handle response

Parameters

Parameter	Type	Required	Description	Example
`Type`	long	✔️	the library type (1 - movies, 2 - shows, 3 - music)
`IncludeGuids`	long	➖	Adds the Guids object to the response	1

Response

GetTopWatchedContentResponse

Errors

Error Object	Status Code	Content Type
PlexAPI.Models.Errors.SDKException	4xx-5xx	/

GetOnDeck

This endpoint will return the on deck content.

Example Usage

using PlexAPI;
using PlexAPI.Models.Components;

var sdk = new PlexAPISDK(
    accessToken: "<YOUR_API_KEY_HERE>",
    xPlexClientIdentifier: "Postman"
);

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

// handle response

Response

GetOnDeckResponse

Errors

Error Object	Status Code	Content Type
PlexAPI.Models.Errors.GetOnDeckResponseBody	401	application/json
PlexAPI.Models.Errors.SDKException	4xx-5xx	/

30 KiB Raw Blame History Unescape Escape

Library

Overview

Available Operations

GetFileHash

Example Usage

Parameters

Response

Errors

GetRecentlyAdded

Example Usage

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

SearchLibrary

Types

Example Usage

Parameters

Response

Errors

GetMetadata

Example Usage

Parameters

Response

Errors

GetMetadataChildren

Example Usage

Parameters

Response

Errors

GetTopWatchedContent

Example Usage

Parameters

Response

Errors

GetOnDeck

Example Usage

Response

Errors

30 KiB

Raw Blame History