Lodol Docs

Obsidian

API actions for the Obsidian integration.

Obsidian

Manage notes in Obsidian vaults with create, update, and list actions.


Append to note

Append markdown content to an existing Obsidian note.

Parameters

ParameterTypeRequiredDescription
note_idstringYesVault-relative file path of the note (e.g. 'folder/My Note.md').
contentstringYesMarkdown content to append.

Response

{
  "appended": true,
  "id": "mock_value"
}

Create note

Create a new note inside an Obsidian vault.

Parameters

ParameterTypeRequiredDescription
titlestringYesTitle for the new note.
contentstringNoInitial markdown content for the note.
folderstringNoOptional folder path inside the vault.

Response

{
  "folder": "mock_value",
  "id": "mock_value",
  "title": "mock_value"
}

Delete note

Delete a note from the Obsidian vault.

Parameters

ParameterTypeRequiredDescription
note_idstringYesVault-relative file path of the note (e.g. 'folder/My Note.md').

Response

{
  "deleted": true,
  "id": "mock_value"
}

List notes

List notes within the configured Obsidian vault.

Parameters

ParameterTypeRequiredDescription
folderstringNoOptional folder path to limit results.
limitnumberNoMaximum number of notes to return.

Response

{
  "items": [
    {}
  ],
  "next_cursor": "mock_value"
}

Update note

Replace the contents of an existing Obsidian note.

Parameters

ParameterTypeRequiredDescription
note_idstringYesVault-relative file path of the note (e.g. 'folder/My Note.md').
titlestringNoNew note title.
contentstringYesFull markdown content to replace the note with.

Response

{
  "id": "mock_value",
  "title": "mock_value"
}

On this page