openapi-directory/api/jellyfin.local.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.1","servers":[{"url":"http://jellyfin.local"},{"url":"http://localhost"}],"x-hasEquivalentPaths":true,"info":{"title":"Jellyfin API","version":"v1","x-apisguru-categories":["media"],"x-jellyfin-version":"10.7.0.0","x-origin":[{"format":"openapi","url":"https://repo.jellyfin.org/releases/openapi/stable/jellyfin-openapi-10.7.0-rc2.json","version":"3.0"}],"x-providerName":"jellyfin.local"},"paths":{"/Albums/{id}/InstantMix":{"get":{"operationId":"GetInstantMixFromAlbum","parameters":[{"description":"The item id.","in":"path","name":"id","required":true,"schema":{"description":"The item id.","format":"uuid","type":"string"}},{"description":"Optional. Filter by user id, and attach user data.","in":"query","name":"userId","schema":{"description":"Optional. Filter by user id, and attach user data.","format":"uuid","nullable":true,"type":"string"}},{"description":"Optional. The maximum number of records to return.","in":"query","name":"limit","schema":{"description":"Optional. The maximum number of records to return.","format":"int32","nullable":true,"type":"integer"}},{"description":"Optional. Specify additional fields of information to return in the output.","in":"query","name":"fields","schema":{"description":"Optional. Specify additional fields of information to return in the output.","items":{"$ref":"#/components/schemas/ItemFields"},"nullable":true,"type":"array"}},{"description":"Optional. Include image information in output.","in":"query","name":"enableImages","schema":{"description":"Optional. Include image information in output.","nullable":true,"type":"boolean"}},{"description":"Optional. Include user data.","in":"query","name":"enableUserData","schema":{"description":"Optional. Include user data.","nullable":true,"type":"boolean"}},{"description":"Optional. The max number of images to return, per image type.","in":"query","name":"imageTypeLimit","schema":{"description":"Optional. The max number of images to return, per image type.","format":"int32","nullable":true,"type":"integer"}},{"description":"Optional. The image types to include in the output.","in":"query","name":"enableImageTypes","schema":{"description":"Optional. The image types to include in the output.","items":{"$ref":"#/components/schemas/ImageType"},"nullable":true,"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseItemDtoQueryResult"}},"application/json; profile=\"CamelCase\"":{"schema":{"$ref":"#/components/schemas/BaseItemDtoQueryResult"}},"application/json; profile=\"PascalCase\"":{"schema":{"$ref":"#/components/schemas/BaseItemDtoQueryResult"}}},"description":"Instant playlist returned."},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"security":[{"CustomAuthentication":[]}],"summary":"Creates an instant playlist based on a given song.","tags":["InstantMix"]}},"/Albums/{itemId}/Similar":{"get":{"operationId":"GetSimilarAlbums","parameters":[{"description":"The item id.","in":"path","name":"itemId","required":true,"schema":{"description":"The item id.","format":"uuid","type":"string"}},{"description":"Exclude artist ids.","in":"query","name":"excludeArtistIds","schema":{"description":"Exclude artist ids.","items":{"format":"uuid","type":"string"},"nullable":true,"type":"array"}},{"description":"Optional. Filter by user id, and attach user data.","in":"query","name":"userId","schema":{"description":"Optional. Filter by user id, and attach user data.","format":"uuid","nullable":true,"type":"string"}},{"description":"Optional. The maximum number of records to return.","in":"query","name":"limit","schema":{"description":"Optional. The maximum number of records to return.","format":"int32","nullable":true,"type":"integer"}},{"description":"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.","in":"query","name":"fields","schema":{"description":"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.","items":{"$ref":"#/components/schemas/ItemFields"},"nullable":true,"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseItemDtoQueryResult"}},"application/json; profile=\"CamelCase\"":{"schema":{"$ref":"#/components/schemas/BaseItemDtoQueryResult"}},"application/json; profile=\"PascalCase\"":{"schema":{"$ref":"#/components/schemas/BaseItemDtoQueryResult"}}},"description":"Similar items returned."},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"security":[{"CustomAuthentication":[]}],"summary":"Gets similar items.","tags":["Library"]}},"/Artists":{"get":{"operationId":"GetArtists","parameters":[{"description":"Optional filter by minimum community rating.","in":"query","name":"minCommunityRating","schema":{"description":"Optional filter by minimum community rating.","format":"double","nullable":true,"type":"number"}},{"description":"Optional. The record index to start at. All items with a lower index will be dropped from the results.","in":"query","name":"startIndex","schema":{"description":"Optional. The record index to start at. All items with a lower index will be dropped from the results.","format":"int32","nullable":true,"type":"integer"}},{"description":"Optional. The maximum number of records to return.","in":"query","name":"limit","schema":{"description":"Optional. The maximum number of records to return.","format":"int32","nullable":true,"type":"integer"}},{"description":"Optional. Search term.","in":"query","name":"searchTerm","schema":{"description":"Optional. Search term.","nullable":true,"type":"string"}},{"description":"Specify this to localize the search to a specific item or folder. Omit to use the root.","in":"query","name":"parentId","schema":{"description":"Specify this to localize the search to a specific item or folder. Omit to use the root.","format":"uuid","nullable":true,"type":"string"}},{"description":"Optional. Specify additional fields of information to return in the output.","in":"query","name":"fields","schema":{"description":"Optional. Specify additional fields of information to return in the output.","items":{"$ref":"#/components/schemas/ItemFields"},"nullable":true,"type":"array"}},{"description":"Optional. If specified, results will be filtered out based on item type. This allows multiple, comma delimited.","in":"query","name":"excludeItemTypes","schema":{"description":"Optional. If specified, results will be filtered out based on item type. This allows multiple, comma delimited.","items":{"type":"string"},"nullable":true,"type":"array"}},{"description":"Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.","in":"query","name":"includeItemTypes","schema":{"description":"Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.","items":{"type":"string"},"nullable":true,"type":"array"}},{"description":"Optional. Specify additional filters to apply.","in":"query","name":"filters","schema":{"description":"Optional. Specify additional filters to apply.","items":{"$ref":"#/components/schemas/ItemFilter"},"nullable":true,"type":"array"}},{"description":"Optional filter by items that are marked as favorite, or not.","in":"query","name":"isFavorite","schema":{"description":"Optional filter by items that are marked as favorite, or not.","nullable":true,"type":"boolean"}},{"description":"Optional filter by MediaType. Allows multiple, comma delimited.","in":"query","name":"mediaTypes","schema":{"description":"Optional filter by MediaType. Allows multiple, comma delimited.","items":{"type":"string"},"nullable":true,"type":"array"}},{"description":"Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.","in":"query","name":"genres","schema":{"description":"Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.","items":{"type":"string"},"nullable":true,"type":"array"}},{"description":"Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.","in":"query","name":"genreIds","schema":{"description":"Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.","items":{"format":"uuid","type":"string"},"nullable":true,"type":"array"}},{"description":"Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.","in":"query","name":"officialRatings","schema":{"description":"Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.","items":{"type":"string"},"nullable":true,"type":"array"}},{"description":"Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited.","in":"query","name":"tags","schema":{"description":"Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited.","items":{"type":"string"},"nullable":true,"type":"array"}},{"description":"Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimited.","in":"query","name":"years","schema":{"description":"Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimited.","items":{"format":"int32","type":"integer"},"nullable":true,"type":"array"}},{"description":"Optional, include user data.","in":"query","name":"enableUserData","schema":{"description":"Optional, include user data.","nullable":true,"type":"boolean"}},{"description":"Optional, the max number of images to return, per image type.","in":"query","name":"imageTypeLimit","schema":{"description":"Optional, the max number of images to return, per image type.","format":"int32","nullable":true,"type":"integer"}},{"description":"Optional. The image types to include in the output.","in":"query","name":"enableImageTypes","schema":{"description":"Optional. The image types to include in the output.","items":{"$ref":"#/components/schemas/ImageType"},"nullable":true,"type":"array"}},{"description":"Optional. If specified, results will be filtered to include only those containing the specified person.","in":"query","name":"person","schema":{"description":"Optional. If specified, results will be filtered to include only those containing the specified person.","nullable":true,"type":"string"}},{"description":"Optional. If specified, results will be filtered to include only those containing the specified person ids.","in":"query","name":"personIds","schema":{"description":"Optional. If specified, results will be filtered to include only those containing the specified person ids.","items":{"format":"uuid","type":"string"},"nullable":true,"type":"array"}},{"description":"Optional. If specified, along with Person, results will be filtered to include only those containing the specified person and PersonType. Allows multiple, comma-delimited.","in":"query","name":"personTypes","schema":{"description":"Optional. If specified, along with Person, results will be filtered to include only those containing the specified person and PersonType. Allows multiple, comma-delimited.","items":{"type":"string"},"nullable":true,"type":"array"}},{"description":"Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited.","in":"query","name":"studios","schema":{"description":"Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited.","items":{"type":"string"},"nullable":true,"type":"array"}},{"description":"Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimited.","in":"query","name":"studioIds","schema":{"description":"Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimited.","items":{"format":"uuid","type":"string"},"nullable":true,"type":"array"}},{"description":"User id.","in":"query","name":"userId","schema":{"description":"User id.","format":"uuid","nullable":true,"type":"string"}},{"description":"Optional filter by items whose name is sorted equally or greater than a given input string.","in":"query","name":"nameStartsWithOrGreater","schema":{"description":"Optional filter by items whose name is sorted equally or greater than a given input string.","nullable":true,"type":"string"}},{"description":"Optional filter by items whose name is sorted equally than a given input string.","in":"query","name":"nameStartsWith","schema":{"description":"Optional filter by items whose name is sorted equally than a given input string.","nullable":true,"type":"string"}},{"description":"Optional filter by items whose name is equally or lesser than a given input string.","in":"query","name":"nameLessThan","schema":{"description":"Optional filter by items whose name is equally or lesser than a given input string.","nullable":true,"type":"string"}},{"description":"Optional, include image information in output.","in":"query","name":"enableImages","schema":{"default":true,"description":"Optional, include image information in output.","nullable":true,"type":"boolean"}},{"description":"Total record count.","in":"query","name":"enableTotalRecordCount","schema":{"default":true,"description":"Total record count.","type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseItemDtoQueryResult"}},"application/json; profile=\"CamelCase\"":{"schema":{"$ref":"#/components/schemas/BaseItemDtoQueryResult"}},"application/json; profile=\"PascalCase\"":{"schema":{"$ref":"#/components/schemas/BaseItemDtoQueryResult"}}},"description":"Artists returned."},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"security":[{"CustomAuthentication":[]}],"summary":"Gets all artists from a given item, folder, or the entire library.","tags":["Artists"]}},"/Artists/AlbumArtists":{"get":{"operationId":"GetAlbumArtists","parameters":[{"description":"Optional filter by minimum community rating.","in":"query","name":"minCommunityRating","schema":{"description":"Optional filter by minimum community rating.","format":"double","nullable":true,"type":"number"}},{"description":"Optional. The record index to start at. All items with a lower index will be dropped from the results.","in":"query","name":"startIndex","schema":{"description":"Optional. The record index to start at. All items with a lower index will be dropped from the results.","format":"int32","nullable":true,"type":"integer"}},{"description":"Optional. The maximum number of records to return.","in":"query","name":"limit","schema":{"description":"Optional. The maximum number of records to return.","format":"int32","nullable":true,"type":"integer"}},{"description":"Optional. Search term.","in":"query","name":"searchTerm","schema":{"description":"Optional. Search term.","nullable":true,"type":"string"}},{"description":"Specify this to localize the search to a specific item or folder. Omit to use the root.","in":"query","name":"parentId","schema":{"description":"Specify this to localize the search to a specific item or folder. Omit to use the root.","format":"uuid","nullable":true,"type":"string"}},{"description":"Optional. Specify additional fields of information to return in the output.","in":"query","name":"fields","schema":{"description":"Optional. Specify additional fields of information to return in the output.","items":{"$ref":"#/components/schemas/ItemFields"},"nullable":true,"type":"array"}},{"description":"Optional. If specified, results will be filtered out based on item type. This allows multiple, comma delimited.","in":"query","name":"excludeItemTypes","schema":{"description":"Optional. If specified, results will be filtered out based on item type. This allows multiple, comma delimited.","items":{"type":"string"},"nullable":true,"type":"array"}},{"description":"Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.","in":"query","name":"includeItemTypes","schema":{"description":"Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.","items":{"type":"string"},"nullable":true,"type":"array"}},{"description":"Optional. Specify additional filters to apply.","in":"query","name":"filters","schema":{"description":"Optional. Specify additional filters to apply.","items":{"$ref":"#/components/schemas/ItemFilter"},"nullable":true,"type":"array"}},{"description":"Optional filter by items that are marked as favorite, or not.","in":"query","name":"isFavorite","schema":{"description":"Optional filter by items that are marked as favorite, or not.","nullable":true,"type":"boolean"}},{"description":"Optional filter by MediaType. Allows multiple, comma delimited.","in":"query","name":"mediaTypes","schema":{"description":"Optional filter by MediaType. Allows multiple, comma delimited.","items":{"type":"string"},"nullable":true,"type":"array"}},{"description":"Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.","in":"query","name":"genres","schema":{"description":"Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.","items":{"type":"string"},"nullable":true,"type":"array"}},{"description":"Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.","in":"query","name":"genreIds","schema":{"description":"Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.","items":{"format":"uuid","type":"string"},"nullable":true,"type":"array"}},{"description":"Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.","in":"query","name":"officialRatings","schema":{"description":"Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.","items":{"type":"string"},"nullable":true,"type":"array"}},{"description":"Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited.","in":"query","name":"tags","schema":{"description":"Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited.","items":{"type":"string"},"nullable":true,"type":"array"}},{"description":"Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimited.","in":"query","name":"years","schema":{"description":"Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimited.","items":{"format":"int32","type":"integer"},"nullable":true,"type":"array"}},{"description":"Optional, include user data.","in":"query","name":"enableUserData","schema":{"description":"Optional, include user data.","nullable":true,"type":"boolean"}},{"description":"Optional, the max number of images to return, per image type.","in":"query","name":"imageTypeLimit","schema":{"description":"Optional, the max number of images to return, per image type.","format":"int32","nullable":true,"type":"integer"}},{"description":"Optional. The image types to include in the output.","in":"query","name":"enableImageTypes","schema":{"description":"Optional. The image types to include in the output.","items":{"$ref":"#/components/schemas/ImageType"},"nullable":true,"type":"array"}},{"description":"Optional. If specified, results will be filtered to include only those containing the specified person.","in":"query","name":"person","schema":{"description":"Optional. If specified, results will be filtered to include only those containing the specified person.","nullable":true,"type":"string"}},{"description":"Optional. If specified, results will be filtered to include only those containing the specified person ids.","in":"query","name":"personIds","schema":{"description":"Optional. If specified, results will be filtered to include only those containing the specified person ids.","items":{"format":"uuid","type":"string"},"nullable":true,"type":"array"}},{"description":"Optional. If specified, along with Person, results will be filtered to include only those containing the specified person and PersonType. Allows multiple, comma-delimited.","in":"query","name":"personTypes","schema":{"description":"Optional. If specified, along with Person, results will be filtered to include only those containing the specified person and PersonType. Allows multiple, comma-delimited.","items":{"type":"string"},"nullable":true,"type":"array"}},{"description":"Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited.","in":"query","name":"studios","schema":{"description":"Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited.","items":{"type":"string"},"nullable":true,"type":"array"}},{"description":"Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimited.","in":"query","name":"studioIds","schema":{"description":"Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimited.","items":{"format":"uuid","type":"string"},"nullable":true,"type":"array"}},{"description":"User id.","in":"query","name":"userId","schema":{"description":"User id.","format":"uuid","nullable":true,"type":"string"}},{"description":"Optional filter by items whose name is sorted equally or greater than a given input string.","in":"query","name":"nameStartsWithOrGreater","schema":{"description":"Optional filter by items whose name is sorted equally or greater than a given input string.","nullable":true,"type":"string"}},{"description":"Optional filter by items whose name is sorted equally than a given input string.","in":"query","name":"nameStartsWith","schema":{"description":"Optional filter by items whose name is sorted equally than a given input string.","nullable":true,"type":"string"}},{"description":"Optional filter by items whose name is equally or lesser than a given input string.","in":"query","name":"nameLessThan","schema":{"description":"Optional filter by items whose name is equally or lesser than a given input string.","nullable":true,"type":"string"}},{"description":"Optional, include image information in output.","in":"query","name":"enableImages","schema":{"default":true,"description":"Optional, include image information in output.","nullable":true,"type":"boolean"}},{"description":"Total record count.","in":"query","name":"enableTotalRecordCount","schema":{"default":true,"description":"Total record count.","type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseItemDtoQueryResult"}},"application/json; profile=\"CamelCase\"":{"schema":{"$ref":"#/components/schemas/BaseItemDtoQueryResult"}},"application/json; profile=\"PascalCase\"":{"schema":{"$ref":"#/components/schemas/BaseItemDtoQueryResult"}}},"description":"Album artists returned."},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"security":[{"CustomAuthentication":[]}],"summary":"Gets all album artists from a given item, folder, or the entire library.","tags":["Artists"]}},"/Artists/{id}/InstantMix":{"get":{"operationId":"GetInstantMixFromArtists","parameters":[{"description":"The item id.","in":"path","name":"id","required":true,"schema":{"description":"The item id.","format":"uuid","type":"string"}},{"description":"Optional. Filter by user id, and attach user data.","in":"query","name":"userId","schema":{"description":"Optional. Filter by user id, and attach user data.","format":"uuid","nullable":true,"type":"string"}},{"description":"Optional. The maximum number of records to return.","in":"query","name":"limit","schema":{"description":"Optional. The maximum number of records to return.","format":"int32","nullable":true,"type":"integer"}},{"description":"Optional. Specify additional fields of information to return in the output.","in":"query","name":"fields","schema":{"description":"Optional. Specify additional fields of information to return in the output.","items":{"$ref":"#/components/schemas/ItemFields"},"nullable":true,"type":"array"}},{"description":"Optional. Include image information in output.","in":"query","name":"enableImages","schema":{"description":"Optional. Include image information in output.","nullable":true,"type":"boolean"}},{"description":"Optional. Include user data.","in":"query","name":"enableUserData","schema":{"description":"Optional. Include user data.","nullable":true,"type":"boolean"}},{"description":"Optional. The max number of images to return, per image type.","in":"query","name":"imageTypeLimit","schema":{"description":"Optional. The max number of images to return, per image type.","format":"int32","nullable":true,"type":"integer"}},{"description":"Optional. The image types to include in the output.","in":"query","name":"enableImageTypes","schema":{"description":"Optional. The image types to include in the output.","items":{"$ref":"#/components/schemas/ImageType"},"nullable":true,"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseItemDtoQueryResult"}},"application/json; profile=\"CamelCase\"":{"schema":{"$ref":"#/components/schemas/BaseItemDtoQueryResult"}},"application/json; profile=\"PascalCase\"":{"schema":{"$ref":"#/components/schemas/BaseItemDtoQueryResult"}}},"description":"Instant playlist returned."},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"security":[{"CustomAuthentication":[]}],"summary":"Creates an instant playlist based on a given song.","tags":["InstantMix"]}},"/Artists/{itemId}/Similar":{"get":{"operationId":"GetSimilarArtists","parameters":[{"description":"The item id.","in":"path","name":"itemId","required":true,"schema":{"description":"The item id.","format":"uuid","type":"string"}},{"description":"Exclude artist ids.","in":"query","name":"excludeArtistIds","schema":{"description":"Exclude artist ids.","items":{"format":"uuid","type":"string"},"nullable":true,"type":"array"}},{"description":"Optional. Filter by user id, and attach user data.","in":"query","name":"userId","schema":{"description":"Optional. Filter by user id, and attach user data.","format":"uuid","nullable":true,"type":"string"}},{"description":"Optional. The maximum number of records to return.","in":"query","name":"limit","schema":{"description":"Optional. The maximum number of records to return.","format":"int32","nullable":true,"type":"integer"}},{"description":"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.","in":"query","name":"fields","schema":{"description":"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.","items":{"$ref":"#/components/schemas/ItemFields"},"nullable":true,"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseItemDtoQueryResult"}},"application/json; profile=\"CamelCase\"":{"schema":{"$ref":"#/components/schemas/BaseItemDtoQueryResult"}},"application/json; profile=\"PascalCase\"":{"schema":{"$ref":"#/components/schemas/BaseItemDtoQueryResult"}}},"description":"Similar items returned."},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"security":[{"CustomAuthentication":[]}],"summary":"Gets similar items.","tags":["Library"]}},"/Artists/{name}":{"get":{"operationId":"GetArtistByName","parameters":[{"description":"Studio name.","in":"path","name":"name","required":true,"schema":{"description":"Studio name.","type":"string"}},{"description":"Optional. Filter by user id, and attach user data.","in":"query","name":"userId","schema":{"description":"Optional. Filter by user id, and attach user data.","format":"uuid","nullable":true,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseItemDto"}},"application/json; profile=\"CamelCase\"":{"schema":{"$ref":"#/components/schemas/BaseItemDto"}},"application/json; profile=\"PascalCase\"":{"schema":{"$ref":"#/components/schemas/BaseItemDto"}}},"description":"Artist returned."},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"security":[{"CustomAuthentication":[]}],"summary":"Gets an artist by name.","tags":["Artists"]}},"/Artists/{name}/Images/{imageType}/{imageIndex}":{"get":{"operationId":"GetArtistImage","parameters":[{"description":"Artist name.","in":"path","name":"name","required":true,"schema":{"description":"Artist name.","type":"string"}},{"description":"Image type.","in":"path","name":"imageType","required":true,"schema":{"$ref":"#/components/schemas/ImageType"}},{"description":"Optional. Supply the cache tag from the item object to receive strong caching headers.","in":"query","name":"tag","schema":{"description":"Optional. Supply the cache tag from the item object to receive strong caching headers.","nullable":true,"type":"string"}},{"description":"Determines the output format of the image - original,gif,jpg,png.","in":"query","name":"format","schema":{"$ref":"#/components/schemas/ImageFormat"}},{"description":"The maximum image width to return.","in":"query","name":"maxWidth","schema":{"description":"The maximum image width to return.","format":"int32","nullable":true,"type":"integer"}},{"description":"The maximum image height to return.","in":"query","name":"maxHeight","schema":{"description":"The maximum image height to return.","format":"int32","nullable":true,"type":"integer"}},{"description":"Optional. Percent to render for the percent played overlay.","in":"query","name":"percentPlayed","schema":{"description":"Optional. Percent to render for the percent played overlay.","format":"double","nullable":true,"type":"number"}},{"description":"Optional. Unplayed count overlay to render.","in":"query","name":"unplayedCount","schema":{"description":"Optional. Unplayed count overlay to render.","format":"int32","nullable":true,"type":"integer"}},{"description":"The fixed image width to return.","in":"query","name":"width","schema":{"description":"The fixed image width to return.","format":"int32","nullable":true,"type":"integer"}},{"description":"The fixed image height to return.","in":"query","name":"height","schema":{"description":"The fixed image height to return.","format":"int32","nullable":true,"type":"integer"}},{"description":"Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.","in":"query","name":"quality","schema":{"description":"Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.","format":"int32","nullable":true,"type":"integer"}},{"description":"Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.","in":"query","name":"cropWhitespace","schema":{"description":"Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.","nullable":true,"type":"boolean"}},{"description":"Optional. Add a played indicator.","in":"query","name":"addPlayedIndicator","schema":{"description":"Optional. Add a played indicator.","nullable":true,"type":"boolean"}},{"description":"Optional. Blur image.","in":"query","name":"blur","schema":{"description":"Optional. Blur image.","format":"int32","nullable":true,"type":"integer"}},{"description":"Optional. Apply a background color for transparent images.","in":"query","name":"backgroundColor","schema":{"description":"Optional. Apply a background color for transparent images.","nullable":true,"type":"string"}},{"description":"Optional. Apply a foreground layer on top of the image.","in":"query","name":"foregroundLayer","schema":{"description":"Optional. Apply a foreground layer on top of the image.","nullable":true,"type":"string"}},{"description":"Image index.","in":"path","name":"imageIndex","required":true,"schema":{"description":"Image index.","format":"int32","type":"integer"}}],"responses":{"200":{"content":{"image/*":{"schema":{"format":"binary","type":"string"}}},"description":"Image stream returned."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}},"application/json; profile=\"CamelCase\"":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}},"application/json; profile=\"PascalCase\"":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}},"description":"Item not found."}},"summary":"Get artist image by name.","tags":["Image"]},"head":{"operationId":"HeadArtistImage","parameters":[{"description":"Artist name.","in":"path","name":"name","required":true,"schema":{"description":"Artist name.","type":"string"}},{"description":"Image type.","in":"path","name":"imageType","required":true,"schema":{"$ref":"#/components/schemas/ImageType"}},{"description":"Optional. Supply the cache tag from the item object to receive strong caching headers.","in":"query","name":"tag","schema":{"description":"Optional. Supply the cache tag from the item object to receive strong caching headers.","nullable":true,"type":"string"}},{"description":"Determines the output format of the image - original,gif,jpg,png.","in":"query","name":"format","schema":{"$ref":"#/components/schemas/ImageFormat"}},{"description":"The maximum image width to return.","in":"query","name":"maxWidth","schema":{"description":"The maximum image width to return.","format":"int32","nullable":true,"type":"integer"}},{"description":"The maximum image height to return.","in":"query","name":"maxHeight","schema":{"description":"The maximum image height to return.","format":"int32","nullable":true,"type":"integer"}},{"description":"Optional. Percent to render for the percent played overlay.","in":"query","name":"percentPlayed","schema":{"description":"Optional. Percent to render for the percent played overlay.","format":"double","nullable":true,"type":"number"}},{"description":"Optional. Unplayed count overlay to render.","in":"query","name":"unplayedCount","schema":{"description":"Optional. Unplayed count overlay to render.","format":"int32","nullable":true,"type":"integer"}},{"description":"The fixed image width to return.","in":"query","name":"width","schema":{"description":"The fixed image width to return.","format":"int32","nullable":true,"type":"integer"}},{"description":"The fixed image height to return.","in":"query","name":"height","schema":{"description":"The fixed image height to return.","format":"int32","nullable":true,"type":"integer"}},{"description":"Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.","in":"query","name":"quality","schema":{"description":"Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.","format":"int32","nullable":true,"type":"integer"}},{"description":"Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.","in":"query","name":"cropWhitespace","schema":{"description":"Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.","nullable":true,"type":"boolean"}},{"description":"Optional. Add a played indicator.","in":"query","name":"addPlayedIndicator","schema":{"description":"Optional. Add a played indicator.","nullable":true,"type":"boolean"}},{"description":"Optional. Blur image.","in":"query","name":"blur","schema":{"description":"Optional. Blur image.","format":"int32","nullable":true,"type":"integer"}},{"description":"Optional. Apply a background color for transparent images.","in":"query","name":"backgroundColor","schema":{"description":"Optional. Apply a background color for transparent images.","nullable":true,"type":"string"}},{"description":"Optional. Apply a foreground layer on top of the image.","in":"query","name":"foregroundLayer","schema":{"description":"Optional. Apply a foreground layer on top of the image.","nullable":true,"type":"string"}},{"description":"Image index.","in":"path","name":"imageIndex","required":true,"schema":{"description":"Image index.","format":"int32","type":"integer"}}],"responses":{"200":{"content":{"image/*":{"schema":{"format":"binary","type":"string"}}},"description":"Image stream returned."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}},"application/json; profile=\"CamelCase\"":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}},"application/json; profile=\"PascalCase\"":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}},"description":"Item not found."}},"summary":"Get artist image by name.","tags":["Image"]}},"/Audio/{itemId}/hls/{segmentId}/stream.aac":{"get":{"operationId":"GetHlsAudioSegmentLegacyAac","parameters":[{"description":"The item id.","in":"path","name":"itemId","required":true,"schema":{"description":"The item id.","type":"string"}},{"description":"The segment id.","in":"path","name":"segmentId","required":true,"schema":{"description":"The segment id.","type":"string"}}],"responses":{"200":{"content":{"audio/*":{"schema":{"format":"binary","type":"string"}}},"description":"Hls audio segment returned."}},"summary":"Gets the specified audio segment for an audio item.","tags":["HlsSegment"]}},"/Audio/{itemId}/hls/{segmentId}/stream.mp3":{"get":{"operationId":"GetHlsAudioSegmentLegacyMp3","parameters":[{"description":"The item id.","in":"path","name":"itemId","required":true,"schema":{"description":"The item id.","type":"string"}},{"description":"The segment id.","in":"path","name":"segmentId","required":true,"schema":{"description":"The segment id.","type":"string"}}],"responses":{"200":{"content":{"audio/*":{"schema":{"format":"binary","type":"string"}}},"description":"Hls audio segment returned."}},"summary":"Gets the specified audio segment for an audio item.","tags":["HlsSegment"]}},"/Audio/{itemId}/hls1/{playlistId}/{segmentId}.{container}":{"get":{"operationId":"GetHlsAudioSegment","parameters":[{"description":"The item id.","in":"path","name":"itemId","required":true,"schema":{"description":"The item id.","format":"uuid","type":"string"}},{"description":"The playlist id.","in":"path","name":"playlistId","required":true,"schema":{"description":"The playlist id.","type":"string"}},{"description":"The segment id.","in":"path","name":"segmentId","required":true,"schema":{"description":"The segment id.","format":"int32","type":"integer"}},{"description":"The video container. Possible values are: ts, webm, asf, wmv, ogv, mp4, m4v, mkv, mpeg, mpg, avi, 3gp, wmv, wtv, m2ts, mov, iso, flv.","in":"path","name":"container","required":true,"schema":{"description":"The video container. Possible values are: ts, webm, asf, wmv, ogv, mp4, m4v, mkv, mpeg, mpg, avi, 3gp, wmv, wtv, m2ts, mov, iso, flv.","type":"string"}},{"description":"Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false.","in":"query","name":"static","schema":{"description":"Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false.","nullable":true,"type":"boolean"}},{"description":"The streaming parameters.","in":"query","name":"params","schema":{"description":"The streaming parameters.","nullable":true,"type":"string"}},{"description":"The tag.","in":"query","name":"tag","schema":{"description":"The tag.","nullable":true,"type":"string"}},{"description":"Optional. The dlna device profile id to utilize.","in":"query","name":"deviceProfileId","schema":{"description":"Optional. The dlna device profile id to utilize.","nullable":true,"type":"string"}},{"description":"The play session id.","in":"query","name":"playSessionId","schema":{"description":"The play session id.","nullable":true,"type":"string"}},{"description":"The segment container.","in":"query","name":"segmentContainer","schema":{"description":"The segment container.","nullable":true,"type":"string"}},{"description":"The segment length.","in":"query","name":"segmentLength","schema":{"description":"The segment length.","format":"int32","nullable":true,"type":"integer"}},{"description":"The minimum number of segments.","in":"query","name":"minSegments","schema":{"description":"The minimum number of segments.","format":"int32","nullable":true,"type":"integer"}},{"description":"The media version id, if playing an alternate version.","in":"query","name":"mediaSourceId","schema":{"description":"The media version id, if playing an alternate version.","nullable":true,"type":"string"}},{"description":"The device id of the client requesting. Used to stop encoding processes when needed.","in":"query","name":"deviceId","schema":{"description":"The device id of the client requesting. Used to stop encoding processes when needed.","nullable":true,"type":"string"}},{"description":"Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. Options: aac, mp3, vorbis, wma.","in":"query","name":"audioCodec","schema":{"description":"Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. Options: aac, mp3, vorbis, wma.","nullable":true,"type":"string"}},{"description":"Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.","in":"query","name":"enableAutoStreamCopy","schema":{"description":"Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.","nullable":true,"type":"boolean"}},{"description":"Whether or not to allow copying of the video stream url.","in":"query","name":"allowVideoStreamCopy","schema":{"description":"Whether or not to allow copying of the video stream url.","nullable":true,"type":"boolean"}},{"description":"Whether or not to allow copying of the audio stream url.","in":"query","name":"allowAudioStreamCopy","schema":{"description":"Whether or not to allow copying of the audio stream url.","nullable":true,"type":"boolean"}},{"description":"Optional. Whether to break on non key frames.","in":"query","name":"breakOnNonKeyFrames","schema":{"description":"Optional. Whether to break on non key frames.","nullable":true,"type":"boolean"}},{"description":"Optional. Specify a specific audio sample rate, e.g. 44100.","in":"query","name":"audioSampleRate","schema":{"description":"Optional. Specify a specific audio sample rate, e.g. 44100.","format":"int32","nullable":true,"type":"integer"}},{"description":"Optional. The maximum audio bit depth.","in":"query","name":"maxAudioBitDepth","schema":{"description":"Optional. The maximum audio bit depth.","format":"int32","nullable":true,"type":"integer"}},{"description":"Optional. The maximum streaming bitrate.","in":"query","name":"maxStreamingBitrate","schema":{"description":"Optional. The maximum streaming bitrate.","format":"int32","nullable":true,"type":"integer"}},{"description":"Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.","in":"query","name":"audioBitRate","schema":{"description":"Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.","format":"int32","nullable":true,"type":"integer"}},{"description":"Optional. Specify a specific number of audio channels to encode to, e.g. 2.","in":"query","name":"audioChannels","schema":{"description":"Optional. Specify a specific number of audio channels to encode to, e.g. 2.","format":"int32","nullable":true,"type":"integer"}},{"description":"Optional. Specify a maximum number of audio channels to encode to, e.g. 2.","in":"query","name":"maxAudioChannels","schema":{"description":"Optional. Specify a maximum number of audio channels to encode to, e.g. 2.","format":"int32","nullable":true,"type":"integer"}},{"description":"Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.","in":"query","name":"profile","schema":{"description":"Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.","nullable":true,"type":"string"}},{"description":"Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.","in":"query","name":"level","schema":{"description":"Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.","nullable":true,"type":"string"}},{"description":"Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.","in":"query","name":"framerate","schema":{"description":"Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.","format":"float","nullable":true,"type":"number"}},{"description":"Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.","in":"query","name":"maxFramerate","schema":{"description":"Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.","format":"float","nullable":true,"type":"number"}},{"description":"Whether or not to copy timestamps when transcoding with an offset. Defaults to false.","in":"query","name":"copyTimestamps","schema":{"description":"Whether or not to copy timestamps when transcoding with an offset. Defaults to false.","nullable":true,"type":"boolean"}},{"description":"Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms.","in":"query","name":"startTimeTicks","schema":{"description":"Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms.","format":"int64","nullable":true,"type":"integer"}},{"description":"Optional. The fixed horizontal resolution of the encoded video.","in":"query","name":"width","schema":{"description":"Optional. The fixed horizontal resolution of the encoded video.","format":"int32","nullable":true,"type":"integer"}},{"description":"Optional. The fixed vertical resolution of the encoded video.","in":"query","name":"height","schema":{"description":"Optional. The fixed vertical resolution of the encoded video.","format":"int32","nullable":true,"type":"integer"}},{"description":"Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.","in":"query","name":"videoBitRate","schema":{"description":"Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.","format":"int32","nullable":true,"type":"integer"}},{"description":"Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.","in":"query","name":"subtitleStreamIndex","schema":{"description":"Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.","format":"int32","nullable":true,"type":"integer"}},{"description":"Optional. Specify the subtitle delivery method.","in":"query","name":"subtitleMethod","schema":{"$ref":"#/components/schemas/SubtitleDeliveryMethod"}},{"description":"Optional.","in":"query","name":"maxRefFrames","schema":{"description":"Optional.","format":"int32","nullable":true,"type":"integer"}},{"description":"Optional. The maximum video bit depth.","in":"query","name":"maxVideoBitDepth","schema":{"description":"Optional. The maximum video bit depth.","format":"int32","nullable":true,"type":"integer"}},{"description":"Optional. Whether to require avc.","in":"query","name":"requireAvc","schema":{"description":"Optional. Whether to require avc.","nullable":true,"type":"boolean"}},{"description":"Optional. Whether to deinterlace the video.","in":"query","name":"deInterlace","schema":{"description":"Optional. Whether to deinterlace the video.","nullable":true,"type":"boolean"}},{"description":"Optional. Whether to require a non anamorphic stream.","in":"query","name":"requireNonAnamorphic","schema":{"description":"Optional. Whether to require a non anamorphic stream.","nullable":true,"type":"boolean"}},{"description":"Optional. The maximum number of audio channels to transcode.","in":"query","name":"transcodingMaxAudioChannels","schema":{"description":"Optional. The maximum number of audio channels to transcode.","format":"int32","nullable":true,"type":"integer"}},{"description":"Optional. The limit of how many cpu cores to use.","in":"query","name":"cpuCoreLimit","schema":{"description":"Optional. The limit of how many cpu cores to use.","format