Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
110 changes: 108 additions & 2 deletions plex-api-spec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -48735,10 +48735,22 @@ paths:
type: string
put:
operationId: addPlaylistItems
summary: Adding to a Playlist
summary: Add Items or an Optimization Job to a Playlist
tags:
- Library Playlists
description: 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.
description: |-
Adds items or a generator to a playlist. With a dumb playlist, this adds the specified items.
With a smart playlist, passing a new `uri` replaces the rules.

To create an optimized media version, first retrieve the background-processing playlist
with `GET /playlists?type=42`, then add an item to that playlist with `Item[type]=42`,
an `Item[Location][uri]` that identifies the media, and one of these target configurations:

- A built-in profile specified by `Item[targetTagID]`.
- A custom target specified by `Item[target]`, `Item[Device][profile]`, and
`Item[MediaSettings][videoQuality]` together. The remaining media settings describe
the custom target. Original quality uses empty strings for video quality, resolution,
and maximum bitrate.
parameters:
- $ref: "#/components/parameters/accepts"
- $ref: "#/components/parameters/X-Plex-Client-Identifier"
Expand Down Expand Up @@ -48767,6 +48779,100 @@ paths:
in: query
schema:
type: integer
- name: Item[type]
description: Item type. Use 42 to create an optimized-version job.
in: query
schema:
type: integer
enum:
- 42
x-speakeasy-name-override: itemType
- name: Item[title]
description: Display title for the optimization job.
in: query
schema:
type: string
x-speakeasy-name-override: itemTitle
- name: Item[target]
description: Custom optimization target name. Required with Item[Device][profile] and Item[MediaSettings][videoQuality] when Item[targetTagID] is not used.
in: query
schema:
type: string
x-speakeasy-name-override: itemTarget
- name: Item[targetTagID]
description: ID of a built-in media-processing target such as Optimized for Mobile. Use this instead of the custom-target parameters.
in: query
schema:
type: integer
x-speakeasy-name-override: itemTargetTagId
- name: Item[locationID]
description: Destination library location ID. Use -1 to store the optimized version with the original media.
in: query
schema:
type: integer
minimum: -1
x-speakeasy-name-override: itemLocationId
- name: Item[Location][uri]
description: Plex library URI identifying the media to optimize.
in: query
schema:
type: string
x-speakeasy-name-override: itemLocationUri
Comment thread
greptile-apps[bot] marked this conversation as resolved.
- name: Item[Policy][scope]
description: Optimization policy scope. The only valid values are all and count.
in: query
schema:
type: string
enum:
- all
- count
Comment thread
coderabbitai[bot] marked this conversation as resolved.
x-speakeasy-name-override: itemPolicyScope
- name: Item[Policy][value]
description: Maximum item count when the policy scope is count.
in: query
schema:
type: integer
minimum: 0
x-speakeasy-name-override: itemPolicyValue
- name: Item[Policy][unwatched]
description: Whether to optimize only unwatched items.
in: query
schema:
$ref: "#/components/schemas/BoolInt"
x-speakeasy-name-override: itemPolicyUnwatched
- name: Item[Device][profile]
description: Client device profile used for a custom optimization target. Required with Item[target] and Item[MediaSettings][videoQuality].
in: query
schema:
type: string
x-speakeasy-name-override: itemDeviceProfile
- name: Item[MediaSettings][videoQuality]
description: Video quality index for a custom optimization target, or an empty string for original quality. Required with Item[target] and Item[Device][profile].
in: query
schema:
oneOf:
- type: integer
- type: string
enum:
- ''
x-speakeasy-name-override: itemVideoQuality
- name: Item[MediaSettings][videoResolution]
Comment thread
coderabbitai[bot] marked this conversation as resolved.
description: Maximum video resolution for a custom optimization target.
in: query
schema:
type: string
x-speakeasy-name-override: itemVideoResolution
- name: Item[MediaSettings][maxVideoBitrate]
description: Maximum video bitrate in kbps for a custom optimization target, or an empty string for original quality.
in: query
schema:
oneOf:
- type: integer
minimum: 0
- type: string
enum:
- ''
x-speakeasy-name-override: itemMaxVideoBitrate
responses:
'200':
$ref: "#/components/responses/slash-post-responses-200"
Expand Down
Loading