BookStack

Consume BookStack API

Actions40

Overview

This node integrates with the BookStack API to manage "Shelf" resources, specifically enabling the creation of new shelves. It supports both automatic and manual modes for specifying the operation details:

Automatic mode: You provide a natural language description of your request (e.g., "Create a new shelf about JavaScript books"), and the node parses this description to determine the resource and operation, as well as to generate the necessary data fields.
Manual mode: You explicitly specify the resource ("Shelf") and operation ("Create") along with required properties.

This node is useful in scenarios where you want to programmatically organize collections of books into shelves within BookStack, either by direct input or by describing your intent in plain language. For example, you could automate the creation of categorized shelves for different topics or projects.

Properties

Name	Meaning
Tool Description	Choose how to determine the resource and operation: "Set Automatically" or "Set Manually".
Request Description	(Shown only if "Set Automatically" is selected) Describe your request in natural language; the system will parse it to select resource and operation automatically. Example: "Create a new shelf about programming books".
Name	The name of the shelf to create. This is a required field when creating or updating a shelf.
Description	An optional description of the shelf providing additional context or details.

Output

The node outputs JSON data representing the response from the BookStack API after creating the shelf. This typically includes the newly created shelf's details such as its ID, name, description, and other metadata returned by the API.

No binary data output is produced by this node.

Example output structure (simplified):

{
  "id": 123,
  "name": "Programming Books",
  "description": "A collection of books about programming languages",
  ...
}

Dependencies

Requires an API key credential for authenticating with the BookStack API.
The node expects the base URL of the BookStack instance and authentication tokens to be configured in the credentials.
HTTP requests are made to the BookStack API endpoints under /api/shelfs for shelf operations.

Troubleshooting

Missing or invalid credentials: Ensure that the API key and base URL are correctly set up in the node credentials.
Invalid or missing required fields: The "Name" property is mandatory for creating a shelf. If omitted, the API will likely return an error.
Incorrect API endpoint or network issues: Verify that the base URL points to a valid BookStack API endpoint and that the server is reachable.
Parsing errors in automatic mode: When using the automatic mode, ambiguous or unclear request descriptions may lead to incorrect resource or operation selection. Try to use clear and concise descriptions.
Error messages from API: Errors returned by the BookStack API will be included in the node output if "Continue on Fail" is enabled. Review these messages for specific issues like permission problems or validation errors.