Plex-API: An Open API Spec for interacting with Plex.tv and Plex Media Server

An Open Source OpenAPI Specification for Plex Media Server

Automation and SDKs provided by Speakeasy

API Documentation

The following SDKs are generated from the OpenAPI Specification. They are automatically generated and may not be fully tested. If you find any issues, please open an issue on the main specification Repository.

• SDK Installation
• SDK Example Usage
• Available Resources and Operations
• Server Selection

The SDK can be installed using RubyGems:

gem install plex_ruby_sdk

require 'plex_ruby_sdk'


s = ::PlexRubySDK::PlexAPI.new(
      client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
      client_name: "Plex for Roku",
      client_version: "2.4.1",
      platform: "Roku",
      device_nickname: "Roku 3",
    )
s.config_security(
  ::PlexRubySDK::Shared::Security.new(
    access_token: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.server.get_server_capabilities()

if ! res.object.nil?
  # handle response
end

• get_server_activities - Get Server Activities
• cancel_server_activities - Cancel Server Activities

• get_transient_token - Get a Transient Token
• get_source_connection_information - Get Source Connection Information
• get_token_details - Get Token Details
• post_users_sign_in_data - Get User Sign In Data

• get_butler_tasks - Get Butler tasks
• start_all_tasks - Start all Butler tasks
• stop_all_tasks - Stop all Butler tasks
• start_task - Start a single Butler task
• stop_task - Stop a single Butler task

• get_global_hubs - Get Global Hubs
• get_recently_added - Get Recently Added
• get_library_hubs - Get library specific hubs

• get_file_hash - Get Hash Value
• get_recently_added_library - Get Recently Added
• get_all_libraries - Get All Libraries
• get_library_details - Get Library Details
• delete_library - Delete Library Section
• get_library_items - Get Library Items
• get_refresh_library_metadata - Refresh Metadata Of The Library
• get_search_library - Search Library
• get_search_all_libraries - Search All Libraries
• get_meta_data_by_rating_key - Get Metadata by RatingKey
• get_metadata_children - Get Items Children
• get_top_watched_content - Get Top Watched Content
• get_on_deck - Get On Deck

• log_line - Logging a single line message.
• log_multi_line - Logging a multi-line message
• enable_paper_trail - Enabling Papertrail

• mark_played - Mark Media Played
• mark_unplayed - Mark Media Unplayed
• update_play_progress - Update Media Play Progress
• get_banner_image - Get Banner Image
• get_thumb_image - Get Thumb Image

• create_playlist - Create a Playlist
• get_playlists - Get All Playlists
• get_playlist - Retrieve Playlist
• delete_playlist - Deletes a Playlist
• update_playlist - Update a Playlist
• get_playlist_contents - Retrieve Playlist Contents
• clear_playlist_contents - Delete Playlist Contents
• add_playlist_contents - Adding to a Playlist
• upload_playlist - Upload Playlist

• get_companions_data - Get Companions Data
• get_user_friends - Get list of friends of the user logged in
• get_geo_data - Get Geo Data
• get_home_data - Get Plex Home Data
• get_server_resources - Get Server Resources
• get_pin - Get a Pin
• get_token_by_pin_id - Get Access Token by PinId

• perform_search - Perform a search
• perform_voice_search - Perform a voice search
• get_search_results - Get Search Results

• get_server_capabilities - Get Server Capabilities
• get_server_preferences - Get Server Preferences
• get_available_clients - Get Available Clients
• get_devices - Get Devices
• get_server_identity - Get Server Identity
• get_my_plex_account - Get MyPlex Account
• get_resized_photo - Get a Resized Photo
• get_media_providers - Get Media Providers
• get_server_list - Get Server List

• get_sessions - Get Active Sessions
• get_session_history - Get Session History
• get_transcode_sessions - Get Transcode Sessions
• stop_transcode_session - Stop a Transcode Session

• get_statistics - Get Media Statistics
• get_resources_statistics - Get Resources Statistics
• get_bandwidth_statistics - Get Bandwidth Statistics

• get_update_status - Querying status of updates
• check_for_updates - Checking for updates
• apply_updates - Apply Updates

• get_timeline - Get the timeline for a media item
• start_universal_transcode - Start Universal Transcode

• get_watch_list - Get User Watchlist

The default server {protocol}://{ip}:{port} contains variables and is set to https://10.10.10.47:32400 by default. To override default values, the following parameters are available when initializing the SDK client instance:

• protocol (::PlexRubySDK::ServerVariables::ServerProtocol)
• ip (::String)
• port (::String)

The default server can also be overridden globally by passing a URL to the server_url (String) optional parameter when initializing the SDK client instance. For example:

require 'plex_ruby_sdk'


s = ::PlexRubySDK::PlexAPI.new(
      server_url: "https://10.10.10.47:32400",
      client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
      client_name: "Plex for Roku",
      client_version: "2.4.1",
      platform: "Roku",
      device_nickname: "Roku 3",
    )
s.config_security(
  ::PlexRubySDK::Shared::Security.new(
    access_token: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.server.get_server_capabilities()

if ! res.object.nil?
  # handle response
end

The server URL can also be overridden on a per-operation basis, provided a server list was specified for the operation. For example:

require 'plex_ruby_sdk'


s = ::PlexRubySDK::PlexAPI.new(
      client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
      client_name: "Plex for Roku",
      client_version: "2.4.1",
      platform: "Roku",
      device_nickname: "Roku 3",
    )
s.config_security(
  ::PlexRubySDK::Shared::Security.new(
    access_token: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.plex.get_companions_data(server_url: "https://plex.tv/api/v2")

if ! res.response_bodies.nil?
  # handle response
end

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

While we value open-source contributions to this SDK, this library is generated programmatically. Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!