Skip to main content
Glama
Audiobookshelf MCP server

Audiobookshelf MCP server

by rollecode

Audiobookshelf MCP server

Version Python Audiobookshelf Coverage

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.

WARNING

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 docs/openapi.json

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.py

45 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

list_*

Read a collection

list_api_libraries, list_api_me

get_*_by_id

Read one record

list_api_libraries_by_id

create_*

POST

create_api_libraries

update_*

PATCH

update_api_libraries_by_id

delete_*

DELETE

delete_api_libraries_by_id

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 token

Claude Code

claude mcp add audiobookshelf -- /path/to/audiobookshelf-mcp/.venv/bin/audiobookshelf-mcp

Writing

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

audiobookshelf-mcp

8570

The server. No login of its own, never exposed

nginx

8571

Front door, behind a Cloudflare Tunnel

auth-server.js

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/env

Copy systemd/*.service into /etc/systemd/system/, replacing YOUR_USER and the ISSUER hostname, then:

sudo systemctl enable --now audiobookshelf-mcp audiobookshelf-mcp-auth

Point 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 tools
add_podcast_from_feedA
Idempotent

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_keysC
Idempotent

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_authorizeC
Idempotent

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_imageA
Idempotent

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_matchB
Idempotent

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_backupsC
Idempotent

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_uploadC
Idempotent

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_purgeD
Idempotent

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_purgeC
Idempotent

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_collectionsC
Idempotent

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_addC
Idempotent

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_removeC
Idempotent

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_bookC
Idempotent

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_providersB
Idempotent

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_devicesC
Idempotent

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_deviceB
Idempotent

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_testB
Idempotent

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_closeC
Idempotent

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_openC
Idempotent

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_openC
Idempotent

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_openC
Idempotent

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_pathexistsD
Idempotent

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_renameD
Idempotent

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_deleteD
Idempotent

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_getD
Idempotent

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_quickmatchC
Idempotent

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_scanC
Idempotent

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_updateC
Idempotent

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_chaptersC
Idempotent

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_coverC
Idempotent

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_matchC
Idempotent

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_playC
Idempotent

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_idD
Idempotent

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_scanC
Idempotent

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_librariesA
Idempotent

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_metadataC
Idempotent

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_scanC
Idempotent

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_orderC
Idempotent

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_devicesC
Idempotent

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_bookmarkC
Idempotent

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_notificationsC
Idempotent

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_playlistsC
Idempotent

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_addD
Idempotent

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_removeC
Idempotent

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_itemC
Idempotent

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_idC
Idempotent

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_podcastsA
Idempotent

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_episodesA
Idempotent

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_episodesB
Idempotent

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_feedC
Idempotent

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_createB
Idempotent

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_parseB
Idempotent

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_closeB
Idempotent

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_syncC
Idempotent

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_localC
Idempotent

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_allC
Idempotent

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_deleteC
Idempotent

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_share_mediaitemC
Idempotent

Create or act on share mediaitem.

POST /api/share/mediaitem

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_renameC
Idempotent

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_metadataC
Idempotent

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_metadataC
Idempotent

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_m4bC
Idempotent

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_uploadC
Idempotent

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_usersB
Idempotent

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_cronC
Idempotent

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_updateC
Idempotent

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_idC
DestructiveIdempotent

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_idA
DestructiveIdempotent

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_imageA
DestructiveIdempotent

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_idB
DestructiveIdempotent

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_idB
DestructiveIdempotent

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_idC
DestructiveIdempotent

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_idB
DestructiveIdempotent

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_genreC
DestructiveIdempotent

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_idC
DestructiveIdempotent

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_coverB
DestructiveIdempotent

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_fileidB
DestructiveIdempotent

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_idA
DestructiveIdempotent

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_issuesA
DestructiveIdempotent

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_idC
DestructiveIdempotent

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_timeB
DestructiveIdempotent

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_idB
DestructiveIdempotent

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_idB
DestructiveIdempotent

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_idA
DestructiveIdempotent

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_idC
DestructiveIdempotent

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_idC
DestructiveIdempotent

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_idA
DestructiveIdempotent

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_idB
DestructiveIdempotent

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_share_mediaitem_by_idA
DestructiveIdempotent

Delete share mediaitem.

DELETE /api/share/mediaitem/{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_tagB
DestructiveIdempotent

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_m4bB
DestructiveIdempotent

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_idA
DestructiveIdempotent

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_idA
Read-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_imageA
Read-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_applyC
Read-onlyIdempotent

Get backups apply.

GET /api/backups/{id}/apply

Args: id: Path parameter.

Inputs: id (required). Returns: result

get_backups_by_id_downloadC
Read-onlyIdempotent

Get backups download.

GET /api/backups/{id}/download

Args: id: Path parameter.

Inputs: id (required). Returns: result

get_collections_by_idC
Read-onlyIdempotent

Get api collections.

GET /api/collections/{id}

Args: id: Path parameter.

Inputs: id (required). Returns: result

get_hls_by_stream_by_fileD
Read-onlyIdempotent

Get hls.

GET /hls/{stream}/{file}

Args: stream: Path parameter. file: Path parameter.

Inputs: file (required), stream (required). Returns: result

get_items_by_idC
Read-onlyIdempotent

Get api items.

GET /api/items/{id}

Args: id: Path parameter.

Inputs: id (required). Returns: result

get_items_by_id_coverC
Read-onlyIdempotent

Get items cover.

GET /api/items/{id}/cover

Args: id: Path parameter.

Inputs: id (required). Returns: result

get_items_by_id_downloadC
Read-onlyIdempotent

Get items download.

GET /api/items/{id}/download

Args: id: Path parameter.

Inputs: id (required). Returns: result

get_items_by_id_ebook_by_fileidC
Read-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_fileidC
Read-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_fileidD
Read-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_downloadC
Read-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_objectC
Read-onlyIdempotent

Get items metadata-object.

GET /api/items/{id}/metadata-object

Args: id: Path parameter.

Inputs: id (required). Returns: result

get_libraries_by_idA
Read-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_authorsB
Read-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_collectionsC
Read-onlyIdempotent

Get libraries collections.

GET /api/libraries/{id}/collections

Args: id: Path parameter.

Inputs: id (required). Returns: result

get_libraries_by_id_downloadC
Read-onlyIdempotent

Get libraries download.

GET /api/libraries/{id}/download

Args: id: Path parameter.

Inputs: id (required). Returns: result

get_libraries_by_id_episode_downloadsC
Read-onlyIdempotent

Get libraries episode-downloads.

GET /api/libraries/{id}/episode-downloads

Args: id: Path parameter.

Inputs: id (required). Returns: result

get_libraries_by_id_filterdataC
Read-onlyIdempotent

Get libraries filterdata.

GET /api/libraries/{id}/filterdata

Args: id: Path parameter.

Inputs: id (required). Returns: result

get_libraries_by_id_itemsB
Read-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_matchallC
Read-onlyIdempotent

Get libraries matchall.

GET /api/libraries/{id}/matchall

Args: id: Path parameter.

Inputs: id (required). Returns: result

get_libraries_by_id_narratorsB
Read-onlyIdempotent

Get libraries narrators.

GET /api/libraries/{id}/narrators

Args: id: Path parameter.

Inputs: id (required). Returns: result

get_libraries_by_id_opmlB
Read-onlyIdempotent

Get libraries opml.

GET /api/libraries/{id}/opml

Args: id: Path parameter.

Inputs: id (required). Returns: result

get_libraries_by_id_personalizedC
Read-onlyIdempotent

Get libraries personalized.

GET /api/libraries/{id}/personalized

Args: id: Path parameter.

Inputs: id (required). Returns: result

get_libraries_by_id_playlistsB
Read-onlyIdempotent

Get libraries playlists.

GET /api/libraries/{id}/playlists

Args: id: Path parameter.

Inputs: id (required). Returns: result

get_libraries_by_id_podcast_titlesB
Read-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_episodesB
Read-onlyIdempotent

Get libraries recent-episodes.

GET /api/libraries/{id}/recent-episodes

Args: id: Path parameter.

Inputs: id (required). Returns: result

get_libraries_by_id_seriesB
Read-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_idA
Read-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_statsC
Read-onlyIdempotent

Get libraries stats.

GET /api/libraries/{id}/stats

Args: id: Path parameter.

Inputs: id (required). Returns: result

get_me_bookmarks_by_library_item_idC
Read-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_idB
Read-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_idD
Read-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_listeningD
Read-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_listeningC
Read-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_listeningC
Read-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_yearD
Read-onlyIdempotent

Get stats year.

GET /api/me/stats/year/{year}

Args: year: Path parameter.

Inputs: year (required). Returns: result

get_notifications_by_id_testC
Read-onlyIdempotent

Send a test notification.

GET /api/notifications/{id}/test

Args: id: Path parameter.

Inputs: id (required). Returns: result

get_playlists_by_idB
Read-onlyIdempotent

Get api playlists.

GET /api/playlists/{id}

Args: id: Path parameter.

Inputs: id (required). Returns: result

get_podcasts_by_id_checknewC
Read-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_queueC
Read-onlyIdempotent

Clear episode download queue.

GET /api/podcasts/{id}/clear-queue

Args: id: Path parameter.

Inputs: id (required). Returns: result

get_podcasts_by_id_downloadsB
Read-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_idA
Read-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_episodeA
Read-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_indexC
Read-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_public_share_by_slugC
Read-onlyIdempotent

Get public share.

GET /public/share/{slug}

Args: slug: Path parameter.

Inputs: slug (required). Returns: result

get_public_share_by_slug_coverC
Read-onlyIdempotent

Get share cover.

GET /public/share/{slug}/cover

Args: slug: Path parameter.

Inputs: slug (required). Returns: result

get_public_share_by_slug_downloadC
Read-onlyIdempotent

Get share download.

GET /public/share/{slug}/download

Args: slug: Path parameter.

Inputs: slug (required). Returns: result

get_public_share_by_slug_track_by_indexC
Read-onlyIdempotent

Get share track.

GET /public/share/{slug}/track/{index}

Args: slug: Path parameter. index: Path parameter.

Inputs: slug (required), index (required). Returns: result

get_result_pageA
Read-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_idC
Read-onlyIdempotent

Get series.

GET /api/series/{id}

Args: id: Path parameter.

Inputs: id (required). Returns: result

get_session_by_idC
Read-onlyIdempotent

Get api session.

GET /api/session/{id}

Args: id: Path parameter.

Inputs: id (required). Returns: result

get_stats_year_by_yearC
Read-onlyIdempotent

Get stats year.

GET /api/stats/year/{year}

Args: year: Path parameter.

Inputs: year (required). Returns: result

get_users_by_idB
Read-onlyIdempotent

Get api users.

GET /api/users/{id}

Args: id: Path parameter.

Inputs: id (required). Returns: result

get_users_by_id_listening_sessionsC
Read-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_statsB
Read-onlyIdempotent

Get users listening-stats.

GET /api/users/{id}/listening-stats

Args: id: Path parameter.

Inputs: id (required). Returns: result

list_api_keysB
Read-onlyIdempotent

Get api api-keys.

GET /api/api-keys

Inputs: no named parameters. Returns: result

list_auth_settingsA
Read-onlyIdempotent

Get api auth-settings.

GET /api/auth-settings

Inputs: no named parameters. Returns: result

list_backupsB
Read-onlyIdempotent

Get api backups.

GET /api/backups

Inputs: no named parameters. Returns: result

list_collectionsA
Read-onlyIdempotent

Get api collections.

GET /api/collections

Inputs: no named parameters. Returns: result

list_custom_metadata_providersC
Read-onlyIdempotent

Get api custom-metadata-providers.

GET /api/custom-metadata-providers

Inputs: no named parameters. Returns: result

list_emails_settingsA
Read-onlyIdempotent

Get email settings.

GET /api/emails/settings

Inputs: no named parameters. Returns: result

list_feedsB
Read-onlyIdempotent

Get api feeds.

GET /api/feeds

Inputs: no named parameters. Returns: result

list_filesystemC
Read-onlyIdempotent

Get api filesystem.

GET /api/filesystem

Inputs: no named parameters. Returns: result

list_genresB
Read-onlyIdempotent

Get api genres.

GET /api/genres

Inputs: no named parameters. Returns: result

list_librariesA
Read-onlyIdempotent

Get all libraries on server.

GET /api/libraries

Inputs: no named parameters. Returns: result

list_logger_dataC
Read-onlyIdempotent

Get api logger-data.

GET /api/logger-data

Inputs: no named parameters. Returns: result

list_meB
Read-onlyIdempotent

Get api me.

GET /api/me

Inputs: no named parameters. Returns: result

list_me_bookmarksB
Read-onlyIdempotent

Get me bookmarks.

GET /api/me/bookmarks

Inputs: no named parameters. Returns: result

list_me_items_in_progressB
Read-onlyIdempotent

Get me items-in-progress.

GET /api/me/items-in-progress

Inputs: no named parameters. Returns: result

list_me_listening_sessionsC
Read-onlyIdempotent

Get me listening-sessions.

GET /api/me/listening-sessions

Inputs: no named parameters. Returns: result

list_me_listening_statsB
Read-onlyIdempotent

Get me listening-stats.

GET /api/me/listening-stats

Inputs: no named parameters. Returns: result

list_me_progressC
Read-onlyIdempotent

Get me progress.

GET /api/me/progress

Inputs: no named parameters. Returns: result

list_me_sessionsC
Read-onlyIdempotent

Get me sessions.

GET /api/me/sessions

Inputs: no named parameters. Returns: result

list_notificationdataB
Read-onlyIdempotent

Get notification event data.

GET /api/notificationdata

Inputs: no named parameters. Returns: result

list_notificationsA
Read-onlyIdempotent

Get notification settings.

GET /api/notifications

Inputs: no named parameters. Returns: result

list_notifications_testA
Read-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_playlistsB
Read-onlyIdempotent

Get api playlists.

GET /api/playlists

Inputs: no named parameters. Returns: result

list_search_authorsC
Read-onlyIdempotent

Get search authors.

GET /api/search/authors

Inputs: no named parameters. Returns: result

list_search_booksC
Read-onlyIdempotent

Get search books.

GET /api/search/books

Inputs: no named parameters. Returns: result

list_search_chaptersC
Read-onlyIdempotent

Get search chapters.

GET /api/search/chapters

Inputs: no named parameters. Returns: result

list_search_coversB
Read-onlyIdempotent

Get search covers.

GET /api/search/covers

Inputs: no named parameters. Returns: result

list_search_podcastC
Read-onlyIdempotent

Get search podcast.

GET /api/search/podcast

Inputs: no named parameters. Returns: result

list_search_providersA
Read-onlyIdempotent

Get search providers.

GET /api/search/providers

Inputs: no named parameters. Returns: result

list_sessionsC
Read-onlyIdempotent

Get api sessions.

GET /api/sessions

Inputs: no named parameters. Returns: result

list_sessions_openC
Read-onlyIdempotent

Get sessions open.

GET /api/sessions/open

Inputs: no named parameters. Returns: result

list_stats_serverC
Read-onlyIdempotent

Get stats server.

GET /api/stats/server

Inputs: no named parameters. Returns: result

list_tagsB
Read-onlyIdempotent

Get api tags.

GET /api/tags

Inputs: no named parameters. Returns: result

list_tasksC
Read-onlyIdempotent

Get api tasks.

GET /api/tasks

Inputs: no named parameters. Returns: result

list_usersB
Read-onlyIdempotent

Get api users.

GET /api/users

Inputs: no named parameters. Returns: result

list_users_onlineA
Read-onlyIdempotent

Get users online.

GET /api/users/online

Inputs: no named parameters. Returns: result

patch_api_keys_by_idB
Idempotent

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_idA
Idempotent

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_settingsB
Idempotent

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_pathC
Idempotent

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_idA
Idempotent

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_settingsA
Idempotent

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_coverA
Idempotent

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_statusB
Idempotent

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_mediaB
Idempotent

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_tracksB
Idempotent

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_idC
Idempotent

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_idB
Idempotent

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_bookmarkB
Idempotent

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_passwordB
Idempotent

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_updateC
Idempotent

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_idB
Idempotent

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_notificationsC
Idempotent

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_idB
Idempotent

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_idB
Idempotent

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_idB
Idempotent

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_public_share_by_slug_progressA
Idempotent

Update share progress.

PATCH /public/share/{slug}/progress

Args: slug: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.

Inputs: body (required), slug (required). Returns: result

patch_series_by_idA
Idempotent

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_settingsA
Idempotent

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_prefixesB
Idempotent

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_idA
Idempotent

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

upload_bookA
Idempotent

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

    C2.4/5.0

    Scored across 212 tools

    Disambiguation2/5

    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.

    Naming Consistency3/5

    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.

    Tool Count1/5

    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.

    Completeness4/5

    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

    ActivitySlowing
    ResponsivenessNo recent community issues

    Related MCP Connectors

    Related MCP Servers

    • A
      license
      B
      quality
      B
      maintenance
      Connects 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.
      56
      394 npm
      104
      MIT
    • A
      license
      C
      quality
      B
      maintenance
      Enables full control of Sonarr from Claude.ai and Claude Code by exposing all 234 v3 API operations as tools for managing media libraries.
      235
      23 npm
      MIT
    • A
      license
      C
      quality
      B
      maintenance
      Enables 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.
      171
      MIT