BookStack icon

BookStack

Consume BookStack API
Join our community

Actions56

Overview

This node integrates with the BookStack API, allowing users to manage BookStack resources such as books, pages, chapters, shelves, users, roles, attachments, and tags. It supports a variety of operations including creating, retrieving, updating, deleting, copying, moving, and listing these resources.

The node can operate in two modes:

  • Automatic mode: Users provide a natural language description of their request (e.g., "Create a new page about API documentation"), and the node attempts to infer the appropriate resource and operation.
  • Manual mode: Users explicitly select the resource and operation and provide required parameters.

Use cases:

  • Automatically create or update content in BookStack by describing the desired action in plain text.
  • Retrieve detailed information about a specific book or other resource by ID.
  • List all books, pages, or chapters for overview or reporting.
  • Manage organizational structure by moving or copying resources between shelves or books.
  • Delete obsolete or unwanted resources.

Example: A user wants to get details of a book with ID 123. In manual mode, they select Resource = Book, Operation = Get, and enter ID = 123. The node fetches the book data from BookStack.

Properties

Name Meaning
Tool Description Choose how to determine the resource and operation:
- Set Automatically: Describe your request in natural language; the node infers resource and operation.
- Set Manually: Select resource and operation explicitly.
Request Description (Shown only if Tool Description is "Set Automatically") Provide a natural language description of what you want to do, e.g., "Create a new page about API documentation". The system uses this to select resource and operation automatically.
ID (Required for Get, Update, Delete operations) The unique identifier of the resource to act upon.

Output

The node outputs an array of items where each item contains a json field representing the response from the BookStack API for the requested operation.

  • For Get operations on a Book resource, the json output will contain the detailed properties of the book retrieved from BookStack, such as its name, description, creation date, etc.
  • For other operations, the output JSON reflects the API response corresponding to the action performed (e.g., confirmation of deletion, updated resource data).
  • The node does not output binary data.

Dependencies

  • Requires connection credentials for the BookStack API, including:
    • Base URL of the BookStack instance.
    • An API token and secret for authentication.
  • The node uses HTTP requests authenticated via these credentials.
  • No additional external dependencies are required.

Troubleshooting

  • Common issues:

    • Incorrect or missing resource ID when performing Get, Update, or Delete operations will cause errors.
    • Invalid or expired API tokens will result in authentication failures.
    • Improperly formatted natural language descriptions may lead to incorrect automatic detection of resource or operation.
    • Network connectivity issues to the BookStack server will cause request failures.

  • Error messages and resolutions:

    • "Resource ID is required" — Ensure the ID parameter is provided for operations that need it.
    • Authentication errors — Verify API token and base URL credentials are correct and have sufficient permissions.
    • "Resource not found" — Confirm the resource ID exists in BookStack.
    • Unexpected responses or empty results — Check the correctness of the request description or switch to manual mode for precise control.

Links and References

Discussion