action jellyfin_get_artist_by_name { label: "Gets an artist by name." provider: jellyfin method: GET path: "/Artists/{name}" encoding: json input: { type: "object" properties: { name: { type: "string" description: "Studio name." } userId: { type: "string" format: "uuid" description: "Optional. Filter by user id, and attach user data." } } required: ["name"] additionalProperties: false } output: { type: "object" description: "This is strictly used as a data transfer object from the api layer. \nThis holds information about a BaseItem in a format that is convenient for the client." properties: { AirDays: { type: "array" description: "Gets or sets the air days." items: { type: "string" enum: ["Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday"] } } AirTime: { type: "string" description: "Gets or sets the air time." } AirsAfterSeasonNumber: { type: "integer" format: "int32" } AirsBeforeEpisodeNumber: { type: "integer" format: "int32" } AirsBeforeSeasonNumber: { type: "integer" format: "int32" } Album: { type: "string" description: "Gets or sets the album." } AlbumArtist: { type: "string" description: "Gets or sets the album artist." } AlbumArtists: { type: "array" description: "Gets or sets the album artists." items: { type: "object" properties: { Id: { type: "string" format: "uuid" } Name: { type: "string" } } additionalProperties: false } } AlbumCount: { type: "integer" format: "int32" description: "Gets or sets the album count." } AlbumId: { type: "string" format: "uuid" description: "Gets or sets the album id." } AlbumPrimaryImageTag: { type: "string" description: "Gets or sets the album image tag." } Altitude: { type: "number" format: "double" } Aperture: { type: "number" format: "double" } ArtistCount: { type: "integer" format: "int32" } ArtistItems: { type: "array" description: "Gets or sets the artist items." items: { type: "object" additionalProperties: true } } Artists: { type: "array" description: "Gets or sets the artists." items: { type: "string" } } AspectRatio: { type: "string" description: "Gets or sets the aspect ratio." } Audio: { type: "string" enum: ["Mono", "Stereo", "Dolby", "DolbyDigital", "Thx", "Atmos"] } BackdropImageTags: { type: "array" description: "Gets or sets the backdrop image tags." items: { type: "string" } } CameraMake: { type: "string" } CameraModel: { type: "string" } CanDelete: { type: "boolean" } CanDownload: { type: "boolean" } ChannelId: { type: "string" format: "uuid" description: "Gets or sets the channel identifier." } ChannelName: { type: "string" } ChannelNumber: { type: "string" } ChannelPrimaryImageTag: { type: "string" description: "Gets or sets the channel primary image tag." } ChannelType: { type: "string" description: "Enum ChannelType." enum: ["TV", "Radio"] } Chapters: { type: "array" description: "Gets or sets the chapters." items: { type: "object" description: "Class ChapterInfo." properties: { ImageDateModified: { type: "string" format: "date-time" } ImagePath: { type: "string" description: "Gets or sets the image path." } ImageTag: { type: "string" } Name: { type: "string" description: "Gets or sets the name." } StartPositionTicks: { type: "integer" format: "int64" description: "Gets or sets the start position ticks." } } additionalProperties: false } } ChildCount: { type: "integer" format: "int32" description: "Gets or sets the child count." } CollectionType: { type: "string" description: "Gets or sets the type of the collection." } CommunityRating: { type: "number" format: "float" description: "Gets or sets the community rating." } CompletionPercentage: { type: "number" format: "double" description: "Gets or sets the completion percentage." } Container: { type: "string" } CriticRating: { type: "number" format: "float" description: "Gets or sets the critic rating." } CumulativeRunTimeTicks: { type: "integer" format: "int64" description: "Gets or sets the cumulative run time ticks." } CurrentProgram: { type: "object" additionalProperties: true } CustomRating: { type: "string" description: "Gets or sets the custom rating." } DateCreated: { type: "string" format: "date-time" description: "Gets or sets the date created." } DateLastMediaAdded: { type: "string" format: "date-time" } DisplayOrder: { type: "string" description: "Gets or sets the display order." } DisplayPreferencesId: { type: "string" description: "Gets or sets the display preferences id." } EnableMediaSourceDisplay: { type: "boolean" } EndDate: { type: "string" format: "date-time" description: "Gets or sets the end date." } EpisodeCount: { type: "integer" format: "int32" description: "Gets or sets the episode count." } EpisodeTitle: { type: "string" description: "Gets or sets the episode title." } Etag: { type: "string" description: "Gets or sets the etag." } ExposureTime: { type: "number" format: "double" } ExternalUrls: { type: "array" description: "Gets or sets the external urls." items: { type: "object" properties: { Name: { type: "string" description: "Gets or sets the name." } Url: { type: "string" description: "Gets or sets the type of the item." } } additionalProperties: false } } ExtraType: { type: "string" } FocalLength: { type: "number" format: "double" } ForcedSortName: { type: "string" } GenreItems: { type: "array" items: { type: "object" additionalProperties: true } } Genres: { type: "array" description: "Gets or sets the genres." items: { type: "string" } } HasSubtitles: { type: "boolean" } Height: { type: "integer" format: "int32" } Id: { type: "string" format: "uuid" description: "Gets or sets the id." } ImageBlurHashes: { type: "object" description: "Gets or sets the blurhashes for the image tags. \nMaps image type to dictionary mapping image tag to blurhash value." properties: { Art: { type: "object" } Backdrop: { type: "object" } Banner: { type: "object" } Box: { type: "object" } BoxRear: { type: "object" } Chapter: { type: "object" } Disc: { type: "object" } Logo: { type: "object" } Menu: { type: "object" } Primary: { type: "object" } Profile: { type: "object" } Screenshot: { type: "object" } Thumb: { type: "object" } } } ImageOrientation: { type: "string" enum: ["TopLeft", "TopRight", "BottomRight", "BottomLeft", "LeftTop", "RightTop", "RightBottom", "LeftBottom"] } ImageTags: { type: "object" description: "Gets or sets the image tags." } IndexNumber: { type: "integer" format: "int32" description: "Gets or sets the index number." } IndexNumberEnd: { type: "integer" format: "int32" description: "Gets or sets the index number end." } IsFolder: { type: "boolean" description: "Gets or sets a value indicating whether this instance is folder." } IsHD: { type: "boolean" description: "Gets or sets a value indicating whether this instance is HD." } IsKids: { type: "boolean" description: "Gets or sets a value indicating whether this instance is kids." } IsLive: { type: "boolean" description: "Gets or sets a value indicating whether this instance is live." } IsMovie: { type: "boolean" description: "Gets or sets a value indicating whether this instance is movie." } IsNews: { type: "boolean" description: "Gets or sets a value indicating whether this instance is news." } IsPlaceHolder: { type: "boolean" description: "Gets or sets a value indicating whether this instance is place holder." } IsPremiere: { type: "boolean" description: "Gets or sets a value indicating whether this instance is premiere." } IsRepeat: { type: "boolean" description: "Gets or sets a value indicating whether this instance is repeat." } IsSeries: { type: "boolean" description: "Gets or sets a value indicating whether this instance is series." } IsSports: { type: "boolean" description: "Gets or sets a value indicating whether this instance is sports." } IsoSpeedRating: { type: "integer" format: "int32" } IsoType: { type: "string" description: "Enum IsoType." enum: ["Dvd", "BluRay"] } Latitude: { type: "number" format: "double" } LocalTrailerCount: { type: "integer" format: "int32" description: "Gets or sets the local trailer count." } LocationType: { type: "string" description: "Enum LocationType." enum: ["FileSystem", "Remote", "Virtual", "Offline"] } LockData: { type: "boolean" description: "Gets or sets a value indicating whether [enable internet providers]." } LockedFields: { type: "array" description: "Gets or sets the locked fields." items: { type: "string" description: "Enum MetadataFields." enum: ["Cast", "Genres", "ProductionLocations", "Studios", "Tags", "Name", "Overview", "Runtime", "OfficialRating"] } } Longitude: { type: "number" format: "double" } MediaSourceCount: { type: "integer" format: "int32" } MediaSources: { type: "array" description: "Gets or sets the media versions." items: { type: "object" properties: { AnalyzeDurationMs: { type: "integer" format: "int32" } Bitrate: { type: "integer" format: "int32" } BufferMs: { type: "integer" format: "int32" } Container: { type: "string" } DefaultAudioStreamIndex: { type: "integer" format: "int32" } DefaultSubtitleStreamIndex: { type: "integer" format: "int32" } ETag: { type: "string" } EncoderPath: { type: "string" } EncoderProtocol: { type: "string" enum: ["File", "Http", "Rtmp", "Rtsp", "Udp", "Rtp", "Ftp"] } Formats: { type: "array" items: { type: "string" } } GenPtsInput: { type: "boolean" } Id: { type: "string" } IgnoreDts: { type: "boolean" } IgnoreIndex: { type: "boolean" } IsInfiniteStream: { type: "boolean" } IsRemote: { type: "boolean" description: "Differentiate internet url vs local network." } IsoType: { type: "object" additionalProperties: true } LiveStreamId: { type: "string" } MediaAttachments: { type: "array" items: { type: "object" description: "Class MediaAttachment." properties: { Codec: { type: "string" description: "Gets or sets the codec." } CodecTag: { type: "string" description: "Gets or sets the codec tag." } Comment: { type: "string" description: "Gets or sets the comment." } DeliveryUrl: { type: "string" description: "Gets or sets the delivery URL." } FileName: { type: "string" description: "Gets or sets the filename." } Index: { type: "integer" format: "int32" description: "Gets or sets the index." } MimeType: { type: "string" description: "Gets or sets the MIME type." } } additionalProperties: false } } MediaStreams: { type: "array" items: { type: "object" description: "Class MediaStream." properties: { AspectRatio: { type: "string" description: "Gets or sets the aspect ratio." } AverageFrameRate: { type: "number" format: "float" description: "Gets or sets the average frame rate." } BitDepth: { type: "integer" format: "int32" description: "Gets or sets the bit depth." } BitRate: { type: "integer" format: "int32" description: "Gets or sets the bit rate." } ChannelLayout: { type: "string" description: "Gets or sets the channel layout." } Channels: { type: "integer" format: "int32" description: "Gets or sets the channels." } Codec: { type: "string" description: "Gets or sets the codec." } CodecTag: { type: "string" description: "Gets or sets the codec tag." } CodecTimeBase: { type: "string" description: "Gets or sets the codec time base." } ColorPrimaries: { type: "string" description: "Gets or sets the color primaries." } ColorRange: { type: "string" description: "Gets or sets the color range." } ColorSpace: { type: "string" description: "Gets or sets the color space." } ColorTransfer: { type: "string" description: "Gets or sets the color transfer." } Comment: { type: "string" description: "Gets or sets the comment." } DeliveryMethod: { type: "string" enum: ["Encode", "Embed", "External", "Hls"] } DeliveryUrl: { type: "string" description: "Gets or sets the delivery URL." } DisplayTitle: { type: "string" } Height: { type: "integer" format: "int32" description: "Gets or sets the height." } Index: { type: "integer" format: "int32" description: "Gets or sets the index." } IsAVC: { type: "boolean" } IsAnamorphic: { type: "boolean" description: "Gets a value indicating whether this instance is anamorphic." } IsDefault: { type: "boolean" description: "Gets or sets a value indicating whether this instance is default." } IsExternal: { type: "boolean" description: "Gets or sets a value indicating whether this instance is external." } IsExternalUrl: { type: "boolean" description: "Gets or sets a value indicating whether this instance is external URL." } IsForced: { type: "boolean" description: "Gets or sets a value indicating whether this instance is forced." } IsInterlaced: { type: "boolean" description: "Gets or sets a value indicating whether this instance is interlaced." } IsTextSubtitleStream: { type: "boolean" } Language: { type: "string" description: "Gets or sets the language." } Level: { type: "number" format: "double" description: "Gets or sets the level." } NalLengthSize: { type: "string" } PacketLength: { type: "integer" format: "int32" description: "Gets or sets the length of the packet." } Path: { type: "string" description: "Gets or sets the filename." } PixelFormat: { type: "string" description: "Gets or sets the pixel format." } Profile: { type: "string" description: "Gets or sets the profile." } RealFrameRate: { type: "number" format: "float" description: "Gets or sets the real frame rate." } RefFrames: { type: "integer" format: "int32" description: "Gets or sets the reference frames." } SampleRate: { type: "integer" format: "int32" description: "Gets or sets the sample rate." } Score: { type: "integer" format: "int32" description: "Gets or sets the score." } SupportsExternalStream: { type: "boolean" description: "Gets or sets a value indicating whether [supports external stream]." } TimeBase: { type: "string" description: "Gets or sets the time base." } Title: { type: "string" description: "Gets or sets the title." } Type: { type: "string" description: "Enum MediaStreamType." enum: ["Audio", "Video", "Subtitle", "EmbeddedImage"] } VideoRange: { type: "string" description: "Gets or sets the video range." } Width: { type: "integer" format: "int32" description: "Gets or sets the width." } localizedDefault: { type: "string" } localizedForced: { type: "string" } localizedUndefined: { type: "string" } } additionalProperties: false } } Name: { type: "string" } OpenToken: { type: "string" } Path: { type: "string" } Protocol: { type: "object" additionalProperties: true } ReadAtNativeFramerate: { type: "boolean" } RequiredHttpHeaders: { type: "object" } RequiresClosing: { type: "boolean" } RequiresLooping: { type: "boolean" } RequiresOpening: { type: "boolean" } RunTimeTicks: { type: "integer" format: "int64" } Size: { type: "integer" format: "int64" } SupportsDirectPlay: { type: "boolean" } SupportsDirectStream: { type: "boolean" } SupportsProbing: { type: "boolean" } SupportsTranscoding: { type: "boolean" } Timestamp: { type: "string" enum: ["None", "Zero", "Valid"] } TranscodingContainer: { type: "string" } TranscodingSubProtocol: { type: "string" } TranscodingUrl: { type: "string" } Type: { type: "string" enum: ["Default", "Grouping", "Placeholder"] } Video3DFormat: { type: "string" enum: ["HalfSideBySide", "FullSideBySide", "FullTopAndBottom", "HalfTopAndBottom", "MVC"] } VideoType: { type: "string" description: "Enum VideoType." enum: ["VideoFile", "Iso", "Dvd", "BluRay"] } } additionalProperties: false } } MediaStreams: { type: "array" description: "Gets or sets the media streams." items: { type: "object" additionalProperties: true } } MediaType: { type: "string" description: "Gets or sets the type of the media." } MovieCount: { type: "integer" format: "int32" description: "Gets or sets the movie count." } MusicVideoCount: { type: "integer" format: "int32" description: "Gets or sets the music video count." } Name: { type: "string" description: "Gets or sets the name." } Number: { type: "string" description: "Gets or sets the number." } OfficialRating: { type: "string" description: "Gets or sets the official rating." } OriginalTitle: { type: "string" } Overview: { type: "string" description: "Gets or sets the overview." } ParentArtImageTag: { type: "string" description: "Gets or sets the parent art image tag." } ParentArtItemId: { type: "string" description: "If the item does not have a art, this will hold the Id of the Parent that has one." } ParentBackdropImageTags: { type: "array" description: "Gets or sets the parent backdrop image tags." items: { type: "string" } } ParentBackdropItemId: { type: "string" description: "If the item does not have any backdrops, this will hold the Id of the Parent that has one." } ParentId: { type: "string" format: "uuid" description: "Gets or sets the parent id." } ParentIndexNumber: { type: "integer" format: "int32" description: "Gets or sets the parent index number." } ParentLogoImageTag: { type: "string" description: "Gets or sets the parent logo image tag." } ParentLogoItemId: { type: "string" description: "If the item does not have a logo, this will hold the Id of the Parent that has one." } ParentPrimaryImageItemId: { type: "string" description: "Gets or sets the parent primary image item identifier." } ParentPrimaryImageTag: { type: "string" description: "Gets or sets the parent primary image tag." } ParentThumbImageTag: { type: "string" description: "Gets or sets the parent thumb image tag." } ParentThumbItemId: { type: "string" description: "Gets or sets the parent thumb item id." } PartCount: { type: "integer" format: "int32" description: "Gets or sets the part count." } Path: { type: "string" description: "Gets or sets the path." } People: { type: "array" description: "Gets or sets the people." items: { type: "object" description: "This is used by the api to get information about a Person within a BaseItem." properties: { Id: { type: "string" description: "Gets or sets the identifier." } ImageBlurHashes: { type: "object" description: "Gets or sets the primary image blurhash." properties: { Art: { type: "object" } Backdrop: { type: "object" } Banner: { type: "object" } Box: { type: "object" } BoxRear: { type: "object" } Chapter: { type: "object" } Disc: { type: "object" } Logo: { type: "object" } Menu: { type: "object" } Primary: { type: "object" } Profile: { type: "object" } Screenshot: { type: "object" } Thumb: { type: "object" } } } Name: { type: "string" description: "Gets or sets the name." } PrimaryImageTag: { type: "string" description: "Gets or sets the primary image tag." } Role: { type: "string" description: "Gets or sets the role." } Type: { type: "string" description: "Gets or sets the type." } } additionalProperties: false } } PlayAccess: { type: "string" enum: ["Full", "None"] } PlaylistItemId: { type: "string" description: "Gets or sets the playlist item identifier." } PreferredMetadataCountryCode: { type: "string" } PreferredMetadataLanguage: { type: "string" } PremiereDate: { type: "string" format: "date-time" description: "Gets or sets the premiere date." } PrimaryImageAspectRatio: { type: "number" format: "double" description: "Gets or sets the primary image aspect ratio, after image enhancements." } ProductionLocations: { type: "array" items: { type: "string" } } ProductionYear: { type: "integer" format: "int32" description: "Gets or sets the production year." } ProgramCount: { type: "integer" format: "int32" } ProgramId: { type: "string" description: "Gets or sets the program identifier." } ProviderIds: { type: "object" description: "Gets or sets the provider ids." } RecursiveItemCount: { type: "integer" format: "int32" description: "Gets or sets the recursive item count." } RemoteTrailers: { type: "array" description: "Gets or sets the trailer urls." items: { type: "object" properties: { Name: { type: "string" } Url: { type: "string" } } additionalProperties: false } } RunTimeTicks: { type: "integer" format: "int64" description: "Gets or sets the run time ticks." } ScreenshotImageTags: { type: "array" description: "Gets or sets the screenshot image tags." items: { type: "string" } } SeasonId: { type: "string" format: "uuid" description: "Gets or sets the season identifier." } SeasonName: { type: "string" description: "Gets or sets the name of the season." } SeriesCount: { type: "integer" format: "int32" description: "Gets or sets the series count." } SeriesId: { type: "string" format: "uuid" description: "Gets or sets the series id." } SeriesName: { type: "string" description: "Gets or sets the name of the series." } SeriesPrimaryImageTag: { type: "string" description: "Gets or sets the series primary image tag." } SeriesStudio: { type: "string" description: "Gets or sets the series studio." } SeriesThumbImageTag: { type: "string" description: "Gets or sets the series thumb image tag." } SeriesTimerId: { type: "string" description: "Gets or sets the series timer identifier." } ServerId: { type: "string" description: "Gets or sets the server identifier." } ShutterSpeed: { type: "number" format: "double" } Software: { type: "string" } SongCount: { type: "integer" format: "int32" description: "Gets or sets the song count." } SortName: { type: "string" description: "Gets or sets the name of the sort." } SourceType: { type: "string" description: "Gets or sets the type of the source." } SpecialFeatureCount: { type: "integer" format: "int32" description: "Gets or sets the special feature count." } StartDate: { type: "string" format: "date-time" description: "The start date of the recording, in UTC." } Status: { type: "string" description: "Gets or sets the status." } Studios: { type: "array" description: "Gets or sets the studios." items: { type: "object" additionalProperties: true } } SupportsSync: { type: "boolean" description: "Gets or sets a value indicating whether [supports synchronize]." } Taglines: { type: "array" description: "Gets or sets the taglines." items: { type: "string" } } Tags: { type: "array" description: "Gets or sets the tags." items: { type: "string" } } TimerId: { type: "string" description: "Gets or sets the timer identifier." } TrailerCount: { type: "integer" format: "int32" description: "Gets or sets the trailer count." } Type: { type: "string" description: "Gets or sets the type." } UserData: { type: "object" description: "Class UserItemDataDto." properties: { IsFavorite: { type: "boolean" description: "Gets or sets a value indicating whether this instance is favorite." } ItemId: { type: "string" description: "Gets or sets the item identifier." } Key: { type: "string" description: "Gets or sets the key." } LastPlayedDate: { type: "string" format: "date-time" description: "Gets or sets the last played date." } Likes: { type: "boolean" description: "Gets or sets a value indicating whether this MediaBrowser.Model.Dto.UserItemDataDto is likes." } PlayCount: { type: "integer" format: "int32" description: "Gets or sets the play count." } PlaybackPositionTicks: { type: "integer" format: "int64" description: "Gets or sets the playback position ticks." } Played: { type: "boolean" description: "Gets or sets a value indicating whether this MediaBrowser.Model.Dto.UserItemDataDto is played." } PlayedPercentage: { type: "number" format: "double" description: "Gets or sets the played percentage." } Rating: { type: "number" format: "double" description: "Gets or sets the rating." } UnplayedItemCount: { type: "integer" format: "int32" description: "Gets or sets the unplayed item count." } } additionalProperties: false } Video3DFormat: { type: "object" additionalProperties: true } VideoType: { type: "object" additionalProperties: true } Width: { type: "integer" format: "int32" } } additionalProperties: false } }