BookStack icon

BookStack

Consume BookStack API

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 Page resource with the Move operation, it allows you to move a page from one book or chapter to another within your BookStack instance.

Common scenarios where this node is beneficial include reorganizing documentation content by relocating pages between books or chapters, maintaining structured knowledge bases, or automating content management workflows in BookStack.

For example, you could use this node to programmatically move a page titled "API Documentation" from one book to another after a restructuring of your documentation hierarchy.

Properties

Name Meaning
Tool Description Choose how to determine the resource and operation:
- Set Automatically: The node will parse a natural language description to infer the resource and operation.
- Set Manually: You explicitly select the resource and operation.
Request Description (Shown only if "Set Automatically" is selected) A text input where you describe what you want to do, e.g., "Move the page 'API Guide' to another book". The system uses this description to automatically select the appropriate resource and operation.

Note: For the Page - Move operation, when set manually, additional parameters like the page ID and target location would be required but are not listed here because the user provided only the above properties.

Output

The node outputs JSON data representing the response from the BookStack API after performing the move operation on the page resource. This typically includes details about the moved page, such as its new location, identifiers, and metadata.

If the operation fails, the output JSON will contain an error message describing the issue.

The node does not output binary data.

Dependencies

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

Troubleshooting

  • Common Issues:

    • Incorrect or missing page ID: The move operation requires a valid page ID; ensure the correct ID is provided.
    • Insufficient permissions: The API token used must have rights to move pages within BookStack.
    • Invalid target location: When moving a page, the target book or chapter must exist and be accessible.
    • Network or authentication errors: Verify that the API base URL and token are correctly configured.
  • Error Messages:

    • "error": "Resource not found": The specified page ID does not exist.
    • "error": "Unauthorized": Authentication failed; check API credentials.
    • "error": "Invalid target location": The destination book or chapter is invalid or missing.

To resolve these, verify all IDs, credentials, and target locations before running the node.

Links and References

Discussion