Skip to content

Commit 769b2be

Browse files
authored
docs: Introduce Material for MkDocs (#387)
1 parent f5e1acc commit 769b2be

28 files changed

+1423
-1679
lines changed

docs/advanced/advanced-configurations.md

Whitespace-only changes.

docs/advanced/api.md

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
## Jellyfin Enhanced API
2+
3+
### Get Plugin Version
4+
5+
Checks the installed version of the Jellyfin Enhanced plugin:
6+
7+
```bash
8+
curl -X GET \
9+
"<JELLYFIN_ADDRESS>/JellyfinEnhanced/version"
10+
```
11+
12+
## Bookmark API + Info
13+
14+
### Storage Directory
15+
Bookmarks are stored in the server's user data directory at:
16+
```
17+
/config/data/users/{userId}/jellyfin-enhanced/bookmarks.json
18+
```
19+
20+
The data structure is:
21+
```json
22+
{
23+
"Bookmarks": {
24+
"unique-bookmark-id": {
25+
"itemId": "jellyfin-item-id",
26+
"tmdbId": "12345",
27+
"tvdbId": "67890",
28+
"mediaType": "movie" | "tv",
29+
"name": "Item Name",
30+
"timestamp": 123.45,
31+
"label": "Epic scene",
32+
"createdAt": "2026-01-03T12:00:00.000Z",
33+
"updatedAt": "2026-01-03T12:00:00.000Z",
34+
"syncedFrom": "original-item-id"
35+
}
36+
}
37+
}
38+
```
39+
40+
### API Access
41+
42+
External applications can read and write bookmarks using the Jellyfin Enhanced API endpoints
43+
44+
#### Get Bookmarks
45+
```http
46+
GET /JellyfinEnhanced/user-settings?fileName=bookmarks.json
47+
Authorization: MediaBrowser Token="{your-api-key}"
48+
```
49+
50+
#### Save Bookmarks
51+
```http
52+
POST /JellyfinEnhanced/user-settings
53+
Authorization: MediaBrowser Token="{your-api-key}"
54+
Content-Type: application/json
55+
56+
{
57+
"fileName": "bookmarks.json",
58+
"data": { "Bookmarks": {...} }
59+
}
60+
```
61+
62+
## Jellyseerr Integration API
63+
64+
Plugin exposes proxy endpoints for Jellyseerr:
65+
66+
### Check Connection Status
67+
68+
Checks if the plugin can connect to any of the configured Jellyseerr URLs using the provided API key.
69+
70+
```bash
71+
curl -X GET \
72+
-H "X-Emby-Token: <API_KEY>" \
73+
"<JELLYFIN_URL>/JellyfinEnhanced/jellyseerr/status"
74+
```
75+
76+
### Check User Status
77+
78+
Verifies that the currently logged-in Jellyfin user is successfully linked to a Jellyseerr user account.
79+
80+
```bash
81+
curl -X GET \
82+
-H "X-Emby-Token: <JELLYFIN_API_KEY>" \
83+
-H "X-Jellyfin-User-Id: <JELLYFIN_USER_ID>" \
84+
"<JELLYFIN_ADDRESS>/JellyfinEnhanced/jellyseerr/user-status"
85+
```
86+
87+
### Perform A Jellyseerr Search
88+
89+
Executes a search query through the Jellyseerr instance for the specified user.
90+
91+
```bash
92+
curl -X GET \
93+
-H "X-Emby-Token: <API_KEY>" \
94+
-H "X-Jellyfin-User-Id: <USER_ID>" \
95+
"<JELLYFIN_URL>/JellyfinEnhanced/jellyseerr/search?query=Inception"
96+
```
97+
98+
### Make a Request on Jellyseerr
99+
100+
Submits a media request to Jellyseerr on behalf of the specified user.
101+
102+
- `mediaType` can be `tv` or `movie`\
103+
- `mediaId` is the **TMDB ID** of the item
104+
105+
```bash
106+
curl -X POST \
107+
-H "X-Emby-Token: <API_KEY>" \
108+
-H "X-Jellyfin-User-Id: <USER_ID>" \
109+
-H "Content-Type: application/json" \
110+
-d '{"mediaType": "movie", "mediaId": 27205}' \
111+
"<JELLYFIN_URL>/JellyfinEnhanced/jellyseerr/request"
112+
```

0 commit comments

Comments
 (0)