Audiobookshelf MCP server
Provides tools for interacting with an Audiobookshelf server, covering the full API: libraries, books, podcasts, episode downloads, collections, playlists, users, playback sessions, backups, settings, and more.
Click on "Deploy Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@Audiobookshelf MCP server list all audiobooks in my library"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
Audiobookshelf MCP server
Run Audiobookshelf from Claude.ai and Claude Code. All 209 routes are tools. Not a curated subset: every endpoint the web interface can reach, this can reach.
Using this server with a paid AI service costs money. Tool definitions and results are billed as input tokens, and an agent can call tools repeatedly on its own. You are responsible for every charge, so set spending limits with your provider. The author accepts no liability for any costs. SeeDISCLAIMER.md.
Why not the other options
Audiobookshelf ships docs/openapi.json, but it documents 65 of the 209 routes its Express routers register, so anything generated from it covers under a third of the API. The routers are the complete list:
Approach | Tools | Coverage |
Servers built on | up to 65 | 31 % |
Hand-written subsets | a dozen or so | under 10 % |
This one | 209 | 100 % |
The published spec covers libraries, items and a few author and series routes. It leaves out playback sessions, progress, podcasts and their episode downloads, collections, playlists, users, backups, notifications, email and the whole settings surface.
Related MCP server: mcp-openapi-bridge
How it stays complete
scripts/extract_spec.py reads the routers and writes an OpenAPI document, borrowing summaries and parameters from the published docs wherever they exist. scripts/generate_tools.py then turns it into tools:
git clone --depth 1 https://github.com/advplyr/audiobookshelf.git /tmp/abs
python scripts/extract_spec.py /tmp/abs openapi.json
python scripts/generate_tools.py openapi.json src/audiobookshelf_mcp/tools.py45 of the 209 operations carry the project's own descriptions; the rest are derived from the route.
A test compares every generated call against every operation in the extracted spec, in both directions. A route Audiobookshelf adds and this misses fails the build; so does a tool pointing at a route that does not exist.
Tool names
Verb first, derived from the method and path, so the name says what it does:
Pattern | Meaning | Example |
| Read a collection |
|
| Read one record |
|
| POST |
|
| PATCH |
|
| DELETE |
|
209 tools is a lot to put in front of a model at once. If your client supports tool filtering, narrow it to the groups you use.
What is covered
Every route the three routers register, across /api, /public and /hls: libraries and their items, books, podcasts and episode downloads, authors, series, collections, playlists, search, listening sessions and playback progress, me, users and API keys, notifications, email and ereader devices, RSS feeds and share links, the filesystem browser, caches, backups, logs, tools and the whole settings surface.
Setup
git clone https://github.com/rollecode/audiobookshelf-mcp.git
cd audiobookshelf-mcp
uv venv && uv pip install -e .export AUDIOBOOKSHELF_URL=http://127.0.0.1:13378
export AUDIOBOOKSHELF_TOKEN=... # Settings, Users, your user, API tokenClaude Code
claude mcp add audiobookshelf -- /path/to/audiobookshelf-mcp/.venv/bin/audiobookshelf-mcpWriting
Audiobookshelf patches rather than replaces, so body needs only the fields you are changing. Ids are strings throughout, not numbers.
Hosting it
Running it over HTTP puts it in reach of Claude.ai as a custom connector, and of Claude Code on other machines. Three tiers, the same shape the other servers in this family use:
Tier | Port | What it does |
| 8570 | The server. No login of its own, never exposed |
nginx | 8571 | Front door, behind a Cloudflare Tunnel |
| 8572 | OAuth 2.1 sign-in, or a fixed bearer token |
npm install
node set-password.js 'a password for the sign-in page'
printf 'AUDIOBOOKSHELF_URL=...\n' > ~/.config/audiobookshelf-mcp/env
chmod 600 ~/.config/audiobookshelf-mcp/envCopy systemd/*.service into /etc/systemd/system/, replacing YOUR_USER and the ISSUER hostname, then:
sudo systemctl enable --now audiobookshelf-mcp audiobookshelf-mcp-authPoint nginx/audiobookshelf-mcp.conf at your own hostname and send the tunnel at 127.0.0.1:8571.
Environment the server itself reads: AUDIOBOOKSHELF_URL, AUDIOBOOKSHELF_TOKEN. The sign-in page carries the Audiobookshelf mark and accent colour, set through APP_NAME, APP_ACCENT and APP_BLURB in the auth unit.
Claude.ai
Settings, Connectors, Add custom connector, URL https://audiobookshelf-mcp.your-domain/mcp, client ID and secret blank. The sign-in page asks for the password set above. Connectors belong to the account, so adding it once covers mobile too.
Development
uv pip install -e . pytest ruff
.venv/bin/python -m pytest tests
.venv/bin/ruff check .Available Tools
212 toolsadd_podcast_from_feedAIdempotent
Add a podcast by RSS feed, which the server fetches itself.
Unlike a book, a podcast needs no local file: give the feed and Audiobookshelf pulls the episodes.
Args: library_id: A podcast-type library, from list_libraries. folder_id: Folder within that library. feed_url: The RSS feed URL. auto_download: Keep downloading new episodes as they appear.
Inputs: feed_url (required), folder_id (required), library_id (required), auto_download. Returns: result
create_api_keysCIdempotent
Create or act on api api-keys.
POST /api/api-keys
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required). Returns: result
create_authorizeCIdempotent
Create or act on api authorize.
POST /api/authorize
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required). Returns: result
create_authors_by_id_imageAIdempotent
Add an author image to the server.
POST /api/authors/{id}/image
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), body (required). Returns: result
create_authors_by_id_matchBIdempotent
Match the author against Audible using quick match.
POST /api/authors/{id}/match
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), body (required). Returns: result
create_backupsCIdempotent
Create or act on api backups.
POST /api/backups
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required). Returns: result
create_backups_uploadCIdempotent
Create or act on backups upload.
POST /api/backups/upload
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required). Returns: result
create_cache_items_purgeDIdempotent
Create or act on items purge.
POST /api/cache/items/purge
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required). Returns: result
create_cache_purgeCIdempotent
Create or act on cache purge.
POST /api/cache/purge
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required). Returns: result
create_collectionsCIdempotent
Create or act on api collections.
POST /api/collections
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required). Returns: result
create_collections_by_id_batch_addCIdempotent
Create or act on batch add.
POST /api/collections/{id}/batch/add
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), body (required). Returns: result
create_collections_by_id_batch_removeCIdempotent
Create or act on batch remove.
POST /api/collections/{id}/batch/remove
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), body (required). Returns: result
create_collections_by_id_bookCIdempotent
Create or act on collections book.
POST /api/collections/{id}/book
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), body (required). Returns: result
create_custom_metadata_providersBIdempotent
Create or act on api custom-metadata-providers.
POST /api/custom-metadata-providers
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required). Returns: result
create_emails_ereader_devicesCIdempotent
Update e-reader devices.
POST /api/emails/ereader-devices
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required). Returns: result
create_emails_send_ebook_to_deviceBIdempotent
Send ebook to device.
POST /api/emails/send-ebook-to-device
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required). Returns: result
create_emails_testBIdempotent
Send test email.
POST /api/emails/test
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required). Returns: result
create_feeds_by_id_closeCIdempotent
Create or act on feeds close.
POST /api/feeds/{id}/close
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), body (required). Returns: result
create_feeds_collection_by_collection_id_openCIdempotent
Create or act on collection open.
POST /api/feeds/collection/{collectionId}/open
Args: collection_id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required), collection_id (required). Returns: result
create_feeds_item_by_item_id_openCIdempotent
Create or act on item open.
POST /api/feeds/item/{itemId}/open
Args: item_id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required), item_id (required). Returns: result
create_feeds_series_by_series_id_openCIdempotent
Create or act on series open.
POST /api/feeds/series/{seriesId}/open
Args: series_id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required), series_id (required). Returns: result
create_filesystem_pathexistsDIdempotent
Create or act on filesystem pathexists.
POST /api/filesystem/pathexists
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required). Returns: result
create_genres_renameDIdempotent
Create or act on genres rename.
POST /api/genres/rename
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required). Returns: result
create_items_batch_deleteDIdempotent
Create or act on batch delete.
POST /api/items/batch/delete
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required). Returns: result
create_items_batch_getDIdempotent
Create or act on batch get.
POST /api/items/batch/get
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required). Returns: result
create_items_batch_quickmatchCIdempotent
Create or act on batch quickmatch.
POST /api/items/batch/quickmatch
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required). Returns: result
create_items_batch_scanCIdempotent
Create or act on batch scan.
POST /api/items/batch/scan
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required). Returns: result
create_items_batch_updateCIdempotent
Create or act on batch update.
POST /api/items/batch/update
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required). Returns: result
create_items_by_id_chaptersCIdempotent
Create or act on items chapters.
POST /api/items/{id}/chapters
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), body (required). Returns: result
create_items_by_id_coverCIdempotent
Create or act on items cover.
POST /api/items/{id}/cover
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), body (required). Returns: result
create_items_by_id_matchCIdempotent
Create or act on items match.
POST /api/items/{id}/match
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), body (required). Returns: result
create_items_by_id_playCIdempotent
Create or act on items play.
POST /api/items/{id}/play
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), body (required). Returns: result
create_items_by_id_play_by_episode_idDIdempotent
Create or act on items play.
POST /api/items/{id}/play/{episodeId}
Args: id: Path parameter. episode_id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), body (required), episode_id (required). Returns: result
create_items_by_id_scanCIdempotent
Create or act on items scan.
POST /api/items/{id}/scan
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), body (required). Returns: result
create_librariesAIdempotent
Create a new library on server.
POST /api/libraries
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required). Returns: result
create_libraries_by_id_remove_metadataCIdempotent
Create or act on libraries remove-metadata.
POST /api/libraries/{id}/remove-metadata
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), body (required). Returns: result
create_libraries_by_id_scanCIdempotent
Create or act on libraries scan.
POST /api/libraries/{id}/scan
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), body (required). Returns: result
create_libraries_orderCIdempotent
Create or act on libraries order.
POST /api/libraries/order
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required). Returns: result
create_me_ereader_devicesCIdempotent
Create or act on me ereader-devices.
POST /api/me/ereader-devices
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required). Returns: result
create_me_item_by_id_bookmarkCIdempotent
Create or act on item bookmark.
POST /api/me/item/{id}/bookmark
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), body (required). Returns: result
create_notificationsCIdempotent
Create notification settings.
POST /api/notifications
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required). Returns: result
create_playlistsCIdempotent
Create or act on api playlists.
POST /api/playlists
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required). Returns: result
create_playlists_by_id_batch_addDIdempotent
Create or act on batch add.
POST /api/playlists/{id}/batch/add
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), body (required). Returns: result
create_playlists_by_id_batch_removeCIdempotent
Create or act on batch remove.
POST /api/playlists/{id}/batch/remove
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), body (required). Returns: result
create_playlists_by_id_itemCIdempotent
Create or act on playlists item.
POST /api/playlists/{id}/item
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), body (required). Returns: result
create_playlists_collection_by_collection_idCIdempotent
Create or act on playlists collection.
POST /api/playlists/collection/{collectionId}
Args: collection_id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required), collection_id (required). Returns: result
create_podcastsAIdempotent
Create a new podcast.
POST /api/podcasts
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required). Returns: result
create_podcasts_by_id_download_episodesAIdempotent
Download podcast episodes.
POST /api/podcasts/{id}/download-episodes
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), body (required). Returns: result
create_podcasts_by_id_match_episodesBIdempotent
Quick match podcast episodes.
POST /api/podcasts/{id}/match-episodes
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects. override: Override existing details if set to 1
Inputs: id (required), body (required), override. Returns: result
create_podcasts_feedCIdempotent
Get podcast feed.
POST /api/podcasts/feed
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required). Returns: result
create_podcasts_opml_createBIdempotent
Bulk create podcasts from OPML feed URLs.
POST /api/podcasts/opml/create
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required). Returns: result
create_podcasts_opml_parseBIdempotent
Get feeds from OPML text.
POST /api/podcasts/opml/parse
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required). Returns: result
create_session_by_id_closeBIdempotent
Create or act on session close.
POST /api/session/{id}/close
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), body (required). Returns: result
create_session_by_id_syncCIdempotent
Create or act on session sync.
POST /api/session/{id}/sync
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), body (required). Returns: result
create_session_localCIdempotent
Create or act on session local.
POST /api/session/local
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required). Returns: result
create_session_local_allCIdempotent
Create or act on session local-all.
POST /api/session/local-all
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required). Returns: result
create_sessions_batch_deleteCIdempotent
Create or act on batch delete.
POST /api/sessions/batch/delete
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required). Returns: result
create_tags_renameCIdempotent
Create or act on tags rename.
POST /api/tags/rename
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required). Returns: result
create_tools_batch_embed_metadataCIdempotent
Create or act on batch embed-metadata.
POST /api/tools/batch/embed-metadata
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required). Returns: result
create_tools_item_by_id_embed_metadataCIdempotent
Create or act on item embed-metadata.
POST /api/tools/item/{id}/embed-metadata
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), body (required). Returns: result
create_tools_item_by_id_encode_m4bCIdempotent
Create or act on item encode-m4b.
POST /api/tools/item/{id}/encode-m4b
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), body (required). Returns: result
create_uploadCIdempotent
Create or act on api upload.
POST /api/upload
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required). Returns: result
create_usersBIdempotent
Create or act on api users.
POST /api/users
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required). Returns: result
create_validate_cronCIdempotent
Create or act on api validate-cron.
POST /api/validate-cron
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required). Returns: result
create_watcher_updateCIdempotent
Create or act on watcher update.
POST /api/watcher/update
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required). Returns: result
delete_api_keys_by_idCDestructiveIdempotent
Delete api api-keys.
DELETE /api/api-keys/{id}
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), body. Returns: result
delete_authors_by_idADestructiveIdempotent
Delete an author by ID.
DELETE /api/authors/{id}
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), body. Returns: result
delete_authors_by_id_imageADestructiveIdempotent
Delete an author image by author ID.
DELETE /api/authors/{id}/image
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), body. Returns: result
delete_backups_by_idBDestructiveIdempotent
Delete api backups.
DELETE /api/backups/{id}
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), body. Returns: result
delete_collections_by_idBDestructiveIdempotent
Delete api collections.
DELETE /api/collections/{id}
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), body. Returns: result
delete_collections_by_id_book_by_book_idCDestructiveIdempotent
Delete collections book.
DELETE /api/collections/{id}/book/{bookId}
Args: id: Path parameter. book_id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), book_id (required), body. Returns: result
delete_custom_metadata_providers_by_idBDestructiveIdempotent
Delete api custom-metadata-providers.
DELETE /api/custom-metadata-providers/{id}
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), body. Returns: result
delete_genres_by_genreCDestructiveIdempotent
Delete api genres.
DELETE /api/genres/{genre}
Args: genre: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: genre (required), body. Returns: result
delete_items_by_idCDestructiveIdempotent
Delete api items.
DELETE /api/items/{id}
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), body. Returns: result
delete_items_by_id_coverBDestructiveIdempotent
Delete items cover.
DELETE /api/items/{id}/cover
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), body. Returns: result
delete_items_by_id_file_by_fileidBDestructiveIdempotent
Delete items file.
DELETE /api/items/{id}/file/{fileid}
Args: id: Path parameter. fileid: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), fileid (required), body. Returns: result
delete_libraries_by_idADestructiveIdempotent
Delete a single library by ID on server.
DELETE /api/libraries/{id}
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), body. Returns: result
delete_libraries_by_id_issuesADestructiveIdempotent
Delete items with issues in a library.
DELETE /api/libraries/{id}/issues
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), body. Returns: result
delete_libraries_by_id_narrators_by_narrator_idCDestructiveIdempotent
Delete libraries narrators.
DELETE /api/libraries/{id}/narrators/{narratorId}
Args: id: Path parameter. narrator_id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), narrator_id (required), body. Returns: result
delete_me_item_by_id_bookmark_by_timeBDestructiveIdempotent
Delete item bookmark.
DELETE /api/me/item/{id}/bookmark/{time}
Args: id: Path parameter. time: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), time (required), body. Returns: result
delete_me_progress_by_idBDestructiveIdempotent
Delete me progress.
DELETE /api/me/progress/{id}
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), body. Returns: result
delete_me_sessions_by_idBDestructiveIdempotent
Delete me sessions.
DELETE /api/me/sessions/{id}
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), body. Returns: result
delete_notifications_by_idADestructiveIdempotent
Delete a notification.
DELETE /api/notifications/{id}
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), body. Returns: result
delete_playlists_by_idCDestructiveIdempotent
Delete api playlists.
DELETE /api/playlists/{id}
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), body. Returns: result
delete_playlists_by_id_item_by_library_item_id_by_episode_idCDestructiveIdempotent
Delete playlists item.
DELETE /api/playlists/{id}/item/{libraryItemId}/{episodeId}?
Args: id: Path parameter. library_item_id: Path parameter. episode_id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), episode_id (required), library_item_id (required), body. Returns: result
delete_podcasts_by_id_episode_by_episode_idADestructiveIdempotent
Remove a podcast episode.
DELETE /api/podcasts/{id}/episode/{episodeId}
Args: id: Path parameter. episode_id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects. hard: Hard delete the episode if set to 1
Inputs: id (required), episode_id (required), body, hard. Returns: result
delete_sessions_by_idBDestructiveIdempotent
Delete api sessions.
DELETE /api/sessions/{id}
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), body. Returns: result
delete_tags_by_tagBDestructiveIdempotent
Delete api tags.
DELETE /api/tags/{tag}
Args: tag: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: tag (required), body. Returns: result
delete_tools_item_by_id_encode_m4bBDestructiveIdempotent
Delete item encode-m4b.
DELETE /api/tools/item/{id}/encode-m4b
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), body. Returns: result
delete_users_by_idADestructiveIdempotent
Delete api users.
DELETE /api/users/{id}
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), body. Returns: result
get_authors_by_idARead-onlyIdempotent
Get an author by ID.
GET /api/authors/{id}
Args:
id: Path parameter.
include: A comma separated list of what to include with the author. The options are items and series. series will only have an effect if items is included. For example, the value items,series will include both library items and series.
Inputs: id (required), include. Returns: result
get_authors_by_id_imageARead-onlyIdempotent
Get an author image by author ID.
GET /api/authors/{id}/image
Args: id: Path parameter.
Inputs: id (required). Returns: result
get_backups_by_id_applyCRead-onlyIdempotent
Get backups apply.
GET /api/backups/{id}/apply
Args: id: Path parameter.
Inputs: id (required). Returns: result
get_backups_by_id_downloadCRead-onlyIdempotent
Get backups download.
GET /api/backups/{id}/download
Args: id: Path parameter.
Inputs: id (required). Returns: result
get_collections_by_idCRead-onlyIdempotent
Get api collections.
GET /api/collections/{id}
Args: id: Path parameter.
Inputs: id (required). Returns: result
get_hls_by_stream_by_fileDRead-onlyIdempotent
Get hls.
GET /hls/{stream}/{file}
Args: stream: Path parameter. file: Path parameter.
Inputs: file (required), stream (required). Returns: result
get_items_by_idCRead-onlyIdempotent
Get api items.
GET /api/items/{id}
Args: id: Path parameter.
Inputs: id (required). Returns: result
get_items_by_id_coverCRead-onlyIdempotent
Get items cover.
GET /api/items/{id}/cover
Args: id: Path parameter.
Inputs: id (required). Returns: result
get_items_by_id_downloadCRead-onlyIdempotent
Get items download.
GET /api/items/{id}/download
Args: id: Path parameter.
Inputs: id (required). Returns: result
get_items_by_id_ebook_by_fileidCRead-onlyIdempotent
Get items ebook.
GET /api/items/{id}/ebook/{fileid}?
Args: id: Path parameter. fileid: Path parameter.
Inputs: id (required), fileid (required). Returns: result
get_items_by_id_ffprobe_by_fileidCRead-onlyIdempotent
Get items ffprobe.
GET /api/items/{id}/ffprobe/{fileid}
Args: id: Path parameter. fileid: Path parameter.
Inputs: id (required), fileid (required). Returns: result
get_items_by_id_file_by_fileidDRead-onlyIdempotent
Get items file.
GET /api/items/{id}/file/{fileid}
Args: id: Path parameter. fileid: Path parameter.
Inputs: id (required), fileid (required). Returns: result
get_items_by_id_file_by_fileid_downloadCRead-onlyIdempotent
Get file download.
GET /api/items/{id}/file/{fileid}/download
Args: id: Path parameter. fileid: Path parameter.
Inputs: id (required), fileid (required). Returns: result
get_items_by_id_metadata_objectCRead-onlyIdempotent
Get items metadata-object.
GET /api/items/{id}/metadata-object
Args: id: Path parameter.
Inputs: id (required). Returns: result
get_libraries_by_idARead-onlyIdempotent
Get a single library by ID on server.
GET /api/libraries/{id}
Args: id: Path parameter. include: Query parameter.
Inputs: id (required), include. Returns: result
get_libraries_by_id_authorsBRead-onlyIdempotent
Get all authors in a library.
GET /api/libraries/{id}/authors
Args: id: Path parameter.
Inputs: id (required). Returns: result
get_libraries_by_id_collectionsCRead-onlyIdempotent
Get libraries collections.
GET /api/libraries/{id}/collections
Args: id: Path parameter.
Inputs: id (required). Returns: result
get_libraries_by_id_downloadCRead-onlyIdempotent
Get libraries download.
GET /api/libraries/{id}/download
Args: id: Path parameter.
Inputs: id (required). Returns: result
get_libraries_by_id_episode_downloadsCRead-onlyIdempotent
Get libraries episode-downloads.
GET /api/libraries/{id}/episode-downloads
Args: id: Path parameter.
Inputs: id (required). Returns: result
get_libraries_by_id_filterdataCRead-onlyIdempotent
Get libraries filterdata.
GET /api/libraries/{id}/filterdata
Args: id: Path parameter.
Inputs: id (required). Returns: result
get_libraries_by_id_itemsBRead-onlyIdempotent
Get items in a library.
GET /api/libraries/{id}/items
Args:
id: Path parameter.
sort: The field to sort by from the request.
filter: The filter for the library.
include: The fields to include in the response. The only current option is rssfeed.
collapse_series: Whether to collapse series into a single cover
Inputs: id (required), sort, filter, include, +1 more. Returns: result
get_libraries_by_id_matchallCRead-onlyIdempotent
Get libraries matchall.
GET /api/libraries/{id}/matchall
Args: id: Path parameter.
Inputs: id (required). Returns: result
get_libraries_by_id_narratorsBRead-onlyIdempotent
Get libraries narrators.
GET /api/libraries/{id}/narrators
Args: id: Path parameter.
Inputs: id (required). Returns: result
get_libraries_by_id_opmlBRead-onlyIdempotent
Get libraries opml.
GET /api/libraries/{id}/opml
Args: id: Path parameter.
Inputs: id (required). Returns: result
get_libraries_by_id_personalizedCRead-onlyIdempotent
Get libraries personalized.
GET /api/libraries/{id}/personalized
Args: id: Path parameter.
Inputs: id (required). Returns: result
get_libraries_by_id_playlistsBRead-onlyIdempotent
Get libraries playlists.
GET /api/libraries/{id}/playlists
Args: id: Path parameter.
Inputs: id (required). Returns: result
get_libraries_by_id_podcast_titlesBRead-onlyIdempotent
Get libraries podcast-titles.
GET /api/libraries/{id}/podcast-titles
Args: id: Path parameter.
Inputs: id (required). Returns: result
get_libraries_by_id_recent_episodesBRead-onlyIdempotent
Get libraries recent-episodes.
GET /api/libraries/{id}/recent-episodes
Args: id: Path parameter.
Inputs: id (required). Returns: result
get_libraries_by_id_searchDRead-onlyIdempotent
Get libraries search.
GET /api/libraries/{id}/search
Args: id: Path parameter.
Inputs: id (required). Returns: result
get_libraries_by_id_seriesBRead-onlyIdempotent
Get library series.
GET /api/libraries/{id}/series
Args:
id: Path parameter.
sort: The field to sort by from the request.
filter: The filter for the library.
include: The fields to include in the response. The only current option is rssfeed.
Inputs: id (required), sort, filter, include. Returns: result
get_libraries_by_id_series_by_series_idARead-onlyIdempotent
Get single series in library.
GET /api/libraries/{id}/series/{seriesId}
Args:
id: Path parameter.
series_id: Path parameter.
sort: The field to sort by from the request.
filter: The filter for the library.
include: The fields to include in the response. The only current option is rssfeed.
Inputs: id (required), series_id (required), sort, filter, +1 more. Returns: result
get_libraries_by_id_statsCRead-onlyIdempotent
Get libraries stats.
GET /api/libraries/{id}/stats
Args: id: Path parameter.
Inputs: id (required). Returns: result
get_me_bookmarks_by_library_item_idCRead-onlyIdempotent
Get me bookmarks.
GET /api/me/bookmarks/{libraryItemId}
Args: library_item_id: Path parameter.
Inputs: library_item_id (required). Returns: result
get_me_item_listening_sessions_by_library_item_id_by_episode_idBRead-onlyIdempotent
Get item listening-sessions.
GET /api/me/item/listening-sessions/{libraryItemId}/{episodeId}?
Args: library_item_id: Path parameter. episode_id: Path parameter.
Inputs: episode_id (required), library_item_id (required). Returns: result
get_me_progress_by_id_by_episode_idDRead-onlyIdempotent
Get me progress.
GET /api/me/progress/{id}/{episodeId}?
Args: id: Path parameter. episode_id: Path parameter.
Inputs: id (required), episode_id (required). Returns: result
get_me_progress_by_id_remove_from_continue_listeningDRead-onlyIdempotent
Get progress remove-from-continue-listening.
GET /api/me/progress/{id}/remove-from-continue-listening
Args: id: Path parameter.
Inputs: id (required). Returns: result
get_me_series_by_id_readd_to_continue_listeningCRead-onlyIdempotent
Get series readd-to-continue-listening.
GET /api/me/series/{id}/readd-to-continue-listening
Args: id: Path parameter.
Inputs: id (required). Returns: result
get_me_series_by_id_remove_from_continue_listeningCRead-onlyIdempotent
Get series remove-from-continue-listening.
GET /api/me/series/{id}/remove-from-continue-listening
Args: id: Path parameter.
Inputs: id (required). Returns: result
get_me_stats_year_by_yearDRead-onlyIdempotent
Get stats year.
GET /api/me/stats/year/{year}
Args: year: Path parameter.
Inputs: year (required). Returns: result
get_notifications_by_id_testCRead-onlyIdempotent
Send a test notification.
GET /api/notifications/{id}/test
Args: id: Path parameter.
Inputs: id (required). Returns: result
get_playlists_by_idBRead-onlyIdempotent
Get api playlists.
GET /api/playlists/{id}
Args: id: Path parameter.
Inputs: id (required). Returns: result
get_podcasts_by_id_checknewCRead-onlyIdempotent
Check and download new episodes.
GET /api/podcasts/{id}/checknew
Args: id: Path parameter. limit: Maximum number of episodes to download
Inputs: id (required), limit. Returns: result
get_podcasts_by_id_clear_queueCRead-onlyIdempotent
Clear episode download queue.
GET /api/podcasts/{id}/clear-queue
Args: id: Path parameter.
Inputs: id (required). Returns: result
get_podcasts_by_id_downloadsBRead-onlyIdempotent
Get episode downloads.
GET /api/podcasts/{id}/downloads
Args: id: Path parameter.
Inputs: id (required). Returns: result
get_podcasts_by_id_episode_by_episode_idARead-onlyIdempotent
Get a specific podcast episode.
GET /api/podcasts/{id}/episode/{episodeId}
Args: id: Path parameter. episode_id: Path parameter.
Inputs: id (required), episode_id (required). Returns: result
get_podcasts_by_id_search_episodeARead-onlyIdempotent
Find episode by title.
GET /api/podcasts/{id}/search-episode
Args: id: Path parameter. title: Title of the episode to search for
Inputs: id (required), title. Returns: result
get_public_session_by_id_track_by_indexCRead-onlyIdempotent
Get session track.
GET /public/session/{id}/track/{index}
Args: id: Path parameter. index: Path parameter.
Inputs: id (required), index (required). Returns: result
get_result_pageARead-onlyIdempotent
Read more of a result that was too large to return in one piece.
Any tool whose answer is too large returns its first page with a
paging block. Pass that block's result_id here. Nothing is fetched
again: the stored result is paged, filtered and narrowed.
Args:
result_id: From the paging block of the earlier answer.
offset: First item to return, usually the previous next_offset.
limit: At most this many items. Fewer come back if they would not fit.
fields: Only these keys of each item. Dots reach nested keys, such as
"statistics.sizeOnDisk". The paging.fields list shows what exists.
match: Keep only items whose field contains this text, ignoring case,
for example {"title": "alien", "year": "1979"}.
path: Which list to page when the result holds several, as named in
paging.lists. Defaults to the largest.
Inputs: result_id (required), path, limit, match, +2 more. Returns: result
get_series_by_idCRead-onlyIdempotent
Get series.
GET /api/series/{id}
Args: id: Path parameter.
Inputs: id (required). Returns: result
get_session_by_idCRead-onlyIdempotent
Get api session.
GET /api/session/{id}
Args: id: Path parameter.
Inputs: id (required). Returns: result
get_stats_year_by_yearCRead-onlyIdempotent
Get stats year.
GET /api/stats/year/{year}
Args: year: Path parameter.
Inputs: year (required). Returns: result
get_users_by_idBRead-onlyIdempotent
Get api users.
GET /api/users/{id}
Args: id: Path parameter.
Inputs: id (required). Returns: result
get_users_by_id_listening_sessionsCRead-onlyIdempotent
Get users listening-sessions.
GET /api/users/{id}/listening-sessions
Args: id: Path parameter.
Inputs: id (required). Returns: result
get_users_by_id_listening_statsBRead-onlyIdempotent
Get users listening-stats.
GET /api/users/{id}/listening-stats
Args: id: Path parameter.
Inputs: id (required). Returns: result
list_api_keysBRead-onlyIdempotent
Get api api-keys.
GET /api/api-keys
Inputs: no named parameters. Returns: result
list_auth_settingsARead-onlyIdempotent
Get api auth-settings.
GET /api/auth-settings
Inputs: no named parameters. Returns: result
list_backupsBRead-onlyIdempotent
Get api backups.
GET /api/backups
Inputs: no named parameters. Returns: result
list_collectionsARead-onlyIdempotent
Get api collections.
GET /api/collections
Inputs: no named parameters. Returns: result
list_custom_metadata_providersCRead-onlyIdempotent
Get api custom-metadata-providers.
GET /api/custom-metadata-providers
Inputs: no named parameters. Returns: result
list_emails_settingsARead-onlyIdempotent
Get email settings.
GET /api/emails/settings
Inputs: no named parameters. Returns: result
list_feedsBRead-onlyIdempotent
Get api feeds.
GET /api/feeds
Inputs: no named parameters. Returns: result
list_filesystemCRead-onlyIdempotent
Get api filesystem.
GET /api/filesystem
Inputs: no named parameters. Returns: result
list_genresBRead-onlyIdempotent
Get api genres.
GET /api/genres
Inputs: no named parameters. Returns: result
list_librariesARead-onlyIdempotent
Get all libraries on server.
GET /api/libraries
Inputs: no named parameters. Returns: result
list_logger_dataCRead-onlyIdempotent
Get api logger-data.
GET /api/logger-data
Inputs: no named parameters. Returns: result
list_meBRead-onlyIdempotent
Get api me.
GET /api/me
Inputs: no named parameters. Returns: result
list_me_bookmarksBRead-onlyIdempotent
Get me bookmarks.
GET /api/me/bookmarks
Inputs: no named parameters. Returns: result
list_me_items_in_progressBRead-onlyIdempotent
Get me items-in-progress.
GET /api/me/items-in-progress
Inputs: no named parameters. Returns: result
list_me_listening_sessionsCRead-onlyIdempotent
Get me listening-sessions.
GET /api/me/listening-sessions
Inputs: no named parameters. Returns: result
list_me_listening_statsBRead-onlyIdempotent
Get me listening-stats.
GET /api/me/listening-stats
Inputs: no named parameters. Returns: result
list_me_progressCRead-onlyIdempotent
Get me progress.
GET /api/me/progress
Inputs: no named parameters. Returns: result
list_me_sessionsCRead-onlyIdempotent
Get me sessions.
GET /api/me/sessions
Inputs: no named parameters. Returns: result
list_notificationdataBRead-onlyIdempotent
Get notification event data.
GET /api/notificationdata
Inputs: no named parameters. Returns: result
list_notificationsARead-onlyIdempotent
Get notification settings.
GET /api/notifications
Inputs: no named parameters. Returns: result
list_notifications_testARead-onlyIdempotent
Send general test notification.
GET /api/notifications/test
Args:
fail: Whether to intentionally cause the notification to fail. 0 for false, 1 for true.
Inputs: fail. Returns: result
list_playlistsBRead-onlyIdempotent
Get api playlists.
GET /api/playlists
Inputs: no named parameters. Returns: result
list_search_authorsCRead-onlyIdempotent
Get search authors.
GET /api/search/authors
Inputs: no named parameters. Returns: result
list_search_booksCRead-onlyIdempotent
Get search books.
GET /api/search/books
Inputs: no named parameters. Returns: result
list_search_chaptersCRead-onlyIdempotent
Get search chapters.
GET /api/search/chapters
Inputs: no named parameters. Returns: result
list_search_coversBRead-onlyIdempotent
Get search covers.
GET /api/search/covers
Inputs: no named parameters. Returns: result
list_search_podcastCRead-onlyIdempotent
Get search podcast.
GET /api/search/podcast
Inputs: no named parameters. Returns: result
list_search_providersARead-onlyIdempotent
Get search providers.
GET /api/search/providers
Inputs: no named parameters. Returns: result
list_sessionsCRead-onlyIdempotent
Get api sessions.
GET /api/sessions
Inputs: no named parameters. Returns: result
list_sessions_openCRead-onlyIdempotent
Get sessions open.
GET /api/sessions/open
Inputs: no named parameters. Returns: result
list_stats_serverCRead-onlyIdempotent
Get stats server.
GET /api/stats/server
Inputs: no named parameters. Returns: result
list_tagsBRead-onlyIdempotent
Get api tags.
GET /api/tags
Inputs: no named parameters. Returns: result
list_tasksCRead-onlyIdempotent
Get api tasks.
GET /api/tasks
Inputs: no named parameters. Returns: result
list_usersBRead-onlyIdempotent
Get api users.
GET /api/users
Inputs: no named parameters. Returns: result
list_users_onlineARead-onlyIdempotent
Get users online.
GET /api/users/online
Inputs: no named parameters. Returns: result
patch_api_keys_by_idBIdempotent
Update api api-keys.
PATCH /api/api-keys/{id}
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), body (required). Returns: result
patch_authors_by_idAIdempotent
Update an author by ID.
PATCH /api/authors/{id}
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), body (required). Returns: result
patch_auth_settingsBIdempotent
Update api auth-settings.
PATCH /api/auth-settings
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required). Returns: result
patch_backups_pathCIdempotent
Update backups path.
PATCH /api/backups/path
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required). Returns: result
patch_collections_by_idAIdempotent
Update api collections.
PATCH /api/collections/{id}
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), body (required). Returns: result
patch_emails_settingsAIdempotent
Update email settings.
PATCH /api/emails/settings
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required). Returns: result
patch_items_by_id_coverAIdempotent
Update items cover.
PATCH /api/items/{id}/cover
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), body (required). Returns: result
patch_items_by_id_ebook_by_fileid_statusBIdempotent
Update ebook status.
PATCH /api/items/{id}/ebook/{fileid}/status
Args: id: Path parameter. fileid: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), body (required), fileid (required). Returns: result
patch_items_by_id_mediaBIdempotent
Update items media.
PATCH /api/items/{id}/media
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), body (required). Returns: result
patch_items_by_id_tracksBIdempotent
Update items tracks.
PATCH /api/items/{id}/tracks
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), body (required). Returns: result
patch_libraries_by_idCIdempotent
Update a single library by ID on server.
PATCH /api/libraries/{id}
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), body (required). Returns: result
patch_libraries_by_id_narrators_by_narrator_idBIdempotent
Update libraries narrators.
PATCH /api/libraries/{id}/narrators/{narratorId}
Args: id: Path parameter. narrator_id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), body (required), narrator_id (required). Returns: result
patch_me_item_by_id_bookmarkBIdempotent
Update item bookmark.
PATCH /api/me/item/{id}/bookmark
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), body (required). Returns: result
patch_me_passwordBIdempotent
Update me password.
PATCH /api/me/password
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required). Returns: result
patch_me_progress_batch_updateCIdempotent
Update batch update.
PATCH /api/me/progress/batch/update
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required). Returns: result
patch_me_progress_by_library_item_id_by_episode_idBIdempotent
Update me progress.
PATCH /api/me/progress/{libraryItemId}/{episodeId}?
Args: library_item_id: Path parameter. episode_id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required), episode_id (required), library_item_id (required). Returns: result
patch_notificationsCIdempotent
Update select notification settings.
PATCH /api/notifications
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required). Returns: result
patch_notifications_by_idBIdempotent
Update a notification.
PATCH /api/notifications/{id}
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), body (required). Returns: result
patch_playlists_by_idBIdempotent
Update api playlists.
PATCH /api/playlists/{id}
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), body (required). Returns: result
patch_podcasts_by_id_episode_by_episode_idBIdempotent
Update a podcast episode.
PATCH /api/podcasts/{id}/episode/{episodeId}
Args: id: Path parameter. episode_id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), body (required), episode_id (required). Returns: result
patch_series_by_idAIdempotent
Update series.
PATCH /api/series/{id}
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), body (required). Returns: result
patch_settingsAIdempotent
Update api settings.
PATCH /api/settings
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required). Returns: result
patch_sorting_prefixesBIdempotent
Update api sorting-prefixes.
PATCH /api/sorting-prefixes
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required). Returns: result
patch_users_by_idAIdempotent
Update api users.
PATCH /api/users/{id}
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), body (required). Returns: result
patch_users_by_id_openid_unlinkCIdempotent
Update users openid-unlink.
PATCH /api/users/{id}/openid-unlink
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), body (required). Returns: result
upload_bookAIdempotent
Upload audio files as a new book, creating the library item.
This is how a book that is not already on the server gets in. Audiobookshelf has no wishlist and cannot fetch a book from a title alone: the files have to exist somewhere this machine can read, and they are sent to the server here.
Args:
library_id: Target library, from list_libraries.
folder_id: Folder within that library, from the library's folders.
title: Book title, which becomes the item name and its folder name.
files: Absolute paths to the audio files on this machine, plus any
cover, ebook or PDF to sit alongside them.
author: Author name, used for the folder structure.
series: Series name, if it belongs to one.
Inputs: files (required), title (required), folder_id (required), library_id (required), +2 more. Returns: result
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
Loading tool schema changelog…
TDQS
Scored across 212 tools
The toolset is mechanically derived from HTTP routes, so the verb often lies: 'create_items_batch_get', 'create_tags_rename', 'create_genres_rename', 'create_authorize', 'create_session_by_id_close' and 'create_watcher_update' are all reads or non-creates exposed under a 'create_' prefix. Several pairs sit adjacently with near-identical names ('get_me_progress_by_id_by_episode_id' vs 'get_me_progress_by_id_remove_from_continue_listening'), and multi-step batch endpoints (batch/scan, batch/update, batch/quickmatch) overlap heavily. An agent would frequently pick the wrong tool or need to consult the route string to disambiguate.
Names are uniformly snake_case and follow a recognizable verb_resource_by_id_path-param pattern, and the list_/get_ split for collections vs. singles is coherent. However the verb is chosen from the HTTP method rather than the action, so 'create_X' covers gets, renames, applies and deletes, and side-effecting GETs like 'get_backups_by_id_apply' read as pure reads. The convention is readable but semantically unreliable.
212 tools is far beyond any reasonable agent-facing surface and is essentially a 1:1 dump of the REST API, including trivial variants (cover, download, track, ffprobe, ebook/status). Most of these would be composed by a handful of higher-level tools, and the sheer count makes selection and context management impractical.
Coverage of the Audiobookshelf domain is broad — items, libraries, collections, playlists, podcasts/episodes, series, authors, users, sessions, backups, notifications, feeds, search, stats and tools — with CRUD on most resources. The main gap is that nearly every description tells the agent to 'read the matching GET or the /schema endpoint' but no schema tool is exposed, leaving payload shapes undiscoverable; a handful of mutations are oddly modeled as GETs.
Maintenance
Related MCP Connectors
Manage Redbooth tasks, task lists, comments, tags and files from Claude and other AI assistants.
Agent personas for Claude. 16 tools, 13 personas, 3 workflows. Zero extra API cost. Free.
Lets Claude, ChatGPT, and Muse read and update your beckett tasks, notes, calendar, and lists.
Every Canopy public API operation as a tool, run as you after a browser sign-in or on an API key.
Related MCP Servers
- AlicenseBqualityBmaintenanceConnects BookStack knowledge bases to Claude through 47+ tools covering complete CRUD operations for books, pages, chapters, shelves, users, search, attachments, and permissions. Enables full management of BookStack content and configuration through natural language.56394 npm104MIT
- AlicenseNot gradedqualityCmaintenanceBridges any OpenAPI 3.x REST API to Claude Code by automatically generating one tool per endpoint from your spec, with full argument validation and auth support.14 npmMIT
- AlicenseCqualityBmaintenanceEnables full control of Sonarr from Claude.ai and Claude Code by exposing all 234 v3 API operations as tools for managing media libraries.23523 npmMIT
- AlicenseCqualityBmaintenanceEnables running Overseerr or Jellyseerr from Claude.ai and Claude Code, with all 170 API operations exposed as tools for managing requests, settings, users, issues, and media services.171MIT