Plex-API: An Open API Spec for interacting with Plex.tv and Plex Media Server
An Open Source OpenAPI Specification for Plex Media Server
Automation and SDKs provided by Speakeasy
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
- IDE Support
- SDK Example Usage
- Available Resources and Operations
- Global Parameters
- Retries
- Error Handling
- Server Selection
- Custom HTTP Client
- Authentication
- Debugging
The SDK can be installed with either pip or poetry package managers.
PIP is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line.
pip install plex-api-clientPoetry is a modern tool that simplifies dependency management and package publishing by using a single pyproject.toml file to handle project metadata and dependencies.
poetry add plex-api-clientGenerally, the SDK will work well with most IDEs out of the box. However, when using PyCharm, you can enjoy much better integration with Pydantic by installing an additional plugin.
# Synchronous Example
from plex_api_client import PlexAPI
s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
)
res = s.server.get_server_capabilities()
if res.object is not None:
# handle response
passThe same SDK client can also be used to make asychronous requests by importing asyncio.
# Asynchronous Example
import asyncio
from plex_api_client import PlexAPI
async def main():
s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
)
res = await s.server.get_server_capabilities_async()
if res.object is not None:
# handle response
pass
asyncio.run(main())Available methods
- get_server_activities - Get Server Activities
- cancel_server_activities - Cancel Server Activities
- get_transient_token - Get a Transient Token
- get_source_connection_information - Get Source Connection Information
- get_token_details - Get Token Details
- post_users_sign_in_data - Get User Sign In Data
- get_butler_tasks - Get Butler tasks
- start_all_tasks - Start all Butler tasks
- stop_all_tasks - Stop all Butler tasks
- start_task - Start a single Butler task
- stop_task - Stop a single Butler task
- get_global_hubs - Get Global Hubs
- get_recently_added - Get Recently Added
- get_library_hubs - Get library specific hubs
- get_file_hash - Get Hash Value
- get_recently_added_library - Get Recently Added
- get_all_libraries - Get All Libraries
- get_library_details - Get Library Details
- delete_library - Delete Library Section
- get_library_items - Get Library Items
- get_refresh_library_metadata - Refresh Metadata Of The Library
- get_search_library - Search Library
- get_meta_data_by_rating_key - Get Metadata by RatingKey
- get_metadata_children - Get Items Children
- get_top_watched_content - Get Top Watched Content
- get_on_deck - Get On Deck
- log_line - Logging a single line message.
- log_multi_line - Logging a multi-line message
- enable_paper_trail - Enabling Papertrail
- mark_played - Mark Media Played
- mark_unplayed - Mark Media Unplayed
- update_play_progress - Update Media Play Progress
- get_banner_image - Get Banner Image
- get_thumb_image - Get Thumb Image
- create_playlist - Create a Playlist
- get_playlists - Get All Playlists
- get_playlist - Retrieve Playlist
- delete_playlist - Deletes a Playlist
- update_playlist - Update a Playlist
- get_playlist_contents - Retrieve Playlist Contents
- clear_playlist_contents - Delete Playlist Contents
- add_playlist_contents - Adding to a Playlist
- upload_playlist - Upload Playlist
- get_companions_data - Get Companions Data
- get_user_friends - Get list of friends of the user logged in
- get_geo_data - Get Geo Data
- get_home_data - Get Plex Home Data
- get_server_resources - Get Server Resources
- get_pin - Get a Pin
- get_token_by_pin_id - Get Access Token by PinId
- perform_search - Perform a search
- perform_voice_search - Perform a voice search
- get_search_results - Get Search Results
- get_server_capabilities - Get Server Capabilities
- get_server_preferences - Get Server Preferences
- get_available_clients - Get Available Clients
- get_devices - Get Devices
- get_server_identity - Get Server Identity
- get_my_plex_account - Get MyPlex Account
- get_resized_photo - Get a Resized Photo
- get_media_providers - Get Media Providers
- get_server_list - Get Server List
- get_sessions - Get Active Sessions
- get_session_history - Get Session History
- get_transcode_sessions - Get Transcode Sessions
- stop_transcode_session - Stop a Transcode Session
- get_statistics - Get Media Statistics
- get_resources_statistics - Get Resources Statistics
- get_bandwidth_statistics - Get Bandwidth Statistics
- get_update_status - Querying status of updates
- check_for_updates - Checking for updates
- apply_updates - Apply Updates
- get_timeline - Get the timeline for a media item
- start_universal_transcode - Start Universal Transcode
- get_watch_list - Get User Watchlist
Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
To change the default retry strategy for a single API call, simply provide a RetryConfig object to the call:
from plex_api.utils import BackoffStrategy, RetryConfig
from plex_api_client import PlexAPI
s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
)
res = s.server.get_server_capabilities(,
RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))
if res.object is not None:
# handle response
passIf you'd like to override the default retry strategy for all operations that support retries, you can use the retry_config optional parameter when initializing the SDK:
from plex_api.utils import BackoffStrategy, RetryConfig
from plex_api_client import PlexAPI
s = PlexAPI(
retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
)
res = s.server.get_server_capabilities()
if res.object is not None:
# handle response
passHandling 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 raise a errors.SDKError exception, which has the following properties:
| Property | Type | Description |
|---|---|---|
.status_code |
int | The HTTP status code |
.message |
str | The error message |
.raw_response |
httpx.Response | The raw HTTP response |
.body |
str | The response content |
When custom error responses are specified for an operation, the SDK may also raise their associated exceptions. You can refer to respective Errors tables in SDK docs for more details on possible exception types for each operation. For example, the get_server_capabilities_async method may raise the following exceptions:
| Error Type | Status Code | Content Type |
|---|---|---|
| errors.GetServerCapabilitiesBadRequest | 400 | application/json |
| errors.GetServerCapabilitiesUnauthorized | 401 | application/json |
| errors.SDKError | 4XX, 5XX | */* |
from plex_api_client import PlexAPI
from plex_api_client.models import errors
s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
)
res = None
try:
res = s.server.get_server_capabilities()
if res.object is not None:
# handle response
pass
except errors.GetServerCapabilitiesBadRequest as e:
# handle e.data: errors.GetServerCapabilitiesBadRequestData
raise(e)
except errors.GetServerCapabilitiesUnauthorized as e:
# handle e.data: errors.GetServerCapabilitiesUnauthorizedData
raise(e)
except errors.SDKError as e:
# handle exception
raise(e)You can override the default server globally by passing a server index to the server_idx: int optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
| # | Server | Variables |
|---|---|---|
| 0 | {protocol}://{ip}:{port} |
protocol (default is https), ip (default is 10.10.10.47), port (default is 32400) |
from plex_api_client import PlexAPI
s = PlexAPI(
server_idx=0,
access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
)
res = s.server.get_server_capabilities()
if res.object is not None:
# handle response
passSome of the server options above contain variables. If you want to set the values of those variables, the following optional parameters are available when initializing the SDK client instance:
protocol: models.ServerProtocolip: strport: str
The default server can also be overridden globally by passing a URL to the server_url: str optional parameter when initializing the SDK client instance. For example:
from plex_api_client import PlexAPI
s = PlexAPI(
server_url="{protocol}://{ip}:{port}",
access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
)
res = s.server.get_server_capabilities()
if res.object is not None:
# handle response
passThe server URL can also be overridden on a per-operation basis, provided a server list was specified for the operation. For example:
from plex_api_client import PlexAPI
s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
)
res = s.plex.get_companions_data(server_url="https://plex.tv/api/v2")
if res.response_bodies is not None:
# handle response
passThe Python SDK makes API calls using the httpx HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with your own HTTP client instance.
Depending on whether you are using the sync or async version of the SDK, you can pass an instance of HttpClient or AsyncHttpClient respectively, which are Protocol's ensuring that the client has the necessary methods to make API calls.
This allows you to wrap the client with your own custom logic, such as adding custom headers, logging, or error handling, or you can just pass an instance of httpx.Client or httpx.AsyncClient directly.
For example, you could specify a header for every request that this sdk makes as follows:
from plex_api_client import PlexAPI
import httpx
http_client = httpx.Client(headers={"x-custom-header": "someValue"})
s = PlexAPI(client=http_client)or you could wrap the client with your own custom logic:
from plex_api_client import PlexAPI
from plex_api_client.httpclient import AsyncHttpClient
import httpx
class CustomClient(AsyncHttpClient):
client: AsyncHttpClient
def __init__(self, client: AsyncHttpClient):
self.client = client
async def send(
self,
request: httpx.Request,
*,
stream: bool = False,
auth: Union[
httpx._types.AuthTypes, httpx._client.UseClientDefault, None
] = httpx.USE_CLIENT_DEFAULT,
follow_redirects: Union[
bool, httpx._client.UseClientDefault
] = httpx.USE_CLIENT_DEFAULT,
) -> httpx.Response:
request.headers["Client-Level-Header"] = "added by client"
return await self.client.send(
request, stream=stream, auth=auth, follow_redirects=follow_redirects
)
def build_request(
self,
method: str,
url: httpx._types.URLTypes,
*,
content: Optional[httpx._types.RequestContent] = None,
data: Optional[httpx._types.RequestData] = None,
files: Optional[httpx._types.RequestFiles] = None,
json: Optional[Any] = None,
params: Optional[httpx._types.QueryParamTypes] = None,
headers: Optional[httpx._types.HeaderTypes] = None,
cookies: Optional[httpx._types.CookieTypes] = None,
timeout: Union[
httpx._types.TimeoutTypes, httpx._client.UseClientDefault
] = httpx.USE_CLIENT_DEFAULT,
extensions: Optional[httpx._types.RequestExtensions] = None,
) -> httpx.Request:
return self.client.build_request(
method,
url,
content=content,
data=data,
files=files,
json=json,
params=params,
headers=headers,
cookies=cookies,
timeout=timeout,
extensions=extensions,
)
s = PlexAPI(async_client=CustomClient(httpx.AsyncClient()))This SDK supports the following security scheme globally:
| Name | Type | Scheme |
|---|---|---|
access_token |
apiKey | API key |
To authenticate with the API the access_token parameter must be set when initializing the SDK client instance. For example:
from plex_api_client import PlexAPI
s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
)
res = s.server.get_server_capabilities()
if res.object is not None:
# handle response
passCertain parameters are configured globally. These parameters may be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, These global values will be used as defaults on the operations that use them. When such operations are called, there is a place in each to override the global value, if needed.
For example, you can set ClientID to "gcgzw5rz2xovp84b4vha3a40" at SDK initialization and then you do not have to pass the same value on calls to operations like get_server_resources. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.
The following global parameters are available.
| Name | Type | Required | Description |
|---|---|---|---|
| client_id | str | The unique identifier for the client application | |
| This is used to track the client application and its usage | |||
| (UUID, serial number, or other number unique per device) |
| | client_name | str | | The client_name parameter. | | client_version | str | | The client_version parameter. | | client_platform | str | | The client_platform parameter. | | device_name | str | | The device_name parameter. |
from plex_api_client import PlexAPI
from plex_api_client.models import operations
s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
)
res = s.plex.get_server_resources(include_https=operations.IncludeHTTPS.ENABLE, include_relay=operations.IncludeRelay.ENABLE, include_i_pv6=operations.IncludeIPv6.ENABLE, client_id="gcgzw5rz2xovp84b4vha3a40")
if res.plex_devices is not None:
# handle response
passYou can setup your SDK to emit debug logs for SDK requests and responses.
You can pass your own logger class directly into your SDK.
from plex_api_client import PlexAPI
import logging
logging.basicConfig(level=logging.DEBUG)
s = PlexAPI(debug_logger=logging.getLogger("plex_api_client"))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.
While we value open-source contributions to this SDK, this library is generated programmatically. Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!