ApiClient. ApiClient

Authenticate user by username and password

Build a request AA to exchange an APPROVED Quick Connect secret for an auth token, for use with fetchAsync() / fetchRes().

The body's field name changed at 10.8.0 — a FINER boundary than the V1/V2 apiVersion split, so it reads the server version directly rather than m.getApiVersion(): 10.7.x: { "Token": secret } (QuickConnectDto.Token, required) 10.8.0+: { "Secret": secret } (QuickConnectDto.Secret, required) Confirmed against every published spec from 10.7.0 to 10.11.8 — the rename lands at exactly 10.8.0, with no version carrying both names.

DON'T BRANCH ON THE ERROR CODE HERE. The spec declares only 400 ("Missing token") plus 503 from 10.11.0, but a live 10.11.11 answered 404 for a secret it had not seen approved — an undeclared code. So a non-ok response means "this secret cannot be exchanged" and nothing finer; quickConnectExchangeFailure (source/utils/quickConnect.bs) owns the one distinction worth making.

Build a request AA to cancel a Live TV series recording timer, for use with SubmitSideEffect().

Build a request AA to cancel a Live TV recording timer, for use with SubmitSideEffect().

Build a request AA to poll whether a Quick Connect secret has been approved, for use with fetchAsync() / fetchRes(). Responds 200 with the same QuickConnectResult shape Initiate returned, its Authenticated flag now true once someone approved the code.

An UNKNOWN or EXPIRED secret answers 404 ("Unknown quick connect secret"), declared by EVERY published spec from 10.7.0 to 10.11.8 and corroborated by a live 10.11.11. That is the only signal separating "not approved yet" from "this code is dead", and it is invisible to a caller that only parses the body — which is why this endpoint has to go through the pool (res.statusCode) rather than a sync JSON helper.

Build a request AA to create a Live TV series recording timer, for use with fetchRes() or fetchJson().

Build a request AA to create a Live TV recording timer, for use with fetchRes() or fetchJson().

Build a request AA to delete an item, for use with SubmitSideEffect().

Build a request AA for GetAdditionalParts, for use with fetchRes() or fetchJson().

Build a request AA to fetch all album artists, for use with fetchRes() or fetchJson(). Mirrors GetAlbumArtists(): applies injectDefaults and injects UserId.

Build a request AA for GetArtistByName, for use with fetchJson().

Build a request AA to get similar artists, for use with fetchRes() or fetchJson().

Build a request AA to fetch all artists, for use with fetchRes() or fetchJson(). Mirrors GetArtists(): applies injectDefaults and injects UserId.

Build a request AA for GetBrandingConfiguration, for use with fetchRes() or fetchJson().

Build a request AA for GetEpisodes, for use with fetchRes() or fetchJson().

Build a request AA for GetFilters, for use with fetchRes() or fetchJson().

Build a request AA to fetch genres, for use with fetchRes() or fetchJson().

Build a request AA for GetInstantMix, for use with fetchJson().

Build a request AA for GetIntros, for use with fetchJson().

Build a request AA for GetItemLyrics, for use with fetchJson().

Build a request AA to get a single item WITHOUT image/version field injection.

Get a single item by ID with automatic image and version field injection Build a request AA to get a single item with automatic image/version field injection.

Build a request AA for GetItemsByQuery, for use with fetchRes() or fetchJson().

Build a request AA for GetLatestMedia, for use with fetchRes() or fetchJson(). Both V1 and V2 return a bare array of BaseItemDto (not paginated). V1: /users/{id}/items/latest (10.7.x–10.8.x) V2: /Items/Latest?userId= (10.9+)

Build a request AA to fetch Live TV channels, for use with fetchRes() or fetchJson().

Build a request AA for GetLiveTVPrograms (full EPG search), for use with fetchRes() or fetchJson(). Mirrors GetLiveTVPrograms(): applies injectDefaults.

Build a request AA to fetch a single Live TV program, for use with fetchRes() or fetchJson().

Build a request AA to get recommended Live TV programs (On Now), for use with fetchRes() or fetchJson().

Build a request AA to get Live TV recordings, for use with fetchRes() or fetchJson().

Build a request AA to fetch the Live TV schedule, for use with fetchRes() or fetchJson(). Uses POST because the channelIds list can exceed URL length limits.

Build a request AA to fetch Live TV timer defaults for a program, for use with fetchRes() or fetchJson().

Build a request AA for GetLocalTrailers, for use with submitApiRequest() or fetchJson(). Version-aware: V2 uses /Items/{id}/LocalTrailers, V1 uses /users/{userId}/items/{id}/localtrailers.

Build a request AA for GetMediaSegments, for use with fetchJson(). Only available on Jellyfin 10.10.0+ servers.

Build a request AA for GetNextUp, for use with fetchRes() or fetchJson(). Mirrors GetNextUp(): applies injectDefaults and injects UserId.

Build a request AA for GetPersons, for use with fetchRes() or fetchJson(). Mirrors GetPersons(): applies injectDefaults and injects UserId.

Build a request AA for GetPlaylistItems, for use with fetchRes() or fetchJson().

Build a request AA for GetQuickConnectEnabled, for use with fetchRes() or fetchJson(). Server responds with a plain boolean body (true = enabled, false = disabled). Lowercase path matches the existing /quickconnect/initiate convention - Jellyfin's routing is case-insensitive but reverse proxies in the wild sometimes are not.

Build a request AA for GetResumeItems (Continue Watching), for use with fetchRes() or fetchJson(). Mirrors GetResumeItems(): applies injectDefaults, version-aware endpoint.

The server hardcodes Recursive, OrderBy=DatePlayed and IsResumable on this endpoint, so MediaTypes is the ONLY narrowing a client controls — don't bother sending recursive / SortBy / SortOrder / Filters, they are ignored. Since 12.0 a folder also matches IsResumable when a descendant is in progress, so an unfiltered query returns Seasons and Series (by design) mixed in with the episodes. Every JellyRock resume flow is video, so default to Video; pass MediaTypes as a comma-separated STRING to widen it.

Build a request AA for GetSeasons, for use with fetchRes() or fetchJson(). Mirrors GetSeasons(): applies injectDefaults and injects UserId.

Build a request AA to get active sessions, for use with fetchJson().

Build a request AA to get similar items, for use with fetchRes() or fetchJson().

Build a request AA for GetSpecialFeatures, for use with fetchRes() or fetchJson(). Mirrors GetSpecialFeatures(): version-aware endpoint.

Build a request AA to fetch studios, for use with fetchRes() or fetchJson().

Build a request AA for GetViews, for use with fetchRes() or fetchJson(). Mirrors GetViews(): version-aware endpoint.

Build a HEAD request AA to check if an item image exists, for use with fetchRes() or fetchJson(). Caller checks res.ok — no body is returned for HEAD requests.

Build a request AA to start a Quick Connect request, for use with fetchAsync() / fetchRes(). The response carries the Secret we poll with and the Code the user types on their other device.

The HTTP METHOD moved at the same boundary as the apiVersion split: apiVersion 1 (10.7.0 - 10.8.13): GET (no POST route exists) apiVersion 2 (10.9.0+): POST (no GET route exists) Confirmed against every published spec from 10.7.0 to 10.11.8: each version declares exactly one of the two verbs, and the swap is at exactly 10.9.0.

Sending the wrong method to a modern server yields 401 ("Quick connect is not active on this server"), which reads as a feature gate but is actually a route mismatch — so the dispatch is load-bearing, not cosmetic. That collision is also why quickConnectInitiateFailure treats 401 as "disabled": it is the same code either way, and a route mismatch is our bug, not something to tell a user.

Build a request AA to mark an item as favorite, for use with SubmitSideEffect().

Build a request AA to mark an item as played, for use with SubmitSideEffect(). Includes default DatePlayed (now) and PlaybackPositionTicks (0) matching Jellyfin API expectations.

Build a playstate request AA for use with SubmitSideEffect(). Applies default playstate fields and routes to the correct session endpoint.

Build a request AA for PostPlaybackInfo, for use with fetchJson().

Build a request AA to post full session capabilities, for use with SubmitSideEffect().

Build a request AA to unmark an item as favorite, for use with SubmitSideEffect().

Build a request AA to mark an item as unplayed, for use with SubmitSideEffect().

Get configuration by name

Get display preferences

Get image URL

Get public users

Get user by ID

Get user image URL