jellyfin.generated.api_10_11.RemoteImageApi

All URIs are relative to http://localhost

Method	HTTP request	Description
download_remote_image	POST /Items/{itemId}/RemoteImages/Download	Downloads a remote image for an item.
get_remote_image_providers	GET /Items/{itemId}/RemoteImages/Providers	Gets available remote image providers for an item.
get_remote_images	GET /Items/{itemId}/RemoteImages	Gets available remote images for an item.

download_remote_image

download_remote_image(item_id, type, image_url=image_url)

Downloads a remote image 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.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.RemoteImageApi(api_client)
    item_id = 'item_id_example' # str | Item Id.
    type = jellyfin.generated.api_10_11.ImageType() # ImageType | The image type.
    image_url = 'image_url_example' # str | The image url. (optional)

    try:
        # Downloads a remote image for an item.
        api_instance.download_remote_image(item_id, type, image_url=image_url)
    except Exception as e:
        print("Exception when calling RemoteImageApi->download_remote_image: %s\n" % e)

Parameters

Name	Type	Description	Notes
item_id	str	Item Id.
type	ImageType	The image type.
image_url	str	The image url.	[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	Remote image downloaded.	-
404	Remote image 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_remote_image_providers

List[ImageProviderInfo] get_remote_image_providers(item_id)

Gets available remote image providers 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.image_provider_info import ImageProviderInfo
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.RemoteImageApi(api_client)
    item_id = 'item_id_example' # str | Item Id.

    try:
        # Gets available remote image providers for an item.
        api_response = api_instance.get_remote_image_providers(item_id)
        print("The response of RemoteImageApi->get_remote_image_providers:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RemoteImageApi->get_remote_image_providers: %s\n" % e)

Parameters

Name	Type	Description	Notes
item_id	str	Item Id.

Return type

List[ImageProviderInfo]

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	Returned remote image providers.	-
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_remote_images

RemoteImageResult get_remote_images(item_id, type=type, start_index=start_index, limit=limit, provider_name=provider_name, include_all_languages=include_all_languages)

Gets available remote images 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.remote_image_result import RemoteImageResult
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.RemoteImageApi(api_client)
    item_id = 'item_id_example' # str | Item Id.
    type = jellyfin.generated.api_10_11.ImageType() # ImageType | The image type. (optional)
    start_index = 56 # int | Optional. The record index to start at. All items with a lower index will be dropped from the results. (optional)
    limit = 56 # int | Optional. The maximum number of records to return. (optional)
    provider_name = 'provider_name_example' # str | Optional. The image provider to use. (optional)
    include_all_languages = False # bool | Optional. Include all languages. (optional) (default to False)

    try:
        # Gets available remote images for an item.
        api_response = api_instance.get_remote_images(item_id, type=type, start_index=start_index, limit=limit, provider_name=provider_name, include_all_languages=include_all_languages)
        print("The response of RemoteImageApi->get_remote_images:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RemoteImageApi->get_remote_images: %s\n" % e)

Parameters

Name	Type	Description	Notes
item_id	str	Item Id.
type	ImageType	The image type.	[optional]
start_index	int	Optional. The record index to start at. All items with a lower index will be dropped from the results.	[optional]
limit	int	Optional. The maximum number of records to return.	[optional]
provider_name	str	Optional. The image provider to use.	[optional]
include_all_languages	bool	Optional. Include all languages.	[optional] [default to False]

Return type

RemoteImageResult

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	Remote Images 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]