Skip to main content
GET
/
downloadQueue
/
{queueId}
/
item
/
{itemId}
/
decision
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.DownloadQueue.GetItemDecision(ctx, operations.GetItemDecisionRequest{
        QueueID: 231605,
        ItemID: 32,
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.MediaContainerWithDecision != nil {
        // handle response
    }
}
{
  "MediaContainer": {
    "identifier": "<string>",
    "offset": 123,
    "size": 123,
    "totalSize": 123,
    "availableBandwidth": 123,
    "directPlayDecisionCode": 123,
    "directPlayDecisionText": "<string>",
    "generalDecisionCode": 123,
    "generalDecisionText": "<string>",
    "mdeDecisionCode": 123,
    "mdeDecisionText": "<string>",
    "Metadata": [
      {
        "title": "<any>",
        "type": "<any>",
        "absoluteIndex": 123,
        "addedAt": 123,
        "art": "<any>",
        "audienceRating": 5,
        "audienceRatingImage": "<any>",
        "Autotag": [
          {
            "confidence": 123,
            "context": "<string>",
            "filter": "<any>",
            "id": 123,
            "ratingKey": "<string>",
            "role": "<any>",
            "tag": "<any>",
            "tagKey": "<any>",
            "tagType": 123,
            "thumb": "<any>"
          }
        ],
        "banner": "<any>",
        "chapterSource": "<any>",
        "composite": "<any>",
        "contentRating": "<any>",
        "Country": [
          {
            "confidence": 123,
            "context": "<string>",
            "filter": "<any>",
            "id": 123,
            "ratingKey": "<string>",
            "role": "<any>",
            "tag": "<any>",
            "tagKey": "<any>",
            "tagType": 123,
            "thumb": "<any>"
          }
        ],
        "Director": [
          {
            "confidence": 123,
            "context": "<string>",
            "filter": "<any>",
            "id": 123,
            "ratingKey": "<string>",
            "role": "<any>",
            "tag": "<any>",
            "tagKey": "<any>",
            "tagType": 123,
            "thumb": "<any>"
          }
        ],
        "duration": 123,
        "Filter": [
          {
            "title": "<string>",
            "type": "<string>",
            "art": "<string>",
            "content": true,
            "filter": "<string>",
            "hasPrefs": true,
            "hasStoreServices": true,
            "hubKey": "<string>",
            "identifier": "<string>",
            "key": "<string>",
            "lastAccessedAt": 123,
            "Pivot": [
              "<any>"
            ],
            "share": 123,
            "thumb": "<string>",
            "titleBar": "<string>",
            "filterType": "<string>"
          }
        ],
        "Genre": [
          {
            "confidence": 123,
            "context": "<string>",
            "filter": "<any>",
            "id": 123,
            "ratingKey": "<string>",
            "role": "<any>",
            "tag": "<any>",
            "tagKey": "<any>",
            "tagType": 123,
            "thumb": "<any>"
          }
        ],
        "grandparentArt": "<string>",
        "grandparentHero": "<string>",
        "grandparentKey": "<string>",
        "grandparentRatingKey": "<string>",
        "grandparentTheme": "<string>",
        "grandparentThumb": "<string>",
        "grandparentTitle": "<string>",
        "Guid": [
          {
            "confidence": 123,
            "context": "<string>",
            "filter": "<any>",
            "id": 123,
            "ratingKey": "<string>",
            "role": "<any>",
            "tag": "<any>",
            "tagKey": "<any>",
            "tagType": 123,
            "thumb": "<any>"
          }
        ],
        "hero": "<any>",
        "Image": [
          {
            "type": "background",
            "alt": "<string>",
            "url": "<string>"
          }
        ],
        "index": 123,
        "key": "<any>",
        "lastViewedAt": 123,
        "leafCount": 123,
        "Media": [
          {
            "aspectRatio": 2.35,
            "audioChannels": 2,
            "audioCodec": "<any>",
            "audioProfile": "<any>",
            "bitrate": 5612,
            "container": "<any>",
            "duration": 150192,
            "has64bitOffsets": false,
            "hasVoiceActivity": true,
            "height": 544,
            "id": 1,
            "optimizedForStreaming": false,
            "Part": [
              {}
            ],
            "videoCodec": "<any>",
            "videoFrameRate": "<any>",
            "videoProfile": "<any>",
            "videoResolution": "<any>",
            "width": 1280,
            "abr": true,
            "resourceSession": "<string>",
            "selected": true
          }
        ],
        "originallyAvailableAt": "<any>",
        "originalTitle": "<any>",
        "parentHero": "<string>",
        "parentIndex": 123,
        "parentKey": "<string>",
        "parentRatingKey": "<string>",
        "parentThumb": "<string>",
        "parentTitle": "<string>",
        "primaryExtraKey": "<any>",
        "prompt": "<string>",
        "rating": 5,
        "Rating": [
          {
            "confidence": 123,
            "context": "<string>",
            "filter": "<any>",
            "id": 123,
            "ratingKey": "<string>",
            "role": "<any>",
            "tag": "<any>",
            "tagKey": "<any>",
            "tagType": 123,
            "thumb": "<any>"
          }
        ],
        "ratingCount": 123,
        "ratingImage": "<any>",
        "ratingKey": "<any>",
        "Role": [
          {
            "confidence": 123,
            "context": "<string>",
            "filter": "<any>",
            "id": 123,
            "ratingKey": "<string>",
            "role": "<any>",
            "tag": "<any>",
            "tagKey": "<any>",
            "tagType": 123,
            "thumb": "<any>"
          }
        ],
        "search": true,
        "secondary": true,
        "skipChildren": true,
        "skipParent": true,
        "Sort": [
          {
            "title": "<string>",
            "type": "<string>",
            "art": "<string>",
            "content": true,
            "filter": "<string>",
            "hasPrefs": true,
            "hasStoreServices": true,
            "hubKey": "<string>",
            "identifier": "<string>",
            "key": "<string>",
            "lastAccessedAt": 123,
            "Pivot": [
              "<any>"
            ],
            "share": 123,
            "thumb": "<string>",
            "titleBar": "<string>",
            "default": "asc",
            "defaultDirection": "asc",
            "descKey": "<string>",
            "firstCharacterKey": "<string>"
          }
        ],
        "studio": "<any>",
        "subtype": "<any>",
        "summary": "<any>",
        "tagline": "<any>",
        "theme": "<any>",
        "thumb": "<any>",
        "titleSort": "<any>",
        "updatedAt": 123,
        "userRating": 5,
        "viewCount": 123,
        "viewedLeafCount": 123,
        "viewOffset": 123,
        "Writer": [
          {
            "confidence": 123,
            "context": "<string>",
            "filter": "<any>",
            "id": 123,
            "ratingKey": "<string>",
            "role": "<any>",
            "tag": "<any>",
            "tagKey": "<any>",
            "tagType": 123,
            "thumb": "<any>"
          }
        ],
        "year": 123
      }
    ],
    "transcodeDecisionCode": 123,
    "transcodeDecisionText": "<string>"
  }
}

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"

Path Parameters

​
queueId
integer
required

The queue id

​
itemId
integer
required

The item ids

Response

OK

MediaContainer is commonly found as the root of a response and is a pretty generic container. Common attributes include identifier and things related to paging (offset, size, totalSize).

It is also common for a MediaContainer to contain attributes "hoisted" from its children. If every element in the container would have had the same attribute, then that attribute can be present on the container instead of being repeated on every element. For example, an album's list of tracks might include parentTitle on the container since all of the tracks have the same album title. A container may have a source attribute when all of the items came from the same source. Generally speaking, when looking for an attribute on an item, if the attribute wasn't found then the container should be checked for that attribute as well.

​
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.