plexapi

Summary

Plex-API: An Open API Spec for interacting with Plex.tv and Plex Media Server

Plex Media Server OpenAPI Specification

An Open Source OpenAPI Specification for Plex Media Server

Automation and SDKs provided by Speakeasy

Documentation

API Documentation

SDKs

The following SDKs are generated from the OpenAPI Specification. They are automatically generated and may not be fully tested. If you find any issues, please open an issue on the main specification Repository.

Language	Repository	Releases	Other
Python	GitHub	PyPI	-
JavaScript/TypeScript	GitHub	NPM \ JSR	-
Go	GitHub	Releases	GoDoc
Ruby	GitHub	Releases	-
Swift	GitHub	Releases	-
PHP	GitHub	Releases	-
Java	GitHub	Releases	-
C#	GitHub	Releases	-

SDK Installation

Getting started

JDK 11 or later is required.

The samples below show how a published SDK artifact is used:

Gradle:

implementation 'dev.plexapi:plexapi:0.10.1'

Maven:

<dependency>
    <groupId>dev.plexapi</groupId>
    <artifactId>plexapi</artifactId>
    <version>0.10.1</version>
</dependency>

How to build

After cloning the git repository to your file system you can build the SDK artifact from source to the build directory by running ./gradlew build on *nix systems or gradlew.bat on Windows systems.

If you wish to build from source and publish the SDK artifact to your local Maven repository (on your filesystem) then use the following command (after cloning the git repo locally):

On *nix:

./gradlew publishToMavenLocal -Pskip.signing

On Windows:

gradlew.bat publishToMavenLocal -Pskip.signing

SDK Example Usage

Example

package hello.world;

import dev.plexapi.sdk.PlexAPI;
import dev.plexapi.sdk.models.errors.GetServerCapabilitiesBadRequest;
import dev.plexapi.sdk.models.errors.GetServerCapabilitiesUnauthorized;
import dev.plexapi.sdk.models.operations.GetServerCapabilitiesResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws GetServerCapabilitiesBadRequest, GetServerCapabilitiesUnauthorized, Exception {

        PlexAPI sdk = PlexAPI.builder()
                .accessToken("<YOUR_API_KEY_HERE>")
                .clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
                .clientName("Plex for Roku")
                .clientVersion("2.4.1")
                .platform("Roku")
                .deviceNickname("Roku 3")
            .build();

        GetServerCapabilitiesResponse res = sdk.server().getServerCapabilities()
                .call();

        if (res.object().isPresent()) {
            // handle response
        }
    }
}

Available Resources and Operations

Available methods

activities()

getServerActivities - Get Server Activities
cancelServerActivities - Cancel Server Activities

authentication()

getTransientToken - Get a Transient Token
getSourceConnectionInformation - Get Source Connection Information
getTokenDetails - Get Token Details
postUsersSignInData - Get User Sign In Data

butler()

getButlerTasks - Get Butler tasks
startAllTasks - Start all Butler tasks
stopAllTasks - Stop all Butler tasks
startTask - Start a single Butler task
stopTask - Stop a single Butler task

hubs()

getGlobalHubs - Get Global Hubs
getRecentlyAdded - Get Recently Added
getLibraryHubs - Get library specific hubs

library()

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

log()

logLine - Logging a single line message.
logMultiLine - Logging a multi-line message
enablePaperTrail - Enabling Papertrail

media()

markPlayed - Mark Media Played
markUnplayed - Mark Media Unplayed
updatePlayProgress - Update Media Play Progress
getBannerImage - Get Banner Image
getThumbImage - Get Thumb Image

playlists()

createPlaylist - Create a Playlist
getPlaylists - Get All Playlists
getPlaylist - Retrieve Playlist
deletePlaylist - Deletes a Playlist
updatePlaylist - Update a Playlist
getPlaylistContents - Retrieve Playlist Contents
clearPlaylistContents - Delete Playlist Contents
addPlaylistContents - Adding to a Playlist
uploadPlaylist - Upload Playlist

plex()

getCompanionsData - Get Companions Data
getUserFriends - Get list of friends of the user logged in
getGeoData - Get Geo Data
getHomeData - Get Plex Home Data
getServerResources - Get Server Resources
getPin - Get a Pin
getTokenByPinId - Get Access Token by PinId

search()

performSearch - Perform a search
performVoiceSearch - Perform a voice search
getSearchResults - Get Search Results

server()

getServerCapabilities - Get Server Capabilities
getServerPreferences - Get Server Preferences
getAvailableClients - Get Available Clients
getDevices - Get Devices
getServerIdentity - Get Server Identity
getMyPlexAccount - Get MyPlex Account
getResizedPhoto - Get a Resized Photo
getMediaProviders - Get Media Providers
getServerList - Get Server List

sessions()

getSessions - Get Active Sessions
getSessionHistory - Get Session History
getTranscodeSessions - Get Transcode Sessions
stopTranscodeSession - Stop a Transcode Session

statistics()

getStatistics - Get Media Statistics
getResourcesStatistics - Get Resources Statistics
getBandwidthStatistics - Get Bandwidth Statistics

updater()

getUpdateStatus - Querying status of updates
checkForUpdates - Checking for updates
applyUpdates - Apply Updates

video()

getTimeline - Get the timeline for a media item
startUniversalTranscode - Start Universal Transcode

watchlist()

getWatchList - Get User Watchlist

Error Handling

Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an exception.

By default, an API error will throw a models/errors/SDKError exception. When custom error responses are specified for an operation, the SDK may also throw their associated exception. You can refer to respective Errors tables in SDK docs for more details on possible exception types for each operation. For example, the getServerCapabilities method throws the following exceptions:

Error Type	Status Code	Content Type
models/errors/GetServerCapabilitiesBadRequest	400	application/json
models/errors/GetServerCapabilitiesUnauthorized	401	application/json
models/errors/SDKError	4XX, 5XX	/

Example

package hello.world;

import dev.plexapi.sdk.PlexAPI;
import dev.plexapi.sdk.models.errors.GetServerCapabilitiesBadRequest;
import dev.plexapi.sdk.models.errors.GetServerCapabilitiesUnauthorized;
import dev.plexapi.sdk.models.operations.GetServerCapabilitiesResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws GetServerCapabilitiesBadRequest, GetServerCapabilitiesUnauthorized, Exception {

        PlexAPI sdk = PlexAPI.builder()
                .accessToken("<YOUR_API_KEY_HERE>")
                .clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
                .clientName("Plex for Roku")
                .clientVersion("2.4.1")
                .platform("Roku")
                .deviceNickname("Roku 3")
            .build();

        GetServerCapabilitiesResponse res = sdk.server().getServerCapabilities()
                .call();

        if (res.object().isPresent()) {
            // handle response
        }
    }
}

Server Selection

Server Variables

The default server {protocol}://{ip}:{port} contains variables and is set to https://10.10.10.47:32400 by default. To override default values, the following builder methods are available when initializing the SDK client instance:

protocol(ServerProtocol protocol)
ip(String ip)
port(String port)

Override Server URL Per-Client

The default server can also be overridden globally using the .serverURL(String serverUrl) builder method when initializing the SDK client instance. For example:

package hello.world;

import dev.plexapi.sdk.PlexAPI;
import dev.plexapi.sdk.models.errors.GetServerCapabilitiesBadRequest;
import dev.plexapi.sdk.models.errors.GetServerCapabilitiesUnauthorized;
import dev.plexapi.sdk.models.operations.GetServerCapabilitiesResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws GetServerCapabilitiesBadRequest, GetServerCapabilitiesUnauthorized, Exception {

        PlexAPI sdk = PlexAPI.builder()
                .serverURL("https://10.10.10.47:32400")
                .accessToken("<YOUR_API_KEY_HERE>")
                .clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
                .clientName("Plex for Roku")
                .clientVersion("2.4.1")
                .platform("Roku")
                .deviceNickname("Roku 3")
            .build();

        GetServerCapabilitiesResponse res = sdk.server().getServerCapabilities()
                .call();

        if (res.object().isPresent()) {
            // handle response
        }
    }
}

Override Server URL Per-Operation

The server URL can also be overridden on a per-operation basis, provided a server list was specified for the operation. For example:

package hello.world;

import dev.plexapi.sdk.PlexAPI;
import dev.plexapi.sdk.models.errors.GetCompanionsDataBadRequest;
import dev.plexapi.sdk.models.errors.GetCompanionsDataUnauthorized;
import dev.plexapi.sdk.models.operations.GetCompanionsDataResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws GetCompanionsDataBadRequest, GetCompanionsDataUnauthorized, Exception {

        PlexAPI sdk = PlexAPI.builder()
                .accessToken("<YOUR_API_KEY_HERE>")
                .clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
                .clientName("Plex for Roku")
                .clientVersion("2.4.1")
                .platform("Roku")
                .deviceNickname("Roku 3")
            .build();

        GetCompanionsDataResponse res = sdk.plex().getCompanionsData()
                .serverURL("https://plex.tv/api/v2")
                .call();

        if (res.responseBodies().isPresent()) {
            // handle response
        }
    }
}

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name	Type	Scheme
`accessToken`	apiKey	API key

To authenticate with the API the accessToken parameter must be set when initializing the SDK client instance. For example:

package hello.world;

import dev.plexapi.sdk.PlexAPI;
import dev.plexapi.sdk.models.errors.GetServerCapabilitiesBadRequest;
import dev.plexapi.sdk.models.errors.GetServerCapabilitiesUnauthorized;
import dev.plexapi.sdk.models.operations.GetServerCapabilitiesResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws GetServerCapabilitiesBadRequest, GetServerCapabilitiesUnauthorized, Exception {

        PlexAPI sdk = PlexAPI.builder()
                .accessToken("<YOUR_API_KEY_HERE>")
                .clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
                .clientName("Plex for Roku")
                .clientVersion("2.4.1")
                .platform("Roku")
                .deviceNickname("Roku 3")
            .build();

        GetServerCapabilitiesResponse res = sdk.server().getServerCapabilities()
                .call();

        if (res.object().isPresent()) {
            // handle response
        }
    }
}

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

Name		Name	Last commit message	Last commit date
Latest commit History 65 Commits
.github/workflows		.github/workflows
.speakeasy		.speakeasy
docs		docs
gradle/wrapper		gradle/wrapper
src/main/java/dev/plexapi/sdk		src/main/java/dev/plexapi/sdk
.gitattributes		.gitattributes
.gitignore		.gitignore
CONTRIBUTING.md		CONTRIBUTING.md
README.md		README.md
RELEASES.md		RELEASES.md
USAGE.md		USAGE.md
build-extras.gradle		build-extras.gradle
build.gradle		build.gradle
codeSamples.yaml		codeSamples.yaml
gradlew		gradlew
gradlew.bat		gradlew.bat
settings.gradle		settings.gradle

LukeHagar/plexjava

Folders and files

Latest commit

History

Repository files navigation

plexapi

Summary

Plex Media Server OpenAPI Specification

Documentation

SDKs

Table of Contents

SDK Installation

Getting started

How to build

SDK Example Usage

Example

Available Resources and Operations

Error Handling

Example

Server Selection

Server Variables

Override Server URL Per-Client

Override Server URL Per-Operation

Authentication

Per-Client Security Schemes

Development

Maturity

Contributions

SDK Created by Speakeasy

About

Resources

Stars

Watchers

Forks

Languages