Audiobookshelf icon

Audiobookshelf

Work with the Audiobookshelf API

Overview

The node interacts with the Audiobookshelf API to retrieve collections from a specified library. It is useful for scenarios where you want to programmatically access and manage audiobook collections stored in an Audiobookshelf library, such as fetching all collections or a subset based on certain criteria.

Practical examples include:

  • Automatically syncing audiobook collections metadata into another system.
  • Displaying user-specific audiobook collections in a custom dashboard.
  • Filtering collections that include RSS feed data for podcast-like consumption.

Properties

Name Meaning
Library ID The unique identifier of the library from which to fetch collections.
Include RSS Feed Whether to include RSS feed data in the output. Boolean: true to include, false to exclude.
Return All Whether to return all collections or limit the number of results. Boolean: true returns all, false limits results.
Limit Maximum number of collections to return when Return All is false. Minimum value is 1.

Output

The node outputs JSON data representing the collections retrieved from the specified library. Each collection object typically includes metadata about the collection such as its ID, title, description, and optionally RSS feed data if requested.

If the "Include RSS Feed" option is enabled, the output will contain additional fields related to the RSS feed associated with each collection.

No binary data output is indicated by the source code.

Dependencies

  • Requires connection to an Audiobookshelf instance via its API.
  • Needs an API authentication token configured in the node credentials.
  • The base URL for API requests is derived from the provided domain credential.

Troubleshooting

  • Common issues:

    • Invalid or missing Library ID will result in no data or errors.
    • Incorrect API credentials or domain configuration can cause authentication failures.
    • Requesting too many items without proper limits may lead to timeouts or rate limiting.
  • Error messages:

    • Authentication errors usually indicate invalid or missing API tokens; verify credentials.
    • "Not Found" errors suggest the Library ID does not exist or is inaccessible.
    • Rate limit errors require reducing request frequency or enabling pagination with limits.

Links and References

Discussion