@jellyfin/sdk
    Preparing search index...

    Interface LibraryApiGetSimilarItemsRequest

    Request parameters for getSimilarItems operation in LibraryApi.

    LibraryApiGetSimilarItemsRequest

    interface LibraryApiGetSimilarItemsRequest {
        excludeArtistIds?: string[];
        fields?: ItemFields[];
        itemId: string;
        limit?: number;
        userId?: string;
    }
    Index

    Properties

    excludeArtistIds? fields? itemId limit? userId?

    Properties

    excludeArtistIds?: string[]

    Exclude artist ids.

    LibraryApiGetSimilarItems

    fields?: 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.

    LibraryApiGetSimilarItems

    itemId: string

    The item id.

    LibraryApiGetSimilarItems

    limit?: number

    Optional. The maximum number of records to return.

    LibraryApiGetSimilarItems

    userId?: string

    Optional. Filter by user id, and attach user data.

    LibraryApiGetSimilarItems

    Settings

    Member Visibility

    On This Page

    Properties