Skip to main content
POST
/
playQueues
PlexGO
package main

import(
	"context"
	"github.com/LukeHagar/plexgo/models/components"
	"github.com/LukeHagar/plexgo"
	"github.com/LukeHagar/plexgo/models/operations"
	"log"
)

func main() {
    ctx := context.Background()

    s := plexgo.New(
        plexgo.WithAccepts(components.AcceptsApplicationXML),
        plexgo.WithClientIdentifier("abc123"),
        plexgo.WithProduct("Plex for Roku"),
        plexgo.WithVersion("2.4.1"),
        plexgo.WithPlatform("Roku"),
        plexgo.WithPlatformVersion("4.3 build 1057"),
        plexgo.WithDevice("Roku 3"),
        plexgo.WithModel("4200X"),
        plexgo.WithDeviceVendor("Roku"),
        plexgo.WithDeviceName("Living Room TV"),
        plexgo.WithMarketplace("googlePlay"),
        plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
    )

    res, err := s.PlayQueue.CreatePlayQueue(ctx, operations.CreatePlayQueueRequest{
        Type: operations.TypeAudio,
        Shuffle: components.BoolIntOne.ToPointer(),
        Repeat: components.BoolIntOne.ToPointer(),
        Continuous: components.BoolIntOne.ToPointer(),
        Recursive: components.BoolIntOne.ToPointer(),
        OnDeck: components.BoolIntOne.ToPointer(),
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}
{
  "MediaContainer": {
    "identifier": "<string>",
    "offset": 123,
    "size": 123,
    "totalSize": 123,
    "playQueueID": 123,
    "playQueueLastAddedItemID": "<string>",
    "playQueueSelectedItemID": 123,
    "playQueueSelectedItemOffset": 123,
    "playQueueSelectedMetadataItemID": 123,
    "playQueueShuffled": true,
    "playQueueSourceURI": "<string>",
    "playQueueTotalCount": 123,
    "playQueueVersion": 123
  }
}

Authorizations

​
X-Plex-Token
string
header
required

The token which identifies the user accessing the PMS. This can be either:

  • A traditional access token obtained from plex.tv
  • A JWT token obtained through the JWT authentication flow

JWT tokens provide better security with:

  • Short-lived tokens (7 days expiration)
  • Public-key cryptography (ED25519)
  • Better clock synchronization
  • Individual device revocation capability

Headers

​
accepts
enum<string>
default:application/xml

Indicates the client accepts the indicated media types

Available options:
application/json,
application/xml
​
X-Plex-Client-Identifier
string
required

An opaque identifier unique to the client

Example:

"abc123"

​
X-Plex-Product
string

The name of the client product

Example:

"Plex for Roku"

​
X-Plex-Version
string

The version of the client application

Example:

"2.4.1"

​
X-Plex-Platform
string

The platform of the client

Example:

"Roku"

​
X-Plex-Platform-Version
string

The version of the platform

Example:

"4.3 build 1057"

​
X-Plex-Device
string

A relatively friendly name for the client device

Example:

"Roku 3"

​
X-Plex-Model
string

A potentially less friendly identifier for the device model

Example:

"4200X"

​
X-Plex-Device-Vendor
string

The device vendor

Example:

"Roku"

​
X-Plex-Device-Name
string

A friendly name for the client

Example:

"Living Room TV"

​
X-Plex-Marketplace
string

The marketplace on which the client application is distributed

Example:

"googlePlay"

Query Parameters

​
uri
string

The content URI for what we're playing.

​
playlistID
integer

the ID of the playlist we're playing.

​
type
enum<string>
required

The type of play queue to create

Available options:
audio,
video,
photo
​
key
string

The key of the first item to play, defaults to the first in the play queue.

​
shuffle
enum<integer>

Whether to shuffle the playlist, defaults to 0.

Available options:
0,
1
​
repeat
enum<integer>

If the PQ is bigger than the window, fill any empty space with wraparound items, defaults to 0.

Available options:
0,
1
​
continuous
enum<integer>

Whether to create a continuous play queue (e.g. from an episode), defaults to 0.

Available options:
0,
1
​
extrasPrefixCount
integer

Number of trailers to prepend a movie with not including the pre-roll. If omitted the pre-roll will not be returned in the play queue. When resuming a movie extrasPrefixCount should be omitted as a parameter instead of passing 0.

​
recursive
enum<integer>

Only applies to queues of type photo, whether to retrieve all descendent photos from an album or section, defaults to 1.

Available options:
0,
1
​
onDeck
enum<integer>

Only applies to queues of type show or seasons, whether to return a queue that is started on the On Deck episode if one exists. Otherwise begins the play queue on the beginning of the show or season.

Available options:
0,
1

Response

OK

​
MediaContainer
object

MediaContainer is the root element of most Plex API responses. It serves as a generic container for various types of content (Metadata, Hubs, Directories, etc.) and includes pagination information (offset, size, totalSize) when applicable. Common attributes: - identifier: Unique identifier for this container - size: Number of items in this response page - totalSize: Total number of items available (for pagination) - offset: Starting index of this page (for pagination) The container often "hoists" common attributes from its children. For example, if all tracks in a container share the same album title, the parentTitle attribute may appear on the MediaContainer rather than being repeated on each track.