BookStack icon

BookStack

Consume BookStack API
Join our community

Actions56

Overview

This node integrates with the BookStack API to manage various BookStack resources such as books, pages, chapters, shelves, users, roles, attachments, and tags. Specifically, for the Chapter resource with the Get Many operation, it retrieves a list of chapters from the BookStack system.

The node supports two modes of operation:

  • Automatic mode: You provide a natural language description of your request (e.g., "List all chapters in book X"), and the node attempts to parse and determine the appropriate resource and operation automatically.
  • Manual mode: You explicitly select the resource ("Chapter") and operation ("Get Many") yourself.

This node is useful when you want to programmatically fetch multiple chapters from BookStack, for example, to display them in another system, analyze their content, or synchronize data.

Practical examples

  • Retrieve all chapters in a specific book to generate a table of contents elsewhere.
  • List all chapters to audit or export chapter metadata.
  • Use the automatic mode by describing your request in plain text, e.g., "List all chapters in book 'API Documentation'".

Properties

Name Meaning
Tool Description Choose how to determine the resource and operation:
- Set Automatically: Describe your request in natural language and let the node decide.
- Set Manually: Select resource and operation explicitly.
Request Description (Shown only if "Set Automatically" is selected) A string where you describe what you want to do, e.g., "List all chapters in book X". The node uses this to infer the resource and operation.

Note: For the Get Many operation on the Chapter resource, no additional parameters are required beyond these properties.

Output

The node outputs an array of JSON objects representing the retrieved chapters. Each item corresponds to one chapter resource as returned by the BookStack API under the data property.

Typical structure of each chapter object includes fields like:

  • id: Unique identifier of the chapter.
  • name: Name/title of the chapter.
  • Other metadata fields as provided by the BookStack API.

If the node is configured to paginate, it will handle fetching multiple pages of results transparently, returning all chapters matching the query.

The node does not output binary data for this operation.

Dependencies

  • Requires connection to a BookStack instance via its API.
  • Needs an API token credential with appropriate permissions to read chapters.
  • The base URL and authentication tokens must be configured in the node credentials.
  • The node uses HTTP requests with token-based authorization headers.

Troubleshooting

  • Common issues:

    • Incorrect or missing API credentials will cause authentication failures.
    • If the BookStack base URL is incorrect or unreachable, the node will fail to connect.
    • Using automatic mode with ambiguous or unclear descriptions may lead to incorrect resource/operation detection.
    • Pagination limits might restrict the number of chapters returned per request; ensure pagination settings meet your needs.

  • Error messages:

    • Authentication errors typically indicate invalid or expired API tokens.
    • HTTP 404 errors may mean the requested resource or endpoint does not exist.
    • Parsing errors in automatic mode suggest the description was not understood; try simplifying or switching to manual mode.

Links and References

Discussion