Obsidian

Node catalog Actions

On this page

Read and write notes, search by text or properties, and edit a vault section.

Usage and specifics

Connect the vault Local REST API plugin using an Obsidian credential. The vault must be reachable from nodulz. Paths are vault-relative. Reading, searching and document retrieval do not need a model credential.

Technical type : obsidian. Runtime : nodulz.

Credentials and prerequisites

Obsidian (integration / obsidian). Secure vault connection through the Local REST API plugin.

Create credentials in your nodulz instance’s Credentials area, then select them on the node. Availability depends on ownership and sharing. See the credentials guide for access and rotation.

Parameters

Names below are technical keys. Defaults are not a ready-to-run configuration: complete fields required by your operation. Paths containing [] describe list items; some fields depend on the selected mode.

Parameter	Type	Default	Values / limits
`credentialId`	`string`	`""`	-
`operation`	`enum`	`"read"`	`list`, `read`, `read_active`, `create`, `replace`, `append`, `patch`, `delete`, `search`, `search_json`, `tags`
`path`	`string`	`""`	-
`folder`	`string`	`""`	-
`content`	`string`	`""`	-
`query`	`string`	`""`	-
`queryJson`	`string`	`"{\"in\":[\"project\",{\"var\":\"tags\"}]}"`	-
`limit`	`number`	`100`	-; ≥ 1, ≤ 1000
`targetType`	`enum`	`"heading"`	`heading`, `block`, `frontmatter`
`target`	`string`	`""`	-
`patchOperation`	`enum`	`"append"`	`append`, `prepend`, `replace`, `delete`
`value`	`string`	`"null"`	-
`ifMatch`	`string`	`""`	-
`confirmDelete`	`boolean`	`false`	-

Configuration help

credentialId Obsidian credential: Select the vault’s Local REST API connection. The API key stays in the encrypted credential.

Initial configuration

Initial catalog configuration example, to adapt before running. Keep secrets in credentials.

json

{
  "credentialId": "",
  "operation": "read",
  "path": "",
  "folder": "",
  "content": "",
  "query": "",
  "queryJson": "{\"in\":[\"project\",{\"var\":\"tags\"}]}",
  "limit": 100,
  "targetType": "heading",
  "target": "",
  "patchOperation": "append",
  "value": "null",
  "ifMatch": "",
  "confirmDelete": false
}

Verification

Test with representative data. Check node output in the inspector and logs, then use editor mapping for downstream fields. A trigger test with a simulated payload does not validate external service delivery.