Obsidian Vault REST APIInstall

Overview

This node allows bulk updating of notes within an Obsidian Vault via its REST API. It is designed to send multiple note update requests in a single operation, which can significantly improve efficiency when managing large numbers of notes. Typical use cases include synchronizing note metadata, content updates, or applying batch changes such as tags or links across many notes at once.

For example, if you have a list of notes that need their titles updated or content appended, this node can process all those updates in one go rather than requiring individual update calls for each note.

Properties

The "Items" property expects a JSON string that will be parsed into an array of objects, where each object corresponds to a note update payload sent to the API.

Output

The node outputs the response from the Obsidian Vault REST API after processing the bulk update request. The json output field contains the API's response data, typically reflecting the status of each note update operation (e.g., success or failure details per note).

If the API supports returning binary data (such as file attachments), it would be included accordingly, but based on the provided code and context, the primary output is JSON data representing the update results.

Dependencies

• Requires access to an Obsidian Vault REST API endpoint.
• Needs an API host URL configured in credentials or environment variables.
• Optionally uses an API authentication token or key credential to authorize requests.
• Depends on the @devlikeapro/n8n-openapi-node package for building and sending OpenAPI-based requests.

Troubleshooting

• Invalid JSON in Items: If the "Items" JSON input is malformed, the node will fail to parse it. Ensure the JSON syntax is correct.
• API Authentication Errors: Missing or incorrect API credentials will cause authorization failures. Verify that the API key or token is correctly set up.
• Network Issues: Connection problems to the Obsidian Vault API host will result in request timeouts or errors. Check network connectivity and API availability.
• Partial Failures: Some note updates might fail while others succeed. Review the output JSON for detailed error messages per note.
• Incorrect Payload Structure: The API expects specific fields for each note update. Providing incomplete or incorrect fields may cause errors. Consult the Obsidian Vault API documentation for required fields.

Links and References

• Obsidian Vault REST API Documentation (example link; replace with actual if available)
• n8n OpenAPI Node Integration Guide
• JSON formatting help: https://jsonlint.com/