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
| Parameter | Type | Required | Description |
|---|---|---|---|
note_id | string | Yes | Vault-relative file path of the note (e.g. 'folder/My Note.md'). |
content | string | Yes | Markdown content to append. |
Response
{
"appended": true,
"id": "mock_value"
}Create note
Create a new note inside an Obsidian vault.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
title | string | Yes | Title for the new note. |
content | string | No | Initial markdown content for the note. |
folder | string | No | Optional 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
| Parameter | Type | Required | Description |
|---|---|---|---|
note_id | string | Yes | Vault-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
| Parameter | Type | Required | Description |
|---|---|---|---|
folder | string | No | Optional folder path to limit results. |
limit | number | No | Maximum number of notes to return. |
Response
{
"items": [
{}
],
"next_cursor": "mock_value"
}Update note
Replace the contents of an existing Obsidian note.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
note_id | string | Yes | Vault-relative file path of the note (e.g. 'folder/My Note.md'). |
title | string | No | New note title. |
content | string | Yes | Full markdown content to replace the note with. |
Response
{
"id": "mock_value",
"title": "mock_value"
}