get_library_metadata_by_ids
Retrieve detailed metadata for one or more Plex library items by their IDs, with options to include extras, markers, chapters, reviews, and related content.
Instructions
Get a metadata item.
GET /library/metadata/{ids}
Args:
ids: Comma-separated list of IDs
async_check_files: Determines if file check should be performed asynchronously. An activity is created to indicate progress. Default is false.
async_refresh_local_media_agent: Determines if local media agent refresh should be performed asynchronously. An activity is created to indicate progress. Default is false.
async_refresh_analysis: Determines if analysis refresh should be performed asynchronously. An activity is created to indicate progress. Default is false.
check_files: Determines if file check should be performed synchronously. Specifying asyncCheckFiles will cause this option to be ignored. Default is false.
skip_refresh: Determines if synchronous local media agent and analysis refresh should be skipped. Specifying async versions will cause synchronous versions to be skipped. Default is false.
check_file_availability: Determines if file existence check should be performed synchronously. Specifying checkFiles will imply this option. Default is false.
async_augment_metadata: Add metadata augmentations. An activity is created to indicate progress. Option will be ignored if specified by non-admin or if multiple metadata items are requested. Default is false.
augment_count: Number of augmentations to add. Requires asyncAugmentMetadata to be specified.
include_markers: Include intro/credits markers in the response
include_guids: Include external GUIDs (e.g. TMDB, TVDB) in the response
include_chapters: Include chapter data in the response
include_external_media: Include external/online media in the response
include_extras: Include trailers, behind-the-scenes, and other extras
include_related: Include related items in the response
include_on_deck: Include On Deck status in the response
include_popular_leaves: Include popular episodes in the response
include_reviews: Include user reviews in the response
include_stations: Include radio station data in the response
exclude_elements: Comma-separated list of elements to exclude from the response
exclude_fields: Comma-separated list of fields to exclude from the response
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ids | Yes | ||
| check_files | No | ||
| skip_refresh | No | ||
| augment_count | No | ||
| include_guids | No | ||
| exclude_fields | No | ||
| include_extras | No | ||
| include_markers | No | ||
| include_on_deck | No | ||
| include_related | No | ||
| include_reviews | No | ||
| exclude_elements | No | ||
| include_chapters | No | ||
| include_stations | No | ||
| async_check_files | No | ||
| async_augment_metadata | No | ||
| async_refresh_analysis | No | ||
| include_external_media | No | ||
| include_popular_leaves | No | ||
| check_file_availability | No | ||
| async_refresh_local_media_agent | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |