jellyfin.generated.api_10_11.LibraryApi

All URIs are relative to http://localhost

Method	HTTP request	Description
delete_item	DELETE /Items/{itemId}	Deletes an item from the library and filesystem.
delete_items	DELETE /Items	Deletes items from the library and filesystem.
get_ancestors	GET /Items/{itemId}/Ancestors	Gets all parents of an item.
get_critic_reviews	GET /Items/{itemId}/CriticReviews	Gets critic review for an item.
get_download	GET /Items/{itemId}/Download	Downloads item media.
get_file	GET /Items/{itemId}/File	Get the original file of an item.
get_item_counts	GET /Items/Counts	Get item counts.
get_library_options_info	GET /Libraries/AvailableOptions	Gets the library options info.
get_media_folders	GET /Library/MediaFolders	Gets all user media folders.
get_physical_paths	GET /Library/PhysicalPaths	Gets a list of physical paths from virtual folders.
get_similar_albums	GET /Albums/{itemId}/Similar	Gets similar items.
get_similar_artists	GET /Artists/{itemId}/Similar	Gets similar items.
get_similar_items	GET /Items/{itemId}/Similar	Gets similar items.
get_similar_movies	GET /Movies/{itemId}/Similar	Gets similar items.
get_similar_shows	GET /Shows/{itemId}/Similar	Gets similar items.
get_similar_trailers	GET /Trailers/{itemId}/Similar	Gets similar items.
get_theme_media	GET /Items/{itemId}/ThemeMedia	Get theme songs and videos for an item.
get_theme_songs	GET /Items/{itemId}/ThemeSongs	Get theme songs for an item.
get_theme_videos	GET /Items/{itemId}/ThemeVideos	Get theme videos for an item.
post_added_movies	POST /Library/Movies/Added	Reports that new movies have been added by an external source.
post_added_series	POST /Library/Series/Added	Reports that new episodes of a series have been added by an external source.
post_updated_media	POST /Library/Media/Updated	Reports that new movies have been added by an external source.
post_updated_movies	POST /Library/Movies/Updated	Reports that new movies have been added by an external source.
post_updated_series	POST /Library/Series/Updated	Reports that new episodes of a series have been added by an external source.
refresh_library	POST /Library/Refresh	Starts a library scan.

delete_item

delete_item(item_id)

Deletes an item from the library and filesystem.

Example

• Api Key Authentication (CustomAuthentication):

import jellyfin.generated.api_10_11
from jellyfin.generated.api_10_11 import ApiClient, Configuration
from jellyfin.generated.api_10_11.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = Configuration(
    host = "http://localhost"
)

# Configure API key authorization: CustomAuthentication
configuration.api_key['CustomAuthentication'] = f'Token="{os.getenv("API_KEY")}"'
configuration.api_key_prefix['CustomAuthentication'] = "MediaBrowser"


# Enter a context with an instance of the API client
with ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = jellyfin.generated.api_10_11.LibraryApi(api_client)
    item_id = 'item_id_example' # str | The item id.

    try:
        # Deletes an item from the library and filesystem.
        api_instance.delete_item(item_id)
    except Exception as e:
        print("Exception when calling LibraryApi->delete_item: %s\n" % e)

Parameters

Name	Type	Description	Notes
item_id	str	The item id.

Return type

void (empty response body)

Authorization

CustomAuthentication

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, application/json; profile="CamelCase", application/json; profile="PascalCase", text/html

HTTP response details

Status code	Description	Response headers
204	Item deleted.	-
401	Unauthorized access.	-
404	Item not found.	-
503	The server is currently starting or is temporarily not available.	* Retry-After - A hint for when to retry the operation in full seconds. * Message - A short plain-text reason why the server is not available.
403	Forbidden	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_items

delete_items(ids=ids)

Deletes items from the library and filesystem.

Example

• Api Key Authentication (CustomAuthentication):

import jellyfin.generated.api_10_11
from jellyfin.generated.api_10_11 import ApiClient, Configuration
from jellyfin.generated.api_10_11.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = Configuration(
    host = "http://localhost"
)

# Configure API key authorization: CustomAuthentication
configuration.api_key['CustomAuthentication'] = f'Token="{os.getenv("API_KEY")}"'
configuration.api_key_prefix['CustomAuthentication'] = "MediaBrowser"


# Enter a context with an instance of the API client
with ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = jellyfin.generated.api_10_11.LibraryApi(api_client)
    ids = ['ids_example'] # List[str] | The item ids. (optional)

    try:
        # Deletes items from the library and filesystem.
        api_instance.delete_items(ids=ids)
    except Exception as e:
        print("Exception when calling LibraryApi->delete_items: %s\n" % e)

Parameters

Name	Type	Description	Notes
ids	List[str]	The item ids.	[optional]

Return type

void (empty response body)

Authorization

CustomAuthentication

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, application/json; profile="CamelCase", application/json; profile="PascalCase", text/html

HTTP response details

Status code	Description	Response headers
204	Items deleted.	-
401	Unauthorized access.	-
404	Not Found	-
503	The server is currently starting or is temporarily not available.	* Retry-After - A hint for when to retry the operation in full seconds. * Message - A short plain-text reason why the server is not available.
403	Forbidden	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_ancestors

List[BaseItemDto] get_ancestors(item_id, user_id=user_id)

Gets all parents of an item.

Example

• Api Key Authentication (CustomAuthentication):

import jellyfin.generated.api_10_11
from jellyfin.generated.api_10_11 import ApiClient, Configuration
from jellyfin.generated.api_10_11.models.base_item_dto import BaseItemDto
from jellyfin.generated.api_10_11.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = Configuration(
    host = "http://localhost"
)

# Configure API key authorization: CustomAuthentication
configuration.api_key['CustomAuthentication'] = f'Token="{os.getenv("API_KEY")}"'
configuration.api_key_prefix['CustomAuthentication'] = "MediaBrowser"


# Enter a context with an instance of the API client
with ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = jellyfin.generated.api_10_11.LibraryApi(api_client)
    item_id = 'item_id_example' # str | The item id.
    user_id = 'user_id_example' # str | Optional. Filter by user id, and attach user data. (optional)

    try:
        # Gets all parents of an item.
        api_response = api_instance.get_ancestors(item_id, user_id=user_id)
        print("The response of LibraryApi->get_ancestors:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling LibraryApi->get_ancestors: %s\n" % e)

Parameters

Name	Type	Description	Notes
item_id	str	The item id.
user_id	str	Optional. Filter by user id, and attach user data.	[optional]

Return type

List[BaseItemDto]

Authorization

CustomAuthentication

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, application/json; profile="CamelCase", application/json; profile="PascalCase", text/html

HTTP response details

Status code	Description	Response headers
200	Item parents returned.	-
404	Item not found.	-
503	The server is currently starting or is temporarily not available.	* Retry-After - A hint for when to retry the operation in full seconds. * Message - A short plain-text reason why the server is not available.
401	Unauthorized	-
403	Forbidden	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_critic_reviews

BaseItemDtoQueryResult get_critic_reviews(item_id)

Gets critic review for an item.

Example

• Api Key Authentication (CustomAuthentication):

import jellyfin.generated.api_10_11
from jellyfin.generated.api_10_11 import ApiClient, Configuration
from jellyfin.generated.api_10_11.models.base_item_dto_query_result import BaseItemDtoQueryResult
from jellyfin.generated.api_10_11.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = Configuration(
    host = "http://localhost"
)

# Configure API key authorization: CustomAuthentication
configuration.api_key['CustomAuthentication'] = f'Token="{os.getenv("API_KEY")}"'
configuration.api_key_prefix['CustomAuthentication'] = "MediaBrowser"


# Enter a context with an instance of the API client
with ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = jellyfin.generated.api_10_11.LibraryApi(api_client)
    item_id = 'item_id_example' # str | 

    try:
        # Gets critic review for an item.
        api_response = api_instance.get_critic_reviews(item_id)
        print("The response of LibraryApi->get_critic_reviews:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling LibraryApi->get_critic_reviews: %s\n" % e)

Parameters

Name	Type	Description	Notes
item_id	str

Return type

BaseItemDtoQueryResult

Authorization

CustomAuthentication

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, application/json; profile="CamelCase", application/json; profile="PascalCase", text/html

HTTP response details

Status code	Description	Response headers
200	Critic reviews returned.	-
503	The server is currently starting or is temporarily not available.	* Retry-After - A hint for when to retry the operation in full seconds. * Message - A short plain-text reason why the server is not available.
401	Unauthorized	-
403	Forbidden	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_download

bytearray get_download(item_id)

Downloads item media.

Example

• Api Key Authentication (CustomAuthentication):

import jellyfin.generated.api_10_11
from jellyfin.generated.api_10_11 import ApiClient, Configuration
from jellyfin.generated.api_10_11.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = Configuration(
    host = "http://localhost"
)

# Configure API key authorization: CustomAuthentication
configuration.api_key['CustomAuthentication'] = f'Token="{os.getenv("API_KEY")}"'
configuration.api_key_prefix['CustomAuthentication'] = "MediaBrowser"


# Enter a context with an instance of the API client
with ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = jellyfin.generated.api_10_11.LibraryApi(api_client)
    item_id = 'item_id_example' # str | The item id.

    try:
        # Downloads item media.
        api_response = api_instance.get_download(item_id)
        print("The response of LibraryApi->get_download:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling LibraryApi->get_download: %s\n" % e)

Parameters

Name	Type	Description	Notes
item_id	str	The item id.

Return type

bytearray

Authorization

CustomAuthentication

HTTP request headers

• Content-Type: Not defined
• Accept: video/, audio/, application/json, application/json; profile="CamelCase", application/json; profile="PascalCase", text/html

HTTP response details

Status code	Description	Response headers
200	Media downloaded.	-
404	Item not found.	-
503	The server is currently starting or is temporarily not available.	* Retry-After - A hint for when to retry the operation in full seconds. * Message - A short plain-text reason why the server is not available.
401	Unauthorized	-
403	Forbidden	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_file

bytearray get_file(item_id)

Get the original file of an item.

Example

• Api Key Authentication (CustomAuthentication):

import jellyfin.generated.api_10_11
from jellyfin.generated.api_10_11 import ApiClient, Configuration
from jellyfin.generated.api_10_11.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = Configuration(
    host = "http://localhost"
)

# Configure API key authorization: CustomAuthentication
configuration.api_key['CustomAuthentication'] = f'Token="{os.getenv("API_KEY")}"'
configuration.api_key_prefix['CustomAuthentication'] = "MediaBrowser"


# Enter a context with an instance of the API client
with ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = jellyfin.generated.api_10_11.LibraryApi(api_client)
    item_id = 'item_id_example' # str | The item id.

    try:
        # Get the original file of an item.
        api_response = api_instance.get_file(item_id)
        print("The response of LibraryApi->get_file:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling LibraryApi->get_file: %s\n" % e)

Parameters

Name	Type	Description	Notes
item_id	str	The item id.

Return type

bytearray

Authorization

CustomAuthentication

HTTP request headers

• Content-Type: Not defined
• Accept: video/, audio/, application/json, application/json; profile="CamelCase", application/json; profile="PascalCase", text/html

HTTP response details

Status code	Description	Response headers
200	File stream returned.	-
404	Item not found.	-
503	The server is currently starting or is temporarily not available.	* Retry-After - A hint for when to retry the operation in full seconds. * Message - A short plain-text reason why the server is not available.
401	Unauthorized	-
403	Forbidden	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_item_counts

ItemCounts get_item_counts(user_id=user_id, is_favorite=is_favorite)

Get item counts.

Example

• Api Key Authentication (CustomAuthentication):

import jellyfin.generated.api_10_11
from jellyfin.generated.api_10_11 import ApiClient, Configuration
from jellyfin.generated.api_10_11.models.item_counts import ItemCounts
from jellyfin.generated.api_10_11.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = Configuration(
    host = "http://localhost"
)

# Configure API key authorization: CustomAuthentication
configuration.api_key['CustomAuthentication'] = f'Token="{os.getenv("API_KEY")}"'
configuration.api_key_prefix['CustomAuthentication'] = "MediaBrowser"


# Enter a context with an instance of the API client
with ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = jellyfin.generated.api_10_11.LibraryApi(api_client)
    user_id = 'user_id_example' # str | Optional. Get counts from a specific user's library. (optional)
    is_favorite = True # bool | Optional. Get counts of favorite items. (optional)

    try:
        # Get item counts.
        api_response = api_instance.get_item_counts(user_id=user_id, is_favorite=is_favorite)
        print("The response of LibraryApi->get_item_counts:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling LibraryApi->get_item_counts: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_id	str	Optional. Get counts from a specific user's library.	[optional]
is_favorite	bool	Optional. Get counts of favorite items.	[optional]

Return type

ItemCounts

Authorization

CustomAuthentication

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, application/json; profile="CamelCase", application/json; profile="PascalCase", text/html

HTTP response details

Status code	Description	Response headers
200	Item counts returned.	-
503	The server is currently starting or is temporarily not available.	* Retry-After - A hint for when to retry the operation in full seconds. * Message - A short plain-text reason why the server is not available.
401	Unauthorized	-
403	Forbidden	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_library_options_info

LibraryOptionsResultDto get_library_options_info(library_content_type=library_content_type, is_new_library=is_new_library)

Gets the library options info.

Example

• Api Key Authentication (CustomAuthentication):

import jellyfin.generated.api_10_11
from jellyfin.generated.api_10_11 import ApiClient, Configuration
from jellyfin.generated.api_10_11.models.library_options_result_dto import LibraryOptionsResultDto
from jellyfin.generated.api_10_11.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = Configuration(
    host = "http://localhost"
)

# Configure API key authorization: CustomAuthentication
configuration.api_key['CustomAuthentication'] = f'Token="{os.getenv("API_KEY")}"'
configuration.api_key_prefix['CustomAuthentication'] = "MediaBrowser"


# Enter a context with an instance of the API client
with ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = jellyfin.generated.api_10_11.LibraryApi(api_client)
    library_content_type = jellyfin.generated.api_10_11.CollectionType() # CollectionType | Library content type. (optional)
    is_new_library = False # bool | Whether this is a new library. (optional) (default to False)

    try:
        # Gets the library options info.
        api_response = api_instance.get_library_options_info(library_content_type=library_content_type, is_new_library=is_new_library)
        print("The response of LibraryApi->get_library_options_info:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling LibraryApi->get_library_options_info: %s\n" % e)

Parameters

Name	Type	Description	Notes
library_content_type	CollectionType	Library content type.	[optional]
is_new_library	bool	Whether this is a new library.	[optional] [default to False]

Return type

LibraryOptionsResultDto

Authorization

CustomAuthentication

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, application/json; profile="CamelCase", application/json; profile="PascalCase", text/html

HTTP response details

Status code	Description	Response headers
200	Library options info returned.	-
503	The server is currently starting or is temporarily not available.	* Retry-After - A hint for when to retry the operation in full seconds. * Message - A short plain-text reason why the server is not available.
401	Unauthorized	-
403	Forbidden	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_media_folders

BaseItemDtoQueryResult get_media_folders(is_hidden=is_hidden)

Gets all user media folders.

Example

• Api Key Authentication (CustomAuthentication):

import jellyfin.generated.api_10_11
from jellyfin.generated.api_10_11 import ApiClient, Configuration
from jellyfin.generated.api_10_11.models.base_item_dto_query_result import BaseItemDtoQueryResult
from jellyfin.generated.api_10_11.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = Configuration(
    host = "http://localhost"
)

# Configure API key authorization: CustomAuthentication
configuration.api_key['CustomAuthentication'] = f'Token="{os.getenv("API_KEY")}"'
configuration.api_key_prefix['CustomAuthentication'] = "MediaBrowser"


# Enter a context with an instance of the API client
with ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = jellyfin.generated.api_10_11.LibraryApi(api_client)
    is_hidden = True # bool | Optional. Filter by folders that are marked hidden, or not. (optional)

    try:
        # Gets all user media folders.
        api_response = api_instance.get_media_folders(is_hidden=is_hidden)
        print("The response of LibraryApi->get_media_folders:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling LibraryApi->get_media_folders: %s\n" % e)

Parameters

Name	Type	Description	Notes
is_hidden	bool	Optional. Filter by folders that are marked hidden, or not.	[optional]

Return type

BaseItemDtoQueryResult

Authorization

CustomAuthentication

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, application/json; profile="CamelCase", application/json; profile="PascalCase", text/html

HTTP response details

Status code	Description	Response headers
200	Media folders returned.	-
503	The server is currently starting or is temporarily not available.	* Retry-After - A hint for when to retry the operation in full seconds. * Message - A short plain-text reason why the server is not available.
401	Unauthorized	-
403	Forbidden	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_physical_paths

List[str] get_physical_paths()

Gets a list of physical paths from virtual folders.

Example

• Api Key Authentication (CustomAuthentication):

import jellyfin.generated.api_10_11
from jellyfin.generated.api_10_11 import ApiClient, Configuration
from jellyfin.generated.api_10_11.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = Configuration(
    host = "http://localhost"
)

# Configure API key authorization: CustomAuthentication
configuration.api_key['CustomAuthentication'] = f'Token="{os.getenv("API_KEY")}"'
configuration.api_key_prefix['CustomAuthentication'] = "MediaBrowser"


# Enter a context with an instance of the API client
with ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = jellyfin.generated.api_10_11.LibraryApi(api_client)

    try:
        # Gets a list of physical paths from virtual folders.
        api_response = api_instance.get_physical_paths()
        print("The response of LibraryApi->get_physical_paths:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling LibraryApi->get_physical_paths: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

List[str]

Authorization

CustomAuthentication

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, application/json; profile="CamelCase", application/json; profile="PascalCase", text/html

HTTP response details

Status code	Description	Response headers
200	Physical paths returned.	-
503	The server is currently starting or is temporarily not available.	* Retry-After - A hint for when to retry the operation in full seconds. * Message - A short plain-text reason why the server is not available.
401	Unauthorized	-
403	Forbidden	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_similar_albums

BaseItemDtoQueryResult get_similar_albums(item_id, exclude_artist_ids=exclude_artist_ids, user_id=user_id, limit=limit, fields=fields)

Gets similar items.

Example

• Api Key Authentication (CustomAuthentication):

import jellyfin.generated.api_10_11
from jellyfin.generated.api_10_11 import ApiClient, Configuration
from jellyfin.generated.api_10_11.models.base_item_dto_query_result import BaseItemDtoQueryResult
from jellyfin.generated.api_10_11.models.item_fields import ItemFields
from jellyfin.generated.api_10_11.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = Configuration(
    host = "http://localhost"
)

# Configure API key authorization: CustomAuthentication
configuration.api_key['CustomAuthentication'] = f'Token="{os.getenv("API_KEY")}"'
configuration.api_key_prefix['CustomAuthentication'] = "MediaBrowser"


# Enter a context with an instance of the API client
with ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = jellyfin.generated.api_10_11.LibraryApi(api_client)
    item_id = 'item_id_example' # str | The item id.
    exclude_artist_ids = ['exclude_artist_ids_example'] # List[str] | Exclude artist ids. (optional)
    user_id = 'user_id_example' # str | Optional. Filter by user id, and attach user data. (optional)
    limit = 56 # int | Optional. The maximum number of records to return. (optional)
    fields = [jellyfin.generated.api_10_11.ItemFields()] # List[ItemFields] | Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls. (optional)

    try:
        # Gets similar items.
        api_response = api_instance.get_similar_albums(item_id, exclude_artist_ids=exclude_artist_ids, user_id=user_id, limit=limit, fields=fields)
        print("The response of LibraryApi->get_similar_albums:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling LibraryApi->get_similar_albums: %s\n" % e)

Parameters

Name	Type	Description	Notes
item_id	str	The item id.
exclude_artist_ids	List[str]	Exclude artist ids.	[optional]
user_id	str	Optional. Filter by user id, and attach user data.	[optional]
limit	int	Optional. The maximum number of records to return.	[optional]
fields	List[ItemFields]	Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls.	[optional]

Return type

BaseItemDtoQueryResult

Authorization

CustomAuthentication

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, application/json; profile="CamelCase", application/json; profile="PascalCase", text/html

HTTP response details

Status code	Description	Response headers
200	Similar items returned.	-
503	The server is currently starting or is temporarily not available.	* Retry-After - A hint for when to retry the operation in full seconds. * Message - A short plain-text reason why the server is not available.
401	Unauthorized	-
403	Forbidden	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_similar_artists

BaseItemDtoQueryResult get_similar_artists(item_id, exclude_artist_ids=exclude_artist_ids, user_id=user_id, limit=limit, fields=fields)

Gets similar items.

Example

• Api Key Authentication (CustomAuthentication):

import jellyfin.generated.api_10_11
from jellyfin.generated.api_10_11 import ApiClient, Configuration
from jellyfin.generated.api_10_11.models.base_item_dto_query_result import BaseItemDtoQueryResult
from jellyfin.generated.api_10_11.models.item_fields import ItemFields
from jellyfin.generated.api_10_11.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = Configuration(
    host = "http://localhost"
)

# Configure API key authorization: CustomAuthentication
configuration.api_key['CustomAuthentication'] = f'Token="{os.getenv("API_KEY")}"'
configuration.api_key_prefix['CustomAuthentication'] = "MediaBrowser"


# Enter a context with an instance of the API client
with ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = jellyfin.generated.api_10_11.LibraryApi(api_client)
    item_id = 'item_id_example' # str | The item id.
    exclude_artist_ids = ['exclude_artist_ids_example'] # List[str] | Exclude artist ids. (optional)
    user_id = 'user_id_example' # str | Optional. Filter by user id, and attach user data. (optional)
    limit = 56 # int | Optional. The maximum number of records to return. (optional)
    fields = [jellyfin.generated.api_10_11.ItemFields()] # List[ItemFields] | Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls. (optional)

    try:
        # Gets similar items.
        api_response = api_instance.get_similar_artists(item_id, exclude_artist_ids=exclude_artist_ids, user_id=user_id, limit=limit, fields=fields)
        print("The response of LibraryApi->get_similar_artists:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling LibraryApi->get_similar_artists: %s\n" % e)

Parameters

Name	Type	Description	Notes
item_id	str	The item id.
exclude_artist_ids	List[str]	Exclude artist ids.	[optional]
user_id	str	Optional. Filter by user id, and attach user data.	[optional]
limit	int	Optional. The maximum number of records to return.	[optional]
fields	List[ItemFields]	Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls.	[optional]

Return type

BaseItemDtoQueryResult

Authorization

CustomAuthentication

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, application/json; profile="CamelCase", application/json; profile="PascalCase", text/html

HTTP response details

Status code	Description	Response headers
200	Similar items returned.	-
503	The server is currently starting or is temporarily not available.	* Retry-After - A hint for when to retry the operation in full seconds. * Message - A short plain-text reason why the server is not available.
401	Unauthorized	-
403	Forbidden	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_similar_items

BaseItemDtoQueryResult get_similar_items(item_id, exclude_artist_ids=exclude_artist_ids, user_id=user_id, limit=limit, fields=fields)

Gets similar items.

Example

• Api Key Authentication (CustomAuthentication):

import jellyfin.generated.api_10_11
from jellyfin.generated.api_10_11 import ApiClient, Configuration
from jellyfin.generated.api_10_11.models.base_item_dto_query_result import BaseItemDtoQueryResult
from jellyfin.generated.api_10_11.models.item_fields import ItemFields
from jellyfin.generated.api_10_11.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = Configuration(
    host = "http://localhost"
)

# Configure API key authorization: CustomAuthentication
configuration.api_key['CustomAuthentication'] = f'Token="{os.getenv("API_KEY")}"'
configuration.api_key_prefix['CustomAuthentication'] = "MediaBrowser"


# Enter a context with an instance of the API client
with ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = jellyfin.generated.api_10_11.LibraryApi(api_client)
    item_id = 'item_id_example' # str | The item id.
    exclude_artist_ids = ['exclude_artist_ids_example'] # List[str] | Exclude artist ids. (optional)
    user_id = 'user_id_example' # str | Optional. Filter by user id, and attach user data. (optional)
    limit = 56 # int | Optional. The maximum number of records to return. (optional)
    fields = [jellyfin.generated.api_10_11.ItemFields()] # List[ItemFields] | Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls. (optional)

    try:
        # Gets similar items.
        api_response = api_instance.get_similar_items(item_id, exclude_artist_ids=exclude_artist_ids, user_id=user_id, limit=limit, fields=fields)
        print("The response of LibraryApi->get_similar_items:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling LibraryApi->get_similar_items: %s\n" % e)

Parameters

Name	Type	Description	Notes
item_id	str	The item id.
exclude_artist_ids	List[str]	Exclude artist ids.	[optional]
user_id	str	Optional. Filter by user id, and attach user data.	[optional]
limit	int	Optional. The maximum number of records to return.	[optional]
fields	List[ItemFields]	Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls.	[optional]

Return type

BaseItemDtoQueryResult

Authorization

CustomAuthentication

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, application/json; profile="CamelCase", application/json; profile="PascalCase", text/html

HTTP response details

Status code	Description	Response headers
200	Similar items returned.	-
503	The server is currently starting or is temporarily not available.	* Retry-After - A hint for when to retry the operation in full seconds. * Message - A short plain-text reason why the server is not available.
401	Unauthorized	-
403	Forbidden	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_similar_movies

BaseItemDtoQueryResult get_similar_movies(item_id, exclude_artist_ids=exclude_artist_ids, user_id=user_id, limit=limit, fields=fields)

Gets similar items.

Example

• Api Key Authentication (CustomAuthentication):

import jellyfin.generated.api_10_11
from jellyfin.generated.api_10_11 import ApiClient, Configuration
from jellyfin.generated.api_10_11.models.base_item_dto_query_result import BaseItemDtoQueryResult
from jellyfin.generated.api_10_11.models.item_fields import ItemFields
from jellyfin.generated.api_10_11.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = Configuration(
    host = "http://localhost"
)

# Configure API key authorization: CustomAuthentication
configuration.api_key['CustomAuthentication'] = f'Token="{os.getenv("API_KEY")}"'
configuration.api_key_prefix['CustomAuthentication'] = "MediaBrowser"


# Enter a context with an instance of the API client
with ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = jellyfin.generated.api_10_11.LibraryApi(api_client)
    item_id = 'item_id_example' # str | The item id.
    exclude_artist_ids = ['exclude_artist_ids_example'] # List[str] | Exclude artist ids. (optional)
    user_id = 'user_id_example' # str | Optional. Filter by user id, and attach user data. (optional)
    limit = 56 # int | Optional. The maximum number of records to return. (optional)
    fields = [jellyfin.generated.api_10_11.ItemFields()] # List[ItemFields] | Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls. (optional)

    try:
        # Gets similar items.
        api_response = api_instance.get_similar_movies(item_id, exclude_artist_ids=exclude_artist_ids, user_id=user_id, limit=limit, fields=fields)
        print("The response of LibraryApi->get_similar_movies:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling LibraryApi->get_similar_movies: %s\n" % e)

Parameters

Name	Type	Description	Notes
item_id	str	The item id.
exclude_artist_ids	List[str]	Exclude artist ids.	[optional]
user_id	str	Optional. Filter by user id, and attach user data.	[optional]
limit	int	Optional. The maximum number of records to return.	[optional]
fields	List[ItemFields]	Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls.	[optional]

Return type

BaseItemDtoQueryResult

Authorization

CustomAuthentication

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, application/json; profile="CamelCase", application/json; profile="PascalCase", text/html

HTTP response details

Status code	Description	Response headers
200	Similar items returned.	-
503	The server is currently starting or is temporarily not available.	* Retry-After - A hint for when to retry the operation in full seconds. * Message - A short plain-text reason why the server is not available.
401	Unauthorized	-
403	Forbidden	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_similar_shows

BaseItemDtoQueryResult get_similar_shows(item_id, exclude_artist_ids=exclude_artist_ids, user_id=user_id, limit=limit, fields=fields)

Gets similar items.

Example

• Api Key Authentication (CustomAuthentication):

import jellyfin.generated.api_10_11
from jellyfin.generated.api_10_11 import ApiClient, Configuration
from jellyfin.generated.api_10_11.models.base_item_dto_query_result import BaseItemDtoQueryResult
from jellyfin.generated.api_10_11.models.item_fields import ItemFields
from jellyfin.generated.api_10_11.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = Configuration(
    host = "http://localhost"
)

# Configure API key authorization: CustomAuthentication
configuration.api_key['CustomAuthentication'] = f'Token="{os.getenv("API_KEY")}"'
configuration.api_key_prefix['CustomAuthentication'] = "MediaBrowser"


# Enter a context with an instance of the API client
with ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = jellyfin.generated.api_10_11.LibraryApi(api_client)
    item_id = 'item_id_example' # str | The item id.
    exclude_artist_ids = ['exclude_artist_ids_example'] # List[str] | Exclude artist ids. (optional)
    user_id = 'user_id_example' # str | Optional. Filter by user id, and attach user data. (optional)
    limit = 56 # int | Optional. The maximum number of records to return. (optional)
    fields = [jellyfin.generated.api_10_11.ItemFields()] # List[ItemFields] | Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls. (optional)

    try:
        # Gets similar items.
        api_response = api_instance.get_similar_shows(item_id, exclude_artist_ids=exclude_artist_ids, user_id=user_id, limit=limit, fields=fields)
        print("The response of LibraryApi->get_similar_shows:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling LibraryApi->get_similar_shows: %s\n" % e)

Parameters

Name	Type	Description	Notes
item_id	str	The item id.
exclude_artist_ids	List[str]	Exclude artist ids.	[optional]
user_id	str	Optional. Filter by user id, and attach user data.	[optional]
limit	int	Optional. The maximum number of records to return.	[optional]
fields	List[ItemFields]	Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls.	[optional]

Return type

BaseItemDtoQueryResult

Authorization

CustomAuthentication

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, application/json; profile="CamelCase", application/json; profile="PascalCase", text/html

HTTP response details

Status code	Description	Response headers
200	Similar items returned.	-
503	The server is currently starting or is temporarily not available.	* Retry-After - A hint for when to retry the operation in full seconds. * Message - A short plain-text reason why the server is not available.
401	Unauthorized	-
403	Forbidden	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_similar_trailers

BaseItemDtoQueryResult get_similar_trailers(item_id, exclude_artist_ids=exclude_artist_ids, user_id=user_id, limit=limit, fields=fields)

Gets similar items.

Example

• Api Key Authentication (CustomAuthentication):

import jellyfin.generated.api_10_11
from jellyfin.generated.api_10_11 import ApiClient, Configuration
from jellyfin.generated.api_10_11.models.base_item_dto_query_result import BaseItemDtoQueryResult
from jellyfin.generated.api_10_11.models.item_fields import ItemFields
from jellyfin.generated.api_10_11.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = Configuration(
    host = "http://localhost"
)

# Configure API key authorization: CustomAuthentication
configuration.api_key['CustomAuthentication'] = f'Token="{os.getenv("API_KEY")}"'
configuration.api_key_prefix['CustomAuthentication'] = "MediaBrowser"


# Enter a context with an instance of the API client
with ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = jellyfin.generated.api_10_11.LibraryApi(api_client)
    item_id = 'item_id_example' # str | The item id.
    exclude_artist_ids = ['exclude_artist_ids_example'] # List[str] | Exclude artist ids. (optional)
    user_id = 'user_id_example' # str | Optional. Filter by user id, and attach user data. (optional)
    limit = 56 # int | Optional. The maximum number of records to return. (optional)
    fields = [jellyfin.generated.api_10_11.ItemFields()] # List[ItemFields] | Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls. (optional)

    try:
        # Gets similar items.
        api_response = api_instance.get_similar_trailers(item_id, exclude_artist_ids=exclude_artist_ids, user_id=user_id, limit=limit, fields=fields)
        print("The response of LibraryApi->get_similar_trailers:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling LibraryApi->get_similar_trailers: %s\n" % e)

Parameters

Name	Type	Description	Notes
item_id	str	The item id.
exclude_artist_ids	List[str]	Exclude artist ids.	[optional]
user_id	str	Optional. Filter by user id, and attach user data.	[optional]
limit	int	Optional. The maximum number of records to return.	[optional]
fields	List[ItemFields]	Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls.	[optional]

Return type

BaseItemDtoQueryResult

Authorization

CustomAuthentication

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, application/json; profile="CamelCase", application/json; profile="PascalCase", text/html

HTTP response details

Status code	Description	Response headers
200	Similar items returned.	-
503	The server is currently starting or is temporarily not available.	* Retry-After - A hint for when to retry the operation in full seconds. * Message - A short plain-text reason why the server is not available.
401	Unauthorized	-
403	Forbidden	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_theme_media

AllThemeMediaResult get_theme_media(item_id, user_id=user_id, inherit_from_parent=inherit_from_parent, sort_by=sort_by, sort_order=sort_order)

Get theme songs and videos for an item.

Example

• Api Key Authentication (CustomAuthentication):

import jellyfin.generated.api_10_11
from jellyfin.generated.api_10_11 import ApiClient, Configuration
from jellyfin.generated.api_10_11.models.all_theme_media_result import AllThemeMediaResult
from jellyfin.generated.api_10_11.models.item_sort_by import ItemSortBy
from jellyfin.generated.api_10_11.models.sort_order import SortOrder
from jellyfin.generated.api_10_11.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = Configuration(
    host = "http://localhost"
)

# Configure API key authorization: CustomAuthentication
configuration.api_key['CustomAuthentication'] = f'Token="{os.getenv("API_KEY")}"'
configuration.api_key_prefix['CustomAuthentication'] = "MediaBrowser"


# Enter a context with an instance of the API client
with ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = jellyfin.generated.api_10_11.LibraryApi(api_client)
    item_id = 'item_id_example' # str | The item id.
    user_id = 'user_id_example' # str | Optional. Filter by user id, and attach user data. (optional)
    inherit_from_parent = False # bool | Optional. Determines whether or not parent items should be searched for theme media. (optional) (default to False)
    sort_by = [jellyfin.generated.api_10_11.ItemSortBy()] # List[ItemSortBy] | Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime. (optional)
    sort_order = [jellyfin.generated.api_10_11.SortOrder()] # List[SortOrder] | Optional. Sort Order - Ascending, Descending. (optional)

    try:
        # Get theme songs and videos for an item.
        api_response = api_instance.get_theme_media(item_id, user_id=user_id, inherit_from_parent=inherit_from_parent, sort_by=sort_by, sort_order=sort_order)
        print("The response of LibraryApi->get_theme_media:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling LibraryApi->get_theme_media: %s\n" % e)

Parameters

Name	Type	Description	Notes
item_id	str	The item id.
user_id	str	Optional. Filter by user id, and attach user data.	[optional]
inherit_from_parent	bool	Optional. Determines whether or not parent items should be searched for theme media.	[optional] [default to False]
sort_by	List[ItemSortBy]	Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.	[optional]
sort_order	List[SortOrder]	Optional. Sort Order - Ascending, Descending.	[optional]

Return type

AllThemeMediaResult

Authorization

CustomAuthentication

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, application/json; profile="CamelCase", application/json; profile="PascalCase", text/html

HTTP response details

Status code	Description	Response headers
200	Theme songs and videos returned.	-
404	Item not found.	-
503	The server is currently starting or is temporarily not available.	* Retry-After - A hint for when to retry the operation in full seconds. * Message - A short plain-text reason why the server is not available.
401	Unauthorized	-
403	Forbidden	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_theme_songs

ThemeMediaResult get_theme_songs(item_id, user_id=user_id, inherit_from_parent=inherit_from_parent, sort_by=sort_by, sort_order=sort_order)

Get theme songs for an item.

Example

• Api Key Authentication (CustomAuthentication):

import jellyfin.generated.api_10_11
from jellyfin.generated.api_10_11 import ApiClient, Configuration
from jellyfin.generated.api_10_11.models.item_sort_by import ItemSortBy
from jellyfin.generated.api_10_11.models.sort_order import SortOrder
from jellyfin.generated.api_10_11.models.theme_media_result import ThemeMediaResult
from jellyfin.generated.api_10_11.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = Configuration(
    host = "http://localhost"
)

# Configure API key authorization: CustomAuthentication
configuration.api_key['CustomAuthentication'] = f'Token="{os.getenv("API_KEY")}"'
configuration.api_key_prefix['CustomAuthentication'] = "MediaBrowser"


# Enter a context with an instance of the API client
with ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = jellyfin.generated.api_10_11.LibraryApi(api_client)
    item_id = 'item_id_example' # str | The item id.
    user_id = 'user_id_example' # str | Optional. Filter by user id, and attach user data. (optional)
    inherit_from_parent = False # bool | Optional. Determines whether or not parent items should be searched for theme media. (optional) (default to False)
    sort_by = [jellyfin.generated.api_10_11.ItemSortBy()] # List[ItemSortBy] | Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime. (optional)
    sort_order = [jellyfin.generated.api_10_11.SortOrder()] # List[SortOrder] | Optional. Sort Order - Ascending, Descending. (optional)

    try:
        # Get theme songs for an item.
        api_response = api_instance.get_theme_songs(item_id, user_id=user_id, inherit_from_parent=inherit_from_parent, sort_by=sort_by, sort_order=sort_order)
        print("The response of LibraryApi->get_theme_songs:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling LibraryApi->get_theme_songs: %s\n" % e)

Parameters

Name	Type	Description	Notes
item_id	str	The item id.
user_id	str	Optional. Filter by user id, and attach user data.	[optional]
inherit_from_parent	bool	Optional. Determines whether or not parent items should be searched for theme media.	[optional] [default to False]
sort_by	List[ItemSortBy]	Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.	[optional]
sort_order	List[SortOrder]	Optional. Sort Order - Ascending, Descending.	[optional]

Return type

ThemeMediaResult

Authorization

CustomAuthentication

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, application/json; profile="CamelCase", application/json; profile="PascalCase", text/html

HTTP response details

Status code	Description	Response headers
200	Theme songs returned.	-
404	Item not found.	-
503	The server is currently starting or is temporarily not available.	* Retry-After - A hint for when to retry the operation in full seconds. * Message - A short plain-text reason why the server is not available.
401	Unauthorized	-
403	Forbidden	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_theme_videos

ThemeMediaResult get_theme_videos(item_id, user_id=user_id, inherit_from_parent=inherit_from_parent, sort_by=sort_by, sort_order=sort_order)

Get theme videos for an item.

Example

• Api Key Authentication (CustomAuthentication):

import jellyfin.generated.api_10_11
from jellyfin.generated.api_10_11 import ApiClient, Configuration
from jellyfin.generated.api_10_11.models.item_sort_by import ItemSortBy
from jellyfin.generated.api_10_11.models.sort_order import SortOrder
from jellyfin.generated.api_10_11.models.theme_media_result import ThemeMediaResult
from jellyfin.generated.api_10_11.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = Configuration(
    host = "http://localhost"
)

# Configure API key authorization: CustomAuthentication
configuration.api_key['CustomAuthentication'] = f'Token="{os.getenv("API_KEY")}"'
configuration.api_key_prefix['CustomAuthentication'] = "MediaBrowser"


# Enter a context with an instance of the API client
with ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = jellyfin.generated.api_10_11.LibraryApi(api_client)
    item_id = 'item_id_example' # str | The item id.
    user_id = 'user_id_example' # str | Optional. Filter by user id, and attach user data. (optional)
    inherit_from_parent = False # bool | Optional. Determines whether or not parent items should be searched for theme media. (optional) (default to False)
    sort_by = [jellyfin.generated.api_10_11.ItemSortBy()] # List[ItemSortBy] | Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime. (optional)
    sort_order = [jellyfin.generated.api_10_11.SortOrder()] # List[SortOrder] | Optional. Sort Order - Ascending, Descending. (optional)

    try:
        # Get theme videos for an item.
        api_response = api_instance.get_theme_videos(item_id, user_id=user_id, inherit_from_parent=inherit_from_parent, sort_by=sort_by, sort_order=sort_order)
        print("The response of LibraryApi->get_theme_videos:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling LibraryApi->get_theme_videos: %s\n" % e)

Parameters

Name	Type	Description	Notes
item_id	str	The item id.
user_id	str	Optional. Filter by user id, and attach user data.	[optional]
inherit_from_parent	bool	Optional. Determines whether or not parent items should be searched for theme media.	[optional] [default to False]
sort_by	List[ItemSortBy]	Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.	[optional]
sort_order	List[SortOrder]	Optional. Sort Order - Ascending, Descending.	[optional]

Return type

ThemeMediaResult

Authorization

CustomAuthentication

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, application/json; profile="CamelCase", application/json; profile="PascalCase", text/html

HTTP response details

Status code	Description	Response headers
200	Theme videos returned.	-
404	Item not found.	-
503	The server is currently starting or is temporarily not available.	* Retry-After - A hint for when to retry the operation in full seconds. * Message - A short plain-text reason why the server is not available.
401	Unauthorized	-
403	Forbidden	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

post_added_movies

post_added_movies(tmdb_id=tmdb_id, imdb_id=imdb_id)

Reports that new movies have been added by an external source.

Example

• Api Key Authentication (CustomAuthentication):

import jellyfin.generated.api_10_11
from jellyfin.generated.api_10_11 import ApiClient, Configuration
from jellyfin.generated.api_10_11.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = Configuration(
    host = "http://localhost"
)

# Configure API key authorization: CustomAuthentication
configuration.api_key['CustomAuthentication'] = f'Token="{os.getenv("API_KEY")}"'
configuration.api_key_prefix['CustomAuthentication'] = "MediaBrowser"


# Enter a context with an instance of the API client
with ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = jellyfin.generated.api_10_11.LibraryApi(api_client)
    tmdb_id = 'tmdb_id_example' # str | The tmdbId. (optional)
    imdb_id = 'imdb_id_example' # str | The imdbId. (optional)

    try:
        # Reports that new movies have been added by an external source.
        api_instance.post_added_movies(tmdb_id=tmdb_id, imdb_id=imdb_id)
    except Exception as e:
        print("Exception when calling LibraryApi->post_added_movies: %s\n" % e)

Parameters

Name	Type	Description	Notes
tmdb_id	str	The tmdbId.	[optional]
imdb_id	str	The imdbId.	[optional]

Return type

void (empty response body)

Authorization

CustomAuthentication

HTTP request headers

• Content-Type: Not defined
• Accept: text/html

HTTP response details

Status code	Description	Response headers
204	Report success.	-
503	The server is currently starting or is temporarily not available.	* Retry-After - A hint for when to retry the operation in full seconds. * Message - A short plain-text reason why the server is not available.
401	Unauthorized	-
403	Forbidden	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

post_added_series

post_added_series(tvdb_id=tvdb_id)

Reports that new episodes of a series have been added by an external source.

Example

• Api Key Authentication (CustomAuthentication):

import jellyfin.generated.api_10_11
from jellyfin.generated.api_10_11 import ApiClient, Configuration
from jellyfin.generated.api_10_11.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = Configuration(
    host = "http://localhost"
)

# Configure API key authorization: CustomAuthentication
configuration.api_key['CustomAuthentication'] = f'Token="{os.getenv("API_KEY")}"'
configuration.api_key_prefix['CustomAuthentication'] = "MediaBrowser"


# Enter a context with an instance of the API client
with ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = jellyfin.generated.api_10_11.LibraryApi(api_client)
    tvdb_id = 'tvdb_id_example' # str | The tvdbId. (optional)

    try:
        # Reports that new episodes of a series have been added by an external source.
        api_instance.post_added_series(tvdb_id=tvdb_id)
    except Exception as e:
        print("Exception when calling LibraryApi->post_added_series: %s\n" % e)

Parameters

Name	Type	Description	Notes
tvdb_id	str	The tvdbId.	[optional]

Return type

void (empty response body)

Authorization

CustomAuthentication

HTTP request headers

• Content-Type: Not defined
• Accept: text/html

HTTP response details

Status code	Description	Response headers
204	Report success.	-
503	The server is currently starting or is temporarily not available.	* Retry-After - A hint for when to retry the operation in full seconds. * Message - A short plain-text reason why the server is not available.
401	Unauthorized	-
403	Forbidden	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

post_updated_media

post_updated_media(media_update_info_dto)

Reports that new movies have been added by an external source.

Example

• Api Key Authentication (CustomAuthentication):

import jellyfin.generated.api_10_11
from jellyfin.generated.api_10_11 import ApiClient, Configuration
from jellyfin.generated.api_10_11.models.media_update_info_dto import MediaUpdateInfoDto
from jellyfin.generated.api_10_11.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = Configuration(
    host = "http://localhost"
)

# Configure API key authorization: CustomAuthentication
configuration.api_key['CustomAuthentication'] = f'Token="{os.getenv("API_KEY")}"'
configuration.api_key_prefix['CustomAuthentication'] = "MediaBrowser"


# Enter a context with an instance of the API client
with ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = jellyfin.generated.api_10_11.LibraryApi(api_client)
    media_update_info_dto = jellyfin.generated.api_10_11.MediaUpdateInfoDto() # MediaUpdateInfoDto | The update paths.

    try:
        # Reports that new movies have been added by an external source.
        api_instance.post_updated_media(media_update_info_dto)
    except Exception as e:
        print("Exception when calling LibraryApi->post_updated_media: %s\n" % e)

Parameters

Name	Type	Description	Notes
media_update_info_dto	MediaUpdateInfoDto	The update paths.

Return type

void (empty response body)

Authorization

CustomAuthentication

HTTP request headers

• Content-Type: application/json, text/json, application/*+json
• Accept: text/html

HTTP response details

Status code	Description	Response headers
204	Report success.	-
503	The server is currently starting or is temporarily not available.	* Retry-After - A hint for when to retry the operation in full seconds. * Message - A short plain-text reason why the server is not available.
401	Unauthorized	-
403	Forbidden	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

post_updated_movies

post_updated_movies(tmdb_id=tmdb_id, imdb_id=imdb_id)

Reports that new movies have been added by an external source.

Example

• Api Key Authentication (CustomAuthentication):

import jellyfin.generated.api_10_11
from jellyfin.generated.api_10_11 import ApiClient, Configuration
from jellyfin.generated.api_10_11.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = Configuration(
    host = "http://localhost"
)

# Configure API key authorization: CustomAuthentication
configuration.api_key['CustomAuthentication'] = f'Token="{os.getenv("API_KEY")}"'
configuration.api_key_prefix['CustomAuthentication'] = "MediaBrowser"


# Enter a context with an instance of the API client
with ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = jellyfin.generated.api_10_11.LibraryApi(api_client)
    tmdb_id = 'tmdb_id_example' # str | The tmdbId. (optional)
    imdb_id = 'imdb_id_example' # str | The imdbId. (optional)

    try:
        # Reports that new movies have been added by an external source.
        api_instance.post_updated_movies(tmdb_id=tmdb_id, imdb_id=imdb_id)
    except Exception as e:
        print("Exception when calling LibraryApi->post_updated_movies: %s\n" % e)

Parameters

Name	Type	Description	Notes
tmdb_id	str	The tmdbId.	[optional]
imdb_id	str	The imdbId.	[optional]

Return type

void (empty response body)

Authorization

CustomAuthentication

HTTP request headers

• Content-Type: Not defined
• Accept: text/html

HTTP response details

Status code	Description	Response headers
204	Report success.	-
503	The server is currently starting or is temporarily not available.	* Retry-After - A hint for when to retry the operation in full seconds. * Message - A short plain-text reason why the server is not available.
401	Unauthorized	-
403	Forbidden	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

post_updated_series

post_updated_series(tvdb_id=tvdb_id)

Reports that new episodes of a series have been added by an external source.

Example

• Api Key Authentication (CustomAuthentication):

import jellyfin.generated.api_10_11
from jellyfin.generated.api_10_11 import ApiClient, Configuration
from jellyfin.generated.api_10_11.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = Configuration(
    host = "http://localhost"
)

# Configure API key authorization: CustomAuthentication
configuration.api_key['CustomAuthentication'] = f'Token="{os.getenv("API_KEY")}"'
configuration.api_key_prefix['CustomAuthentication'] = "MediaBrowser"


# Enter a context with an instance of the API client
with ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = jellyfin.generated.api_10_11.LibraryApi(api_client)
    tvdb_id = 'tvdb_id_example' # str | The tvdbId. (optional)

    try:
        # Reports that new episodes of a series have been added by an external source.
        api_instance.post_updated_series(tvdb_id=tvdb_id)
    except Exception as e:
        print("Exception when calling LibraryApi->post_updated_series: %s\n" % e)

Parameters

Name	Type	Description	Notes
tvdb_id	str	The tvdbId.	[optional]

Return type

void (empty response body)

Authorization

CustomAuthentication

HTTP request headers

• Content-Type: Not defined
• Accept: text/html

HTTP response details

Status code	Description	Response headers
204	Report success.	-
503	The server is currently starting or is temporarily not available.	* Retry-After - A hint for when to retry the operation in full seconds. * Message - A short plain-text reason why the server is not available.
401	Unauthorized	-
403	Forbidden	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

refresh_library

refresh_library()

Starts a library scan.

Example

• Api Key Authentication (CustomAuthentication):

import jellyfin.generated.api_10_11
from jellyfin.generated.api_10_11 import ApiClient, Configuration
from jellyfin.generated.api_10_11.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = Configuration(
    host = "http://localhost"
)

# Configure API key authorization: CustomAuthentication
configuration.api_key['CustomAuthentication'] = f'Token="{os.getenv("API_KEY")}"'
configuration.api_key_prefix['CustomAuthentication'] = "MediaBrowser"


# Enter a context with an instance of the API client
with ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = jellyfin.generated.api_10_11.LibraryApi(api_client)

    try:
        # Starts a library scan.
        api_instance.refresh_library()
    except Exception as e:
        print("Exception when calling LibraryApi->refresh_library: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

CustomAuthentication

HTTP request headers

• Content-Type: Not defined
• Accept: text/html

HTTP response details

Status code	Description	Response headers
204	Library scan started.	-
503	The server is currently starting or is temporarily not available.	* Retry-After - A hint for when to retry the operation in full seconds. * Message - A short plain-text reason why the server is not available.
401	Unauthorized	-
403	Forbidden	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]