本文档由新疆萌森软件开发工作室提供技术支持
- 官方模块
- System
- Gets activity log entries.
- Upload a document.
- Gets application configuration.
- Updates application configuration.
- Gets a named configuration.
- Updates named configuration.
- Updates branding configuration.
- Gets a default MetadataOptions object.
- Gets information about the request endpoint.
- Gets information about the server.
- Gets public information about the server.
- Gets information about the server.
- Gets a list of available server log files.
- Gets a log file.
- Pings the system.
- Pings the system.
- Restarts the application.
- Shuts down the application.
- Gets the current UTC time.
- Authentication
- Get all keys.GET
- Create a new api key.POST
- Remove an api key.DELETE
- Authorizes a pending quick connect request.POST
- Attempts to retrieve authentication information.GET
- Gets the current quick connect state.GET
- Initiate a new quick connect request.POST
- Get all password reset providers.GET
- Get all auth providers.GET
- Authenticates a user by name.POST
- Authenticates a user with quick connect.POST
- Initiates the forgot password process for a local user.POST
- Redeems a forgot password pin.POST
- Get all keys.
- Artist
- Audio
- Backup
- Branding
- Channel
- Collection
- Plugin
- Gets a dashboard configuration page.
- Gets the configuration pages.
- Gets available packages.
- Gets a package by name or assembly GUID.
- Installs a package.
- Cancels a package installation.
- Gets all package repositories.
- Sets the enabled and existing package repositories.
- Gets a list of currently installed plugins.
- Uninstalls a plugin.
- Uninstalls a plugin by version.
- Disable a plugin.
- Enables a disabled plugin.
- Gets a plugin's image.
- Gets plugin configuration.
- Updates plugin configuration.
- Gets a plugin's manifest.
- Device
- DisplayPreference
- Environment
- Filter
- Genre
- Image
- Get artist image by name.
- Get artist image by name.
- Generates or gets the splashscreen.
- Uploads a custom splashscreen. The body is expected to the image contents base64 encoded.
- Delete a custom splashscreen.
- Get genre image by name.
- Get genre image by name.
- Get genre image by name.
- Get genre image by name.
- Get item image infos.
- Delete an item's image.
- Set item image.
- Gets the item's image.
- Gets the item's image.
- Delete an item's image.
- Set item image.
- Gets the item's image.
- Gets the item's image.
- Gets the item's image.
- Gets the item's image.
- Updates the index for an item image.
- Get music genre image by name.
- Get music genre image by name.
- Get music genre image by name.
- Get music genre image by name.
- Get person image by name.
- Get person image by name.
- Get person image by name.
- Get person image by name.
- Get studio image by name.
- Get studio image by name.
- Get studio image by name.
- Get studio image by name.
- Sets the user image.
- Delete the user's image.
- Get user profile image.
- Get user profile image.
- InstantMix
- Creates an instant playlist based on a given album.
- Creates an instant playlist based on a given artist.
- Creates an instant playlist based on a given item.
- Creates an instant playlist based on a given genre.
- Creates an instant playlist based on a given genre.
- Creates an instant playlist based on a given playlist.
- Creates an instant playlist based on a given song.
- ItemLookup
- Get the item's external id info.
- Applies search criteria to an item and refreshes metadata.
- Get book remote search.
- Get box set remote search.
- Get movie remote search.
- Get music album remote search.
- Get music artist remote search.
- Get music video remote search.
- Get person remote search.
- Get series remote search.
- Get trailer remote search.
- Library
- Refreshes metadata for an item.
- Gets items based on a query.
- Deletes items from the library and filesystem.
- Gets items based on a query.
- Deletes an item from the library and filesystem.
- Gets an item from a user's library.
- Gets similar items.
- Gets similar items.
- Gets all parents of an item.
- Gets the collections that include the specified item.
- Downloads item media.
- Get the original file of an item.
- Gets similar items.
- Get theme songs and videos for an item.
- Get theme songs for an item.
- Get theme videos for an item.
- Get item counts.
- Gets the library options info.
- Reports that new movies have been added by an external source.
- Gets all user media folders.
- Reports that new movies have been added by an external source.
- Reports that new movies have been added by an external source.
- Gets a list of physical paths from virtual folders.
- Starts a library scan.
- Reports that new episodes of a series have been added by an external source.
- Reports that new episodes of a series have been added by an external source.
- Gets similar items.
- Gets similar items.
- Gets similar items.
- Gets intros to play before the main media item plays.
- Gets local trailers for an item.
- Gets special features for an item.
- Gets latest media.
- Gets the root folder from a user's library.
- UserData
- ItemUpdate
- LibraryStructure
- LiveTv
- Get channel mapping options.
- Set channel mappings.
- Gets available live tv channels.
- Gets a live tv channel.
- Get guide info.
- Gets available live tv services.
- Adds a listings provider.
- Delete listing provider.
- Gets default listings provider info.
- Gets available lineups.
- Gets available countries.
- Gets a live tv recording stream.
- Gets a live tv channel stream.
- Gets available live tv epgs.
- Gets available live tv epgs.
- Gets a live tv program.
- Gets recommended live tv epgs.
- Gets live tv recordings.
- Gets a live tv recording.
- Deletes a live tv recording.
- Gets recording folders.
- Gets live tv series timers.
- Creates a live tv series timer.
- Gets a live tv series timer.
- Cancels a live tv series timer.
- Updates a live tv series timer.
- Gets the live tv timers.
- Creates a live tv timer.
- Gets a timer.
- Cancels a live tv timer.
- Updates a live tv timer.
- Gets the default values for a new timer.
- Adds a tuner host.
- Deletes a tuner host.
- Get tuner host types.
- Resets a tv tuner.
- Discover tuners.
- Discover tuners.
- Localization
- Lyric
- MediaInfo
- MediaSegment
- Movie
- MusicGenre
- Playlist
- Session
- Reports playback has started within a session.
- Pings a playback session.
- Reports playback progress within a session.
- Reports playback has stopped within a session.
- Gets a list of sessions.
- Issues a full general command to a client.
- Issues a general command to a client.
- Issues a command to a client to display a message to the user.
- Instructs a session to play an item.
- Issues a playstate command to a client.
- Issues a system command to a client.
- Adds an additional user to a session.
- Removes an additional user from a session.
- Instructs a session to browse to an item or view.
- Updates capabilities for a device.
- Updates capabilities for a device.
- Reports that a session has ended.
- Reports that a session is viewing an item.
- RemoteImage
- ScheduledTask
- Search
- Startup
- Studio
- Subtitle
- Gets a list of available fallback font files.
- Gets a fallback font file.
- Search remote subtitles.
- Downloads a remote subtitle.
- Gets the remote subtitles.
- Gets an HLS subtitle playlist.
- Upload an external subtitle file.
- Deletes an external subtitle file.
- Gets subtitles in a specified format.
- Gets subtitles in a specified format.
- Suggestion
- SyncPlay
- Gets a SyncPlay group by id.
- Notify SyncPlay group that member is buffering.
- Join an existing SyncPlay group.
- Leave the joined SyncPlay group.
- Gets all SyncPlay groups.
- Request to move an item in the playlist in SyncPlay group.
- Create a new SyncPlay group.
- Request next item in SyncPlay group.
- Request pause in SyncPlay group.
- Update session ping.
- Request previous item in SyncPlay group.
- Request to queue items to the playlist of a SyncPlay group.
- Notify SyncPlay group that member is ready for playback.
- Request to remove items from the playlist in SyncPlay group.
- Request seek in SyncPlay group.
- Request SyncPlay group to ignore member during group-wait.
- Request to set new playlist in SyncPlay group.
- Request to change playlist item in SyncPlay group.
- Request to set repeat mode in SyncPlay group.
- Request to set shuffle mode in SyncPlay group.
- Request stop in SyncPlay group.
- Request unpause in SyncPlay group.
- Trailer
- TrickPlay
- Show
- User
- UserView
- Video
- Year
- Person
- 数据模型
- AccessSchedule
- ActivityLogEntry
- ActivityLogEntryMessage
- ActivityLogEntryQueryResult
- ActivityLogEntryStartMessage
- ActivityLogEntryStopMessage
- ActivityLogSortBy
- AddVirtualFolderDto
- AlbumInfo
- AlbumInfoRemoteSearchQuery
- AllThemeMediaResult
- ArtistInfo
- ArtistInfoRemoteSearchQuery
- AudioSpatialFormat
- AuthenticateUserByName
- AuthenticationInfo
- AuthenticationInfoQueryResult
- AuthenticationResult
- BackupManifestDto
- BackupOptionsDto
- BackupRestoreRequestDto
- BaseItemDto
- BaseItemDtoQueryResult
- BaseItemKind
- BaseItemPerson
- BasePluginConfiguration
- BookInfo
- BookInfoRemoteSearchQuery
- BoxSetInfo
- BoxSetInfoRemoteSearchQuery
- BrandingOptionsDto
- BufferRequestDto
- CastReceiverApplication
- ChannelFeatures
- ChannelItemSortField
- ChannelMappingOptionsDto
- ChannelMediaContentType
- ChannelMediaType
- ChannelType
- ChapterInfo
- ClientCapabilitiesDto
- ClientLogDocumentResponseDto
- CodecProfile
- CodecType
- CollectionCreationResult
- CollectionType
- CollectionTypeOptions
- ConfigurationPageInfo
- ContainerProfile
- CountryInfo
- CreatePlaylistDto
- CreateUserByName
- CultureDto
- CustomDatabaseOption
- CustomDatabaseOptions
- DatabaseConfigurationOptions
- DatabaseLockingBehaviorTypes
- DayOfWeek
- DayPattern
- DefaultDirectoryBrowserInfoDto
- DeinterlaceMethod
- DeviceInfoDto
- DeviceInfoDtoQueryResult
- DeviceOptionsDto
- DeviceProfile
- DirectPlayProfile
- DisplayPreferencesDto
- DlnaProfileType
- DownMixStereoAlgorithms
- DynamicDayOfWeek
- EmbeddedSubtitleOptions
- EncoderPreset
- EncodingContext
- EncodingOptions
- EndPointInfo
- ExternalIdInfo
- ExternalIdMediaType
- ExternalUrl
- ExtraType
- FileSystemEntryInfo
- FileSystemEntryType
- FolderStorageDto
- FontFile
- ForceKeepAliveMessage
- ForgotPasswordAction
- ForgotPasswordDto
- ForgotPasswordPinDto
- ForgotPasswordResult
- GeneralCommand
- GeneralCommandMessage
- GeneralCommandType
- GetProgramsDto
- GroupInfoDto
- GroupQueueMode
- GroupRepeatMode
- GroupShuffleMode
- GroupStateType
- GroupStateUpdate
- GroupUpdate
- GroupUpdateType
- GuideInfo
- HardwareAccelerationType
- HlsAudioSeekStrategy
- IPlugin
- IgnoreWaitRequestDto
- ImageFormat
- ImageInfo
- ImageOption
- ImageOrientation
- ImageProviderInfo
- ImageResolution
- ImageSavingConvention
- ImageType
- InboundKeepAliveMessage
- InboundWebSocketMessage
- InstallationInfo
- IsoType
- ItemCounts
- ItemFields
- ItemFilter
- ItemSortBy
- JoinGroupRequestDto
- KeepUntil
- LibraryChangedMessage
- LibraryOptionInfoDto
- LibraryOptions
- LibraryOptionsResultDto
- LibraryStorageDto
- LibraryTypeOptionsDto
- LibraryUpdateInfo
- ListingsProviderInfo
- LiveStreamResponse
- LiveTvInfo
- LiveTvOptions
- LiveTvServiceInfo
- LiveTvServiceStatus
- LocalizationOption
- LocationType
- LogFile
- LogLevel
- LyricDto
- LyricLine
- LyricLineCue
- LyricMetadata
- MediaAttachment
- MediaPathDto
- MediaPathInfo
- MediaProtocol
- MediaSegmentDto
- MediaSegmentDtoQueryResult
- MediaSegmentType
- MediaSourceInfo
- MediaSourceType
- MediaStream
- MediaStreamProtocol
- MediaStreamType
- MediaType
- MediaUpdateInfoDto
- MediaUpdateInfoPathDto
- MediaUrl
- MessageCommand
- MetadataConfiguration
- MetadataEditorInfo
- MetadataField
- MetadataOptions
- MetadataRefreshMode
- MovePlaylistItemRequestDto
- MovieInfo
- MovieInfoRemoteSearchQuery
- MusicVideoInfo
- MusicVideoInfoRemoteSearchQuery
- NameGuidPair
- NameIdPair
- NameValuePair
- NetworkConfiguration
- NewGroupRequestDto
- NextItemRequestDto
- OpenLiveStreamDto
- OutboundKeepAliveMessage
- OutboundWebSocketMessage
- PackageInfo
- ParentalRating
- ParentalRatingScore
- PathSubstitution
- PersonKind
- PersonLookupInfo
- PersonLookupInfoRemoteSearchQuery
- PinRedeemResult
- PingRequestDto
- PlayAccess
- PlayCommand
- PlayMessage
- PlayMethod
- PlayQueueUpdate
- PlayQueueUpdateReason
- PlayRequest
- PlayRequestDto
- PlaybackErrorCode
- PlaybackInfoDto
- PlaybackInfoResponse
- PlaybackOrder
- PlaybackProgressInfo
- PlaybackRequestType
- PlaybackStartInfo
- PlaybackStopInfo
- PlayerStateInfo
- PlaylistCreationResult
- PlaylistDto
- PlaylistUserPermissions
- PlaystateCommand
- PlaystateMessage
- PlaystateRequest
- PluginInfo
- PluginInstallationCancelledMessage
- PluginInstallationCompletedMessage
- PluginInstallationFailedMessage
- PluginInstallingMessage
- PluginStatus
- PluginUninstalledMessage
- PreviousItemRequestDto
- ProblemDetails
- ProcessPriorityClass
- ProfileCondition
- ProfileConditionType
- ProfileConditionValue
- ProgramAudio
- PublicSystemInfo
- QueryFilters
- QueryFiltersLegacy
- QueueItem
- QueueRequestDto
- QuickConnectDto
- QuickConnectResult
- RatingType
- ReadyRequestDto
- RecommendationDto
- RecommendationType
- RecordingStatus
- RefreshProgressMessage
- RemoteImageInfo
- RemoteImageResult
- RemoteLyricInfoDto
- RemoteSearchResult
- RemoteSubtitleInfo
- RemoveFromPlaylistRequestDto
- RepeatMode
- RepositoryInfo
- RestartRequiredMessage
- ScheduledTaskEndedMessage
- ScheduledTasksInfoMessage
- ScheduledTasksInfoStartMessage
- ScheduledTasksInfoStopMessage
- ScrollDirection
- SearchHint
- SearchHintResult
- SeekRequestDto
- SendCommand
- SendCommandType
- SeriesInfo
- SeriesInfoRemoteSearchQuery
- SeriesStatus
- SeriesTimerCancelledMessage
- SeriesTimerCreatedMessage
- SeriesTimerInfoDto
- SeriesTimerInfoDtoQueryResult
- ServerConfiguration
- ServerDiscoveryInfo
- ServerRestartingMessage
- ServerShuttingDownMessage
- SessionInfoDto
- SessionMessageType
- SessionUserInfo
- SessionsMessage
- SessionsStartMessage
- SessionsStopMessage
- SetChannelMappingDto
- SetPlaylistItemRequestDto
- SetRepeatModeRequestDto
- SetShuffleModeRequestDto
- SongInfo
- SortOrder
- SpecialViewOptionDto
- StartupConfigurationDto
- StartupRemoteAccessDto
- StartupUserDto
- SubtitleDeliveryMethod
- SubtitlePlaybackMode
- SubtitleProfile
- SyncPlayCommandMessage
- SyncPlayGroupDoesNotExistUpdate
- SyncPlayGroupJoinedUpdate
- SyncPlayGroupLeftUpdate
- SyncPlayGroupUpdateMessage
- SyncPlayLibraryAccessDeniedUpdate
- SyncPlayNotInGroupUpdate
- SyncPlayPlayQueueUpdate
- SyncPlayQueueItem
- SyncPlayStateUpdate
- SyncPlayUserAccessType
- SyncPlayUserJoinedUpdate
- SyncPlayUserLeftUpdate
- SystemInfo
- SystemStorageDto
- TaskCompletionStatus
- TaskInfo
- TaskResult
- TaskState
- TaskTriggerInfo
- TaskTriggerInfoType
- ThemeMediaResult
- TimerCancelledMessage
- TimerCreatedMessage
- TimerEventInfo
- TimerInfoDto
- TimerInfoDtoQueryResult
- TonemappingAlgorithm
- TonemappingMode
- TonemappingRange
- TrailerInfo
- TrailerInfoRemoteSearchQuery
- TranscodeReason
- TranscodeSeekInfo
- TranscodingInfo
- TranscodingProfile
- TransportStreamTimestamp
- TrickplayInfoDto
- TrickplayOptions
- TrickplayScanBehavior
- TunerChannelMapping
- TunerHostInfo
- TypeOptions
- UnratedItem
- UpdateLibraryOptionsDto
- UpdateMediaPathRequestDto
- UpdatePlaylistDto
- UpdatePlaylistUserDto
- UpdateUserItemDataDto
- UpdateUserPassword
- UploadSubtitleDto
- UserConfiguration
- UserDataChangeInfo
- UserDataChangedMessage
- UserDeletedMessage
- UserDto
- UserItemDataDto
- UserPolicy
- UserUpdatedMessage
- UtcTimeResponse
- ValidatePathDto
- VersionInfo
- Video3DFormat
- VideoRange
- VideoRangeType
- VideoType
- VirtualFolderInfo
- WebSocketMessage
- XbmcMetadataOptions
Create a new api key.
POST
/Auth/Keys
最后修改时间：2026-08-24 05:10:28
请求参数
Authorization
API Key
在 header 添加参数
Authorization
示例：
Authorization: ********************or
Query 参数
请求示例代码
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST '/Auth/Keys?app=' \
--header 'Authorization: <api-key>'返回响应
🟢204
该响应没有 Body
🟠401
🟠403
🔴503
人生足迹 · 店铺
远程在线技术服务平台，1对1的技术支持
服务列表
萌森软件开发工作室
关注微信公众号，新资源，总是快人一步
微信公众号修改于 2026-08-24 05:10:28