The ID associated with a movie library. This key can be found by calling the Get All Movies API command and using the value from the ratingKey attribute for the movie.
Return Status
HTTP Code
Description
200
Success - The request was successful.
401
Unauthorized - The Plex token provided was not valid.
404
Not Found - The movie associated with the ID does not exist.
Response
XML string value that all the metadata for a movie. An example of the XML returned from the request is shown below:
The response contains all the metadata for the movie. The root is the MediaContainer element. This element contains a few attributes that provide overall information about the movie from the server.
Media tag version. Note: This could be a date and time value.
Within the MediaContainer there is one Video child element that represents the movie.
Video Attributes
Attribute
Description
ratingKey
A key associated with the movie.
key
The relative URL of the movie information.
guid
The unique identifier comprised of the Plex agent and movie identifier for the agent.
slug
The short path name for the movie.
studio
The name of the movie studio.
type
The type of media.
title
The title of the movie.
librarySectionTitle
The name of the library section where the movie is located.
librarySectionID
The ID of the library section.
librarySectionKey
The relative URL of the library section.
contentRating
The content rating associated with the movie.
summary
A summary of the movie.
rating
The rating for the movie.
audienceRating
The audience rating for the movie.
skipCount
The skip count.
year
The year the movie was released.
tagline
The tagline associated with the movie.
thumb
The thumbnail for the movie.
art
The background artwork used to represent the movie.
duration
The length of the movie in milliseconds.
originallyAvailableAt
The original release date of the movie.
addedAt
The date and time, in Unix time, the movie was added to the library.
updatedAt
The date and time in epoch time, the movie was updated in the library.
audienceRatingImage
The image associated with the audience rating.
chapterSource
The chapter source type.
primaryExtraKey
The extra key value.
ratingImage
The image associated with the rating.
Within the Video there are one or more Media child elements. Each Media element represents one media file of the movie available on the Plex server.
If there are two media files associated with the movie, such as a 1080p and 480p version, then there would be two Media child elements in the Video element.
Media Attributes
Attribute
Description
id
Unique ID associated with the item.
duration
The length of the item in milliseconds.
bitrate
The bitrate of the item.
width
The width of the item.
height
The height of the item.
aspectRatio
The aspect ratio of the item.
audioChannels
The number of audio channels.
audioCodec
The audio codec used to encode the audio.
videoCodec
The video codec used to encode the video.
videoResolution
The video resolution.
container
The item container.
videoFrameRate
The framerate standard used for the video.
videoProfile
The video profile of the media.
Within the Media there are one or more Part child elements. Each Part element represents one part of the movie. If the movie has been added to the Plex server as a multi-part movie, then each of those parts will be represented by one Part child element.
Part Attributes
Attribute
Description
id
Unique ID associated with the part.
key
The unique relative path for the part that is used at its key.
duration
The length of the part in milliseconds.
file
The file associated with the part.
size
The file size of the part.
container
The type of media container.
videoProfile
The video profile associated with the video part.
Also within the Video element there are multiple additional child elements that provide more details about the movie. These child elements include Genre, Director, Writer, Country, Collection, and Role.
Within each of these child elements is a single tag attribute that provides the information for the element. There could be multiple of the same child element within the Video, such as multiple directors or writers.
Genre Attributes
Attribute
Description
tag
A genre of the movie.
Director Attributes
Attribute
Description
tag
A director of the movie.
Writer Attributes
Attribute
Description
tag
A writer for the movie
Country Attributes
Attribute
Description
tag
A country of origin for the movie.
Collection Attributes
Attribute
Description
tag
The name of a collection containing the movie.
Role Attributes
Attribute
Description
tag
The name of a person with a role in the movie.
Examples
curl -X GET http://{ip_address}:32400/library/metadata/{id}?X-Plex-Token={plex_token}