bookshelf_media_library
Manage your Bookshelf media library: pass an operation and arguments dict to read, write, bulk update, or delete authors, books, bookfiles, editions, and series.
Instructions
bookshelf media library operations on Bookshelf. Pass operation and an arguments dict matching that operation's parameters.
bookshelf_add_books_to_shelf(body={}) — Add the given books to a Goodreads/Hardcover shelf. Body is a BookshelfResource with bookshelfId and bookIds.
bookshelf_bulk_delete_author(body={}) — Bulk delete author editor. DESTRUCTIVE: this deletes data.
bookshelf_bulk_delete_book(body={}) — Bulk delete book editor. DESTRUCTIVE: this deletes data.
bookshelf_bulk_delete_bookfile(body={}) — Bulk delete bookfile bulk. DESTRUCTIVE: this deletes data.
bookshelf_bulk_update_author(body={}) — Bulk update author editor. WRITE: this modifies your Bookshelf instance.
bookshelf_bulk_update_book(body={}) — Bulk update book editor. WRITE: this modifies your Bookshelf instance.
bookshelf_bulk_update_bookfile(body={}) — Bulk update bookfile editor. WRITE: this modifies your Bookshelf instance.
bookshelf_commit_manual_import(body=[]) — Commit manual imports for the given files. Body is a list of ManualImportUpdateResource. WRITE: this modifies your Bookshelf instance.
bookshelf_create_author(body={}) — Create author. WRITE: this modifies your Bookshelf instance.
bookshelf_create_book(body={}) — Create book. WRITE: this modifies your Bookshelf instance.
bookshelf_delete_author(id, delete_files=False, add_import_list_exclusion=False) — Delete author. Query params: deleteFiles, addImportListExclusion. DESTRUCTIVE: this deletes data.
bookshelf_delete_book(id, delete_files=False, add_import_list_exclusion=False) — Delete book. Query params: deleteFiles, addImportListExclusion. DESTRUCTIVE: this deletes data.
bookshelf_delete_bookfile(id) — Delete bookfile. DESTRUCTIVE: this deletes data.
bookshelf_get_author(id) — Fetch a single author by id.
bookshelf_get_book(id) — Fetch a single book by id.
bookshelf_get_book_overview(id) — Fetch a single book overview by id.
bookshelf_get_bookfile(id) — Fetch a single bookfile by id.
bookshelf_get_parse(title=None) — Parse a file or release title and show how Bookshelf interprets it.
bookshelf_get_rename(author_id=None, book_id=None) — List proposed renames for an author or book (files that would be renamed on the next rename task).
bookshelf_get_retag(author_id=None, book_id=None) — List proposed file retags for an author or book.
bookshelf_list_author() — List author.
bookshelf_list_book(author_id=None, book_ids=None, title_slug=None, include_all_author_books=False) — List book. Query params: authorId, bookIds, titleSlug, includeAllAuthorBooks.
bookshelf_list_bookfile(author_id=None, book_file_ids=None, book_id=None, unmapped=None) — List bookfile. Query params: authorId, bookFileIds, bookId, unmapped.
bookshelf_list_edition(book_id=None) — List edition. Query params: bookId.
bookshelf_list_manualimport(folder=None, download_id=None, author_id=None, filter_existing_files=True, replace_existing_files=True) — List manualimport. Query params: folder, downloadId, authorId, filterExistingFiles, replaceExistingFiles.
bookshelf_list_series(author_id=None) — List series. Query params: authorId.
bookshelf_lookup_author(term=None) — Search the metadata provider for authors by term.
bookshelf_lookup_book(term=None) — Search the metadata provider for books by term.
bookshelf_search(term=None) — Search for new books/authors on the metadata provider by term and return the matches to add.
bookshelf_update_author(id, move_files=False, body={}) — Update author. Query params: moveFiles. WRITE: this modifies your Bookshelf instance.
bookshelf_update_book(id, body={}) — Update book. WRITE: this modifies your Bookshelf instance.
bookshelf_update_bookfile(id, body={}) — Update bookfile. WRITE: this modifies your Bookshelf instance.
bookshelf_update_books_monitored(body={}) — Set the monitored state of books in bulk. Body is a BooksMonitoredResource with bookIds and monitored.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| arguments | No | ||
| operation | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |