BookStack

Overview

This node integrates with the BookStack API, allowing users to manage various BookStack resources such as books, pages, chapters, shelves, users, roles, attachments, and tags. Specifically, for the Tag resource with the Create operation, it enables creating new tags within the BookStack system.

The node supports two modes of operation:

• Automatic mode: The user provides a natural language description of the desired action (e.g., "Create a new tag for project management"), and the node attempts to parse this description to determine the appropriate resource and operation.
• Manual mode: The user explicitly selects the resource (Tag) and operation (Create), then provides the required parameters.

This node is beneficial in scenarios where you want to automate content or metadata creation in BookStack, such as tagging items programmatically based on dynamic inputs or integrating BookStack tagging into larger workflows.

Practical example

• Automatically create a new tag named "Urgent" by describing: "Create a new tag called Urgent".
• Manually create a tag by selecting the Tag resource and Create operation, then specifying the tag name.

Properties

Note: For the Tag - Create operation specifically, no additional properties are defined in the provided snippet beyond these general ones. In manual mode, the user would typically specify the tag's name and other relevant fields if available, but those are not shown here.

Output

The node outputs JSON data representing the response from the BookStack API after creating the tag. This JSON will contain details of the newly created tag, such as its ID, name, and any other metadata returned by the API.

No binary data output is indicated for this operation.

Dependencies

• Requires an API key credential for authenticating with the BookStack API.
• The base URL and authentication tokens must be configured in the node credentials.
• The node uses HTTP requests to communicate with the BookStack API endpoints.

Troubleshooting

• Common issues:

  • Incorrect or missing API credentials will cause authentication failures.
  • Providing an unclear or ambiguous request description in automatic mode may lead to incorrect resource or operation selection.
  • Missing required parameters when using manual mode can cause API errors.

• Error messages:

  • Authentication errors typically indicate invalid or expired API tokens; verify and update credentials.
  • Validation errors from the API may occur if required fields (like tag name) are missing or malformed.
  • Network errors suggest connectivity issues; check network access to the BookStack server.

To resolve these, ensure credentials are correct, input parameters are complete and valid, and the BookStack server is reachable.

Links and References

• BookStack Official Documentation
• BookStack API Reference