--- id: create-playlist sidebar_label: Create a Playlist hide_title: true hide_table_of_contents: true api: {"tags":["Playlists"],"description":"Create a new playlist. By default the playlist is blank. To create a playlist along with a first item, pass:\n- `uri` - The content URI for what we're playing (e.g. `library://...`).\n- `playQueueID` - To create a playlist from an existing play queue.\n","operationId":"createPlaylist","parameters":[{"name":"title","description":"name of the playlist","in":"query","schema":{"type":"string"},"required":true},{"name":"type","description":"type of playlist to create","in":"query","schema":{"type":"string","enum":["audio","video","photo"]},"required":true},{"name":"smart","description":"whether the playlist is smart or not","in":"query","schema":{"type":"number","enum":[0,1]},"required":true},{"name":"uri","description":"the content URI for the playlist","in":"query","schema":{"type":"string"},"required":false},{"name":"playQueueID","description":"the play queue to copy to a playlist","in":"query","schema":{"type":"number"},"required":false}],"responses":{"200":{"description":"returns all playlists"},"401":{"description":"Unauthorized - Returned if the X-Plex-Token is missing from the header or query.","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"number","example":1001},"message":{"type":"string","example":"User could not be authenticated"},"status":{"type":"number","example":401}}}}}}}}}},"method":"post","path":"/playlists","servers":[{"url":"http://{Local IP}:{Port}","variables":{"Local IP":{"default":"10.10.10.47","description":"The Local IP Address of your plex server"},"Port":{"default":"32400","description":"The port to access your plex server"}}},{"url":"https://{Local IP}:{Port}","variables":{"Local IP":{"default":"10.10.10.47","description":"The Local IP Address of your plex server"},"Port":{"default":"32400","description":"The port to access your plex server"}}}],"security":[{"Token":[],"ClientIdentifier":[],"Device":[],"DeviceName":[],"Platform":[],"PlatformVersion":[],"Product":[],"Version":[]}],"securitySchemes":{"Token":{"description":"Plex Authentication Token","type":"apiKey","in":"header","name":"X-Plex-Token"},"ClientIdentifier":{"description":"Plex Authentication Token","type":"apiKey","in":"header","name":"X-Plex-Client-Identifier"},"DeviceName":{"description":"Primary name for the device eg. `Plex Web (Chrome)`","type":"apiKey","in":"header","name":"X-Plex-Device-Name"},"Device":{"description":"The type of device your application is running on\nDevice name and or model number, eg `iPhone3,2`, `Motorola XOOM™`, `LG5200TV`\n","type":"apiKey","in":"header","name":"X-Plex-Device"},"PlatformVersion":{"description":"Operating system version\neg `4.3.1`, `10.6.7`, `3.2`\n","type":"apiKey","in":"header","name":"X-Plex-Platform-Version"},"Platform":{"description":"Platform name \neg: `Web`, `iOS`, `MacOSX`, `Android`, `LG`\n","type":"apiKey","in":"header","name":"X-Plex-Platform"},"Product":{"description":"Plex application name \neg: `Laika`, `Plex Media Server`, `Media Link`\n","type":"apiKey","in":"header","name":"X-Plex-Product"},"Version":{"description":"Plex application version number","type":"apiKey","in":"header","name":"X-Plex-Version"}},"info":{"title":"Plex-API","summary":"A Plex Media Server API Map","description":"An Open API Spec for interacting with Plex.tv and Plex Servers","version":"0.0.3","contact":{"name":"Luke Hagar","url":"https://www.LukeHagar.com","email":"Lukeslakemail@gmail.com"},"license":{"name":"MIT","identifier":"MIT","url":"https://opensource.org/licenses/MIT"}},"postman":{"name":"Create a Playlist","description":{"content":"Create a new playlist. By default the playlist is blank. To create a playlist along with a first item, pass:\n- `uri` - The content URI for what we're playing (e.g. `library://...`).\n- `playQueueID` - To create a playlist from an existing play queue.\n","type":"text/plain"},"url":{"path":["playlists"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"(Required) name of the playlist","type":"text/plain"},"key":"title","value":""},{"disabled":false,"description":{"content":"(Required) type of playlist to create","type":"text/plain"},"key":"type","value":""},{"disabled":false,"description":{"content":"(Required) whether the playlist is smart or not","type":"text/plain"},"key":"smart","value":""},{"disabled":false,"description":{"content":"the content URI for the playlist","type":"text/plain"},"key":"uri","value":""},{"disabled":false,"description":{"content":"the play queue to copy to a playlist","type":"text/plain"},"key":"playQueueID","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"}} sidebar_class_name: "post api-method" info_path: docs/plex-media-server/plex-api --- import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; import TabItem from "@theme/TabItem";

Create a Playlist

Create a new playlist. By default the playlist is blank. To create a playlist along with a first item, pass: - `uri` - The content URI for what we're playing (e.g. `library://...`). - `playQueueID` - To create a playlist from an existing play queue.
Query Parameters
returns all playlists
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
Schema
    errors object[]
  • Array [
  • ]