BookStack icon

BookStack

Consume BookStack API

Actions40

Overview

This node integrates with the BookStack API, a platform for creating and managing documentation content such as books, pages, chapters, shelves, users, roles, attachments, and tags. The node allows users to perform various operations on these resources, including creating, retrieving (single or multiple), updating, deleting, exporting, and searching.

Specifically, the Shelf - Get Many operation retrieves multiple shelf resources from the BookStack system. This is useful when you want to list all shelves or filter them based on certain criteria. For example, you might use this operation to display all book collections (shelves) available in your documentation system or to synchronize shelf data with another tool.

The node supports two modes of operation selection:

  • Automatic mode: You describe what you want to do in natural language, and the node attempts to infer the resource and operation.
  • Manual mode: You explicitly select the resource ("Shelf") and operation ("Get Many").

Properties

Name Meaning
Tool Description Choose how to determine the resource and operation: either "Set Automatically" or "Set Manually".
Request Description When "Set Automatically" is selected, provide a natural language description of the request (e.g., "List all shelves"). The system uses this to infer the resource and operation.

Note: Since the user specified Resource = Shelf and Operation = Get Many, only these properties are relevant here.

Output

The output is an array of JSON objects representing the retrieved shelf resources. Each item corresponds to one shelf and contains its details as returned by the BookStack API under the data property.

The exact structure depends on the BookStack API response but typically includes fields like shelf ID, name, description, creation date, and other metadata.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the BookStack API.
  • The base URL and tokens must be configured in the node credentials.
  • The node uses HTTP requests with authentication headers to communicate with the BookStack API.
  • Pagination is supported via offset and limit query parameters, with a default page size of 100 items.

Troubleshooting

  • Common issues:

    • Incorrect or missing API credentials will cause authentication failures.
    • Providing an invalid base URL or token will result in connection errors.
    • If the automatic mode fails to correctly detect the resource or operation from the description, results may be unexpected or empty.

  • Error messages:

    • Authentication errors usually indicate invalid or expired tokens; verify and update credentials.
    • HTTP 404 errors may occur if the requested resource path is incorrect; ensure the resource and operation are properly set.
    • Network timeouts or connectivity issues should be checked in the environment where n8n runs.

  • Resolutions:

    • Double-check API credentials and base URL configuration.
    • Use manual mode if automatic detection does not work reliably.
    • Review the request description for clarity and keywords that help detection.

Links and References

Discussion