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.

• plexruby
• Plex Media Server OpenAPI Specification
  • Documentation
  • SDKs
  • SDK Installation
  • SDK Example Usage
  • Authentication
  • Available Resources and Operations
  • Error Handling
  • Server Selection
• Development
  • Maturity
  • Contributions

The SDK can be installed using RubyGems:

gem install plex_ruby_sdk

require 'plex_ruby_sdk'

s = ::PlexRubySDK::PlexAPI.new(
      security: Models::Shared::Security.new(
        access_token: "<YOUR_API_KEY_HERE>",
      ),
    )

res = s.server.get_server_capabilities()

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

This SDK supports the following security scheme globally:

You can set the security parameters through the security optional parameter when initializing the SDK client instance. For example:

require 'plex_ruby_sdk'

s = ::PlexRubySDK::PlexAPI.new(
      security: Models::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_library_sections_all - Get Library section media by tag ALL
• get_refresh_library_metadata - Refresh Metadata Of The Library
• get_search_library - Search Library
• get_genres_library - Get Genres of library media
• get_countries_library - Get Countries of library media
• get_actors_library - Get Actors of library media
• get_search_all_libraries - Search All Libraries
• get_media_meta_data - Get Media Metadata
• get_media_arts - Get Media Background Artwork
• post_media_arts - Upload Media Background Artwork
• get_media_posters - Get Media Posters
• post_media_poster - Upload Media Poster
• get_metadata_children - Get Items Children
• get_top_watched_content - Get Top Watched Content

• 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_users - Get list of all connected users

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

• get_watch_list - Get User Watchlist

Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an error.

By default an API error will raise a Errors::APIError, which has the following properties:

When custom error responses are specified for an operation, the SDK may also throw their associated exception. You can refer to respective Errors tables in SDK docs for more details on possible exception types for each operation. For example, the get_server_capabilities method throws the following exceptions:

require 'plex_ruby_sdk'

s = ::PlexRubySDK::PlexAPI.new(
      security: Models::Shared::Security.new(
        access_token: '<YOUR_API_KEY_HERE>',
      ),
    )

begin
    res = s.server.get_server_capabilities()

    if ! res.object.nil?
      # handle response
    end
rescue Models::Errors::GetServerCapabilitiesBadRequest => e
  # handle $e->$container data
  throw $e;
rescue Models::Errors::GetServerCapabilitiesUnauthorized => e
  # handle $e->$container data
  throw $e;
rescue Errors::APIError => e
  # handle default exception
  raise e
end

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:

require 'plex_ruby_sdk'

s = ::PlexRubySDK::PlexAPI.new(
      protocol: "https",
      ip: "e0c3:bcc0:6bac:dccc:c4ec:34b1:ca98:4cb9",
      port: "40311",
      security: Models::Shared::Security.new(
        access_token: "<YOUR_API_KEY_HERE>",
      ),
    )

res = s.server.get_server_capabilities()

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

The default server can 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",
      security: Models::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(
      security: Models::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!