{"@context": "https://schema.org", "@type": "WebAPI", "name": "Jellyfin API API", "description": "Jellyfin API, an HTTP API described by an OpenAPI document.", "provider": {"@type": "Organization", "name": "jellyfin.local"}, "documentation": "https://repo.jellyfin.org/releases/openapi/stable/jellyfin-openapi-10.7.0-rc2.json"}
Jellyfin API, an HTTP API described by an OpenAPI document.
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: http://jellyfin.local http://localhost
auth: a p i k e y
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
Jellyfin API, an HTTP API described by an OpenAPI document.
| method | path | what the vendor says it does |
|---|---|---|
GET | /Albums/{id}/InstantMix | Creates an instant playlist based on a given song. InstantMix |
GET | /Albums/{itemId}/Similar | Gets similar items. Library |
GET | /Artists | Gets all artists from a given item, folder, or the entire library. Artists |
GET | /Artists/AlbumArtists | Gets all album artists from a given item, folder, or the entire library. Artists |
GET | /Artists/{id}/InstantMix | Creates an instant playlist based on a given song. InstantMix |
GET | /Artists/{itemId}/Similar | Gets similar items. Library |
GET | /Artists/{name} | Gets an artist by name. Artists |
GET | /Artists/{name}/Images/{imageType}/{imageIndex} | Get artist image by name. Image |
GET | /Audio/{itemId}/hls/{segmentId}/stream.aac | Gets the specified audio segment for an audio item. HlsSegment |
GET | /Audio/{itemId}/hls/{segmentId}/stream.mp3 | Gets the specified audio segment for an audio item. HlsSegment |
GET | /Audio/{itemId}/hls1/{playlistId}/{segmentId}.{container} | Gets a video stream using HTTP live streaming. DynamicHls |
GET | /Audio/{itemId}/main.m3u8 | Gets an audio stream using HTTP live streaming. DynamicHls |
GET | /Audio/{itemId}/master.m3u8 | Gets an audio hls playlist stream. DynamicHls |
GET | /Audio/{itemId}/stream | Gets an audio stream. Audio |
GET | /Audio/{itemId}/stream.{container} | Gets an audio stream. Audio |
GET | /Audio/{itemId}/universal | Gets an audio stream. UniversalAudio |
GET | /Auth/Keys | Get all keys. ApiKey |
POST | /Auth/Keys | Create a new api key. ApiKey |
DELETE | /Auth/Keys/{key} | Remove an api key. ApiKey |
GET | /Auth/PasswordResetProviders | Get all password reset providers. Session |
GET | /Auth/Providers | Get all auth providers. Session |
GET | /Branding/Configuration | Gets branding configuration. Branding |
GET | /Branding/Css | Gets branding css. Branding |
GET | /Branding/Css.css | Gets branding css. Branding |
GET | /Channels | Gets available channels. Channels |
GET | /Channels/Features | Get all channel features. Channels |
GET | /Channels/Items/Latest | Gets latest channel items. Channels |
GET | /Channels/{channelId}/Features | Get channel features. Channels |
GET | /Channels/{channelId}/Items | Get channel items. Channels |
POST | /Collections | Creates a new collection. Collection |
POST | /Collections/{collectionId}/Items | Adds items to a collection. Collection |
DELETE | /Collections/{collectionId}/Items | Removes items from a collection. Collection |
GET | /Devices | Get Devices. Devices |
DELETE | /Devices | Deletes a device. Devices |
GET | /Devices/Info | Get info for a device. Devices |
GET | /Devices/Options | Get options for a device. Devices |
POST | /Devices/Options | Update device options. Devices |
GET | /DisplayPreferences/{displayPreferencesId} | Get Display Preferences. DisplayPreferences |
POST | /DisplayPreferences/{displayPreferencesId} | Update Display Preferences. DisplayPreferences |
GET | /Dlna/ProfileInfos | Get profile infos. Dlna |
and 160 more operation(s) in this specification, all searchable.
specification origin: https://repo.jellyfin.org/releases/openapi/stable/jellyfin-openapi-10.7.0-rc2.json
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.