Audiobookshelf icon

Audiobookshelf

Work with the Audiobookshelf API

Overview

This node interacts with the Audiobookshelf API to retrieve detailed information about a specific library item. It is useful when you want to fetch metadata or additional data related to an audiobook, podcast, or other media stored in your Audiobookshelf library.

Common scenarios include:

  • Fetching detailed information about a particular audiobook or podcast episode.
  • Retrieving progress data for a user on a specific library item.
  • Getting associated authors or download statistics for books and podcasts.

For example, you might use this node to get the current listening progress of a podcast episode or to list all authors of a book in your library.

Properties

Name Meaning
Library Item ID The unique identifier of the library item to retrieve. This is required.
Options A collection of optional parameters to customize the request:
- Expanded Boolean flag indicating whether to expand the response with additional details (default: true).
- Include List of additional data to include with the library item. Possible values: Progress, RSS Feed, Authors, Downloads. "Authors" applies only to books; "Downloads" applies only to podcasts.
- Episode If requesting progress for a podcast, specify the episode ID to get progress for that episode.

Output

The node outputs JSON data representing the requested library item with optional expanded details depending on the options selected. The structure typically includes metadata about the item such as title, type, authors (if included), progress (if requested), RSS feed info (for podcasts), and download stats (for podcasts).

If binary data were involved (not indicated here), it would represent media files or attachments, but this node focuses on JSON metadata output.

Dependencies

  • Requires an API key credential for authenticating with the Audiobookshelf API.
  • Needs the base URL of the Audiobookshelf instance configured in credentials.
  • No other external dependencies are indicated.

Troubleshooting

  • Missing or invalid Library Item ID: Ensure the ID provided is correct and exists in your Audiobookshelf library.
  • Authentication errors: Verify that the API key credential is valid and has appropriate permissions.
  • Invalid option combinations: For example, including "Authors" when the item is not a book or "Downloads" when the item is not a podcast may result in incomplete or empty data.
  • Episode parameter misuse: When requesting progress for podcasts, ensure the episode ID is specified correctly; otherwise, progress data may be missing.

Links and References

Discussion