plexpy/docs/sdks/libraryplaylists/README.md

LibraryPlaylists

(library_playlists)

Overview

Endpoints for manipulating playlists.

Available Operations

• create_playlist - Create a Playlist
• upload_playlist - Upload
• delete_playlist - Delete a Playlist
• update_playlist - Editing a Playlist
• get_playlist_generators - Get a playlist's generators
• clear_playlist_items - Clearing a playlist
• add_playlist_items - Adding to a Playlist
• delete_playlist_item - Delete a Generator
• get_playlist_generator - Get a playlist generator
• modify_playlist_generator - Modify a Generator
• get_playlist_generator_items - Get a playlist generator's items
• move_playlist_item - Moving items in a playlist
• refresh_playlist - Reprocess a generator

create_playlist

Create a new playlist. By default the playlist is blank.

Example Usage

from plex_api_client import PlexAPI
from plex_api_client.models import components


with PlexAPI(
    accepts=components.Accepts.APPLICATION_XML,
    client_identifier="abc123",
    product="Plex for Roku",
    version="2.4.1",
    platform="Roku",
    platform_version="4.3 build 1057",
    device="Roku 3",
    model="4200X",
    device_vendor="Roku",
    device_name="Living Room TV",
    marketplace="googlePlay",
    token="<YOUR_API_KEY_HERE>",
) as plex_api:

    res = plex_api.library_playlists.create_playlist(request={
        "uri": "https://short-term-disconnection.name/",
    })

    assert res.media_container_with_playlist_metadata is not None

    # Handle response
    print(res.media_container_with_playlist_metadata)

Parameters

Parameter	Type	Required	Description
request	operations.CreatePlaylistRequest	✔️	The request object to use for the request.
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

operations.CreatePlaylistResponse

Errors

Error Type	Status Code	Content Type
errors.SDKError	4XX, 5XX	*/*

upload_playlist

Imports m3u playlists by passing a path on the server to scan for m3u-formatted playlist files, or a path to a single playlist file.

Example Usage

from plex_api_client import PlexAPI
from plex_api_client.models import components


with PlexAPI(
    accepts=components.Accepts.APPLICATION_XML,
    client_identifier="abc123",
    product="Plex for Roku",
    version="2.4.1",
    platform="Roku",
    platform_version="4.3 build 1057",
    device="Roku 3",
    model="4200X",
    device_vendor="Roku",
    device_name="Living Room TV",
    marketplace="googlePlay",
    token="<YOUR_API_KEY_HERE>",
) as plex_api:

    res = plex_api.library_playlists.upload_playlist(request={
        "path": "/home/barkley/playlist.m3u",
        "force": components.BoolInt.ONE,
    })

    assert res is not None

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
request	operations.UploadPlaylistRequest	✔️	The request object to use for the request.
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

operations.UploadPlaylistResponse

Errors

Error Type	Status Code	Content Type
errors.SDKError	4XX, 5XX	*/*

delete_playlist

Deletes a playlist by provided id

Example Usage

from plex_api_client import PlexAPI
from plex_api_client.models import components


with PlexAPI(
    accepts=components.Accepts.APPLICATION_XML,
    client_identifier="abc123",
    product="Plex for Roku",
    version="2.4.1",
    platform="Roku",
    platform_version="4.3 build 1057",
    device="Roku 3",
    model="4200X",
    device_vendor="Roku",
    device_name="Living Room TV",
    marketplace="googlePlay",
    token="<YOUR_API_KEY_HERE>",
) as plex_api:

    res = plex_api.library_playlists.delete_playlist(request={
        "playlist_id": 343293,
    })

    assert res is not None

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
request	operations.DeletePlaylistRequest	✔️	The request object to use for the request.
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

operations.DeletePlaylistResponse

Errors

Error Type	Status Code	Content Type
errors.SDKError	4XX, 5XX	*/*

update_playlist

Edits a playlist in the same manner as editing metadata

Example Usage

from plex_api_client import PlexAPI
from plex_api_client.models import components


with PlexAPI(
    accepts=components.Accepts.APPLICATION_XML,
    client_identifier="abc123",
    product="Plex for Roku",
    version="2.4.1",
    platform="Roku",
    platform_version="4.3 build 1057",
    device="Roku 3",
    model="4200X",
    device_vendor="Roku",
    device_name="Living Room TV",
    marketplace="googlePlay",
    token="<YOUR_API_KEY_HERE>",
) as plex_api:

    res = plex_api.library_playlists.update_playlist(request={
        "playlist_id": 157966,
    })

    assert res is not None

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
request	operations.UpdatePlaylistRequest	✔️	The request object to use for the request.
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

operations.UpdatePlaylistResponse

Errors

Error Type	Status Code	Content Type
errors.SDKError	4XX, 5XX	*/*

get_playlist_generators

Get all the generators in a playlist

Example Usage

from plex_api_client import PlexAPI
from plex_api_client.models import components


with PlexAPI(
    accepts=components.Accepts.APPLICATION_XML,
    client_identifier="abc123",
    product="Plex for Roku",
    version="2.4.1",
    platform="Roku",
    platform_version="4.3 build 1057",
    device="Roku 3",
    model="4200X",
    device_vendor="Roku",
    device_name="Living Room TV",
    marketplace="googlePlay",
    token="<YOUR_API_KEY_HERE>",
) as plex_api:

    res = plex_api.library_playlists.get_playlist_generators(request={
        "playlist_id": 162342,
    })

    assert res.object is not None

    # Handle response
    print(res.object)

Parameters

Parameter	Type	Required	Description
request	operations.GetPlaylistGeneratorsRequest	✔️	The request object to use for the request.
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

operations.GetPlaylistGeneratorsResponse

Errors

Error Type	Status Code	Content Type
errors.SDKError	4XX, 5XX	*/*

clear_playlist_items

Clears a playlist, only works with dumb playlists. Returns the playlist.

Example Usage

from plex_api_client import PlexAPI
from plex_api_client.models import components


with PlexAPI(
    accepts=components.Accepts.APPLICATION_XML,
    client_identifier="abc123",
    product="Plex for Roku",
    version="2.4.1",
    platform="Roku",
    platform_version="4.3 build 1057",
    device="Roku 3",
    model="4200X",
    device_vendor="Roku",
    device_name="Living Room TV",
    marketplace="googlePlay",
    token="<YOUR_API_KEY_HERE>",
) as plex_api:

    res = plex_api.library_playlists.clear_playlist_items(request={
        "playlist_id": 552140,
    })

    assert res.media_container_with_playlist_metadata is not None

    # Handle response
    print(res.media_container_with_playlist_metadata)

Parameters

Parameter	Type	Required	Description
request	operations.ClearPlaylistItemsRequest	✔️	The request object to use for the request.
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

operations.ClearPlaylistItemsResponse

Errors

Error Type	Status Code	Content Type
errors.SDKError	4XX, 5XX	*/*

add_playlist_items

Adds a generator to a playlist, same parameters as the POST above. With a dumb playlist, this adds the specified items to the playlist. With a smart playlist, passing a new uri parameter replaces the rules for the playlist. Returns the playlist.

Example Usage

from plex_api_client import PlexAPI
from plex_api_client.models import components


with PlexAPI(
    accepts=components.Accepts.APPLICATION_XML,
    client_identifier="abc123",
    product="Plex for Roku",
    version="2.4.1",
    platform="Roku",
    platform_version="4.3 build 1057",
    device="Roku 3",
    model="4200X",
    device_vendor="Roku",
    device_name="Living Room TV",
    marketplace="googlePlay",
    token="<YOUR_API_KEY_HERE>",
) as plex_api:

    res = plex_api.library_playlists.add_playlist_items(request={
        "playlist_id": 533723,
    })

    assert res.media_container_with_playlist_metadata is not None

    # Handle response
    print(res.media_container_with_playlist_metadata)

Parameters

Parameter	Type	Required	Description
request	operations.AddPlaylistItemsRequest	✔️	The request object to use for the request.
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

operations.AddPlaylistItemsResponse

Errors

Error Type	Status Code	Content Type
errors.SDKError	4XX, 5XX	*/*

delete_playlist_item

Deletes an item from a playlist. Only works with dumb playlists.

Example Usage

from plex_api_client import PlexAPI
from plex_api_client.models import components


with PlexAPI(
    accepts=components.Accepts.APPLICATION_XML,
    client_identifier="abc123",
    product="Plex for Roku",
    version="2.4.1",
    platform="Roku",
    platform_version="4.3 build 1057",
    device="Roku 3",
    model="4200X",
    device_vendor="Roku",
    device_name="Living Room TV",
    marketplace="googlePlay",
    token="<YOUR_API_KEY_HERE>",
) as plex_api:

    res = plex_api.library_playlists.delete_playlist_item(request={
        "playlist_id": 981646,
        "generator_id": 194010,
    })

    assert res.media_container_with_playlist_metadata is not None

    # Handle response
    print(res.media_container_with_playlist_metadata)

Parameters

Parameter	Type	Required	Description
request	operations.DeletePlaylistItemRequest	✔️	The request object to use for the request.
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

operations.DeletePlaylistItemResponse

Errors

Error Type	Status Code	Content Type
errors.SDKError	4XX, 5XX	*/*

get_playlist_generator

Get a playlist's generator. Only used for optimized versions

Example Usage

from plex_api_client import PlexAPI
from plex_api_client.models import components


with PlexAPI(
    accepts=components.Accepts.APPLICATION_XML,
    client_identifier="abc123",
    product="Plex for Roku",
    version="2.4.1",
    platform="Roku",
    platform_version="4.3 build 1057",
    device="Roku 3",
    model="4200X",
    device_vendor="Roku",
    device_name="Living Room TV",
    marketplace="googlePlay",
    token="<YOUR_API_KEY_HERE>",
) as plex_api:

    res = plex_api.library_playlists.get_playlist_generator(request={
        "playlist_id": 744880,
        "generator_id": 322168,
    })

    assert res.object is not None

    # Handle response
    print(res.object)

Parameters

Parameter	Type	Required	Description
request	operations.GetPlaylistGeneratorRequest	✔️	The request object to use for the request.
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

operations.GetPlaylistGeneratorResponse

Errors

Error Type	Status Code	Content Type
errors.SDKError	4XX, 5XX	*/*

modify_playlist_generator

Modify a playlist generator. Only used for optimizer

Example Usage

from plex_api_client import PlexAPI
from plex_api_client.models import components, operations


with PlexAPI(
    accepts=components.Accepts.APPLICATION_XML,
    client_identifier="abc123",
    product="Plex for Roku",
    version="2.4.1",
    platform="Roku",
    platform_version="4.3 build 1057",
    device="Roku 3",
    model="4200X",
    device_vendor="Roku",
    device_name="Living Room TV",
    marketplace="googlePlay",
    token="<YOUR_API_KEY_HERE>",
) as plex_api:

    res = plex_api.library_playlists.modify_playlist_generator(request={
        "playlist_id": 972007,
        "generator_id": 208334,
        "item": {
            "location": {
                "uri": "library://82503060-0d68-4603-b594-8b071d54819e/item/%2Flibrary%2Fmetadata%2F146",
            },
            "location_id": -1,
            "policy": {
                "scope": operations.QueryParamScope.ALL,
                "unwatched": components.BoolInt.ZERO,
            },
            "target": "",
            "target_tag_id": 1,
            "title": "Jack-Jack Attack",
            "type": 42,
        },
    })

    assert res.media_container_with_playlist_metadata is not None

    # Handle response
    print(res.media_container_with_playlist_metadata)

Parameters

Parameter	Type	Required	Description
request	operations.ModifyPlaylistGeneratorRequest	✔️	The request object to use for the request.
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

operations.ModifyPlaylistGeneratorResponse

Errors

Error Type	Status Code	Content Type
errors.SDKError	4XX, 5XX	*/*

get_playlist_generator_items

Get a playlist generator's items

Example Usage

from plex_api_client import PlexAPI
from plex_api_client.models import components


with PlexAPI(
    accepts=components.Accepts.APPLICATION_XML,
    client_identifier="abc123",
    product="Plex for Roku",
    version="2.4.1",
    platform="Roku",
    platform_version="4.3 build 1057",
    device="Roku 3",
    model="4200X",
    device_vendor="Roku",
    device_name="Living Room TV",
    marketplace="googlePlay",
    token="<YOUR_API_KEY_HERE>",
) as plex_api:

    res = plex_api.library_playlists.get_playlist_generator_items(request={
        "playlist_id": 77230,
        "generator_id": 979714,
    })

    assert res.object is not None

    # Handle response
    print(res.object)

Parameters

Parameter	Type	Required	Description
request	operations.GetPlaylistGeneratorItemsRequest	✔️	The request object to use for the request.
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

operations.GetPlaylistGeneratorItemsResponse

Errors

Error Type	Status Code	Content Type
errors.SDKError	4XX, 5XX	*/*

move_playlist_item

Moves an item in a playlist. Only works with dumb playlists.

Example Usage

from plex_api_client import PlexAPI
from plex_api_client.models import components


with PlexAPI(
    accepts=components.Accepts.APPLICATION_XML,
    client_identifier="abc123",
    product="Plex for Roku",
    version="2.4.1",
    platform="Roku",
    platform_version="4.3 build 1057",
    device="Roku 3",
    model="4200X",
    device_vendor="Roku",
    device_name="Living Room TV",
    marketplace="googlePlay",
    token="<YOUR_API_KEY_HERE>",
) as plex_api:

    res = plex_api.library_playlists.move_playlist_item(request={
        "playlist_id": 940298,
        "playlist_item_id": 375626,
    })

    assert res.media_container_with_playlist_metadata is not None

    # Handle response
    print(res.media_container_with_playlist_metadata)

Parameters

Parameter	Type	Required	Description
request	operations.MovePlaylistItemRequest	✔️	The request object to use for the request.
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

operations.MovePlaylistItemResponse

Errors

Error Type	Status Code	Content Type
errors.SDKError	4XX, 5XX	*/*

refresh_playlist

Make a generator reprocess (refresh)

Example Usage

from plex_api_client import PlexAPI
from plex_api_client.models import components, operations


with PlexAPI(
    accepts=components.Accepts.APPLICATION_XML,
    client_identifier="abc123",
    product="Plex for Roku",
    version="2.4.1",
    platform="Roku",
    platform_version="4.3 build 1057",
    device="Roku 3",
    model="4200X",
    device_vendor="Roku",
    device_name="Living Room TV",
    marketplace="googlePlay",
    token="<YOUR_API_KEY_HERE>",
) as plex_api:

    res = plex_api.library_playlists.refresh_playlist(request={
        "playlist_id": 895314,
        "generator_id": 629742,
        "metadata_id": 724422,
        "action": operations.Action.DISABLE,
    })

    assert res is not None

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
request	operations.RefreshPlaylistRequest	✔️	The request object to use for the request.
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

operations.RefreshPlaylistResponse

Errors

Error Type	Status Code	Content Type
errors.SDKError	4XX, 5XX	*/*