/daily-note
These routes deal with reading, writing and updating daily notes. Their URLs start with obsidian://actions-uri/daily-note/….
All routes listed here will test whether Daily Note functionality is enabled in Obsidian and if not, will return an x-error callback. Both the official core plugin and the @liamcain’s community plugin Periodic Notes are supported. The configurations from those plugins is honored, i.e. date format, the set folder for daily notes etc. are taken into account when fetching, creating and updating notes.
Root, i.e. /daily-note
Does nothing but say hello.
Parameters
Only supports the base parameters (see section “Parameters required in/ accepted by all calls”).
Return values
These parameters will be added to the callbacks used for getting data back from Actions URI.
On success:
| Parameter | Description |
|---|---|
result-message | A short summary of what was done. |
/daily-note/list
v0.12+ Returns a list of all daily notes.
Parameters
In addition to the base parameters (see section “Parameters required in/ accepted by all calls”):
| Parameter | Value type | Optional? | Description |
|---|---|---|---|
x-success | string | base URL for on-success callbacks | |
x-error | string | base URL for on-error callbacks |
Return values
These parameters will be added to the callbacks used for getting data back from Actions URI.
On success:
| Parameter | Description |
|---|---|
result-paths | Array containing all file paths encoded as JSON string. |
On failure:
| Parameter | Description |
|---|---|
errorCode | A HTTP status code. |
errorMessage | A short summary of what went wrong. |
/daily-note/get-current
Returns today’s daily note.
v1.4+ Please note: result-properties might be empty if Obsidian can’t process the note’s front matter. This can happen if the front matter is malformed or if the note contains a YAML block that is not front matter.
Parameters
In addition to the base parameters (see section “Parameters required in/ accepted by all calls”):
| Parameter | Value type | Optional? | Description |
|---|---|---|---|
x-success | string | base URL for on-success callbacks | |
x-error | string | base URL for on-error callbacks | |
silent | boolean | optional | “Do not open the note in Obsidian.” Defaults to false. |
Return values
These parameters will be added to the callbacks used for getting data back from Actions URI.
On success:
| Parameter | Description |
|---|---|
result-body | The note body, i.e. the note file content minus possible front matter. |
result-content | The entire content of the note file. |
result-filepath | The file path of the note, relative from the vault root folder. |
result-front-matter | The note’s front matter, i.e. the note file content minus the note body. |
result-properties | v1.4+ The note’s properties. |
On failure:
| Parameter | Description |
|---|---|
errorCode | A HTTP status code. |
errorMessage | A short summary of what went wrong. |
/daily-note/get-most-recent
Returns the most recent daily note. If there is a current daily note (i.e. one for today), that’s considered the most recent one, otherwise the most recent past daily note is returned.
v1.4+ Please note: result-properties might be empty if Obsidian can’t process the note’s front matter. This can happen if the front matter is malformed or if the note contains a YAML block that is not front matter.
Parameters
In addition to the base parameters (see section “Parameters required in/ accepted by all calls”):
| Parameter | Value type | Optional? | Description |
|---|---|---|---|
x-success | string | base URL for on-success callbacks | |
x-error | string | base URL for on-error callbacks | |
silent | boolean | optional | “Do not open the note in Obsidian.” Defaults to false. |
Return values
These parameters will be added to the callbacks used for getting data back from Actions URI.
On success:
| Parameter | Description |
|---|---|
result-body | The note body, i.e. the note file content minus possible front matter. |
result-content | The entire content of the note file. |
result-filepath | The file path of the note, relative from the vault root folder. |
result-front-matter | The note’s front matter, i.e. the note file content minus the note body. |
result-properties | v1.4+ The note’s properties. |
On failure:
| Parameter | Description |
|---|---|
errorCode | A HTTP status code. |
errorMessage | A short summary of what went wrong. |
/daily-note/open-current
v0.12+ Opens the current daily note in Obsidian.
Parameters
Only supports the base parameters (see section “Parameters required in/ accepted by all calls”).
Return values
These parameters will be added to the callbacks used for getting data back from Actions URI.
On success:
| Parameter | Description |
|---|---|
result-message | A short summary of what was done. |
On failure:
| Parameter | Description |
|---|---|
errorCode | A HTTP status code. |
errorMessage | A short summary of what went wrong. |
/daily-note/open-most-recent
v0.12+ Opens the most recent daily note in Obsidian. If there is a current daily note (i.e. one for today), that’s considered the most recent one, otherwise the most recent past daily note is returned.
Parameters
Only supports the base parameters (see section “Parameters required in/ accepted by all calls”).
Return values
These parameters will be added to the callbacks used for getting data back from Actions URI.
On success:
| Parameter | Description |
|---|---|
result-message | A short summary of what was done. |
On failure:
| Parameter | Description |
|---|---|
errorCode | A HTTP status code. |
errorMessage | A short summary of what went wrong. |
/daily-note/create
Creates a new daily note. If a current daily note is already present, an error will be returned.
If you want to skip the error response in favor of getting the current note as-is, pass in if-exists=skip. If you want to overwrite an existing note, pass in if-exists=overwrite.
v1.2+ The apply parameter allows you to specify what to add to the note after creation. Available options are content (implied default) for adding a string, templates (for using the Template core plugin), templater (for using the Templater community plugin). Depending on the apply parameter’s value, the following additional parameters are allowed:
apply=contentor noapplyparameter:contentparameter, the initial body of the noteapply=templater:template-fileparameter, path of the template file to applyapply=templates:template-fileparameter, path of the template file to apply
Examples:
apply=content&content=Hello%20world!orcontent=Hello%20world!(asapply=contentis the default)apply=content&content=orcontent=creates an empty noteapply=templater&template-file=Templates/Meeting%20notes.mdapply=templates&template-file=Templates/Meeting%20notes.md
v1.4+ Please note: result-properties might be empty if Obsidian can’t process the note’s front matter. This can happen if the front matter is malformed or if the note contains a YAML block that is not front matter.
Parameters
In addition to the base parameters (see section “Parameters required in/ accepted by all calls”):
| Parameter | Value type | Optional? | Description |
|---|---|---|---|
apply | enum | optional | What to add to the note after creation. Available options: content (implied default), templates, templater. |
+- content | string | optional | The initial body of the note. Prerequisite: no apply parameter or apply=content. |
+- template-file | string | optional | The path of the template file to apply. Prerequisite: apply=templater or apply=templates. |
if-exists | string | optional | What to do if the specified note exists. Set to overwrite for replacing the note or skip for using the existing note as-is. |
silent | boolean | optional | “After creating the note, do not open it in Obsidian.” Defaults to false. |
Return values
These parameters will be added to the callbacks used for getting data back from Actions URI.
On success:
| Parameter | Description |
|---|---|
result-body | The note body, i.e. the note file content minus possible front matter. |
result-content | The entire content of the note file. |
result-filepath | The file path of the note, relative from the vault root folder. |
result-front-matter | The note’s front matter, i.e. the note file content minus the note body. |
result-properties | v1.4+ The note’s properties. |
On failure:
| Parameter | Description |
|---|---|
errorCode | A HTTP status code. |
errorMessage | A short summary of what went wrong. |
/daily-note/append
Appends text to today’s daily note, either to the very end of the note (default) or to the section below a particular headline.
When you append text to a section below a heading, the headline must be entered exactly as it appears in the note: headline levels, capitalization, punctuation etc. For example, “## My Headline”, “### My Headline”, and “## my headline” are not identical.
Parameters
In addition to the base parameters (see section “Parameters required in/ accepted by all calls”):
| Parameter | Value type | Optional? | Description |
|---|---|---|---|
content | string | The text to be added at the end of today’s daily note. | |
below-headline | string | optional | Appends text below the given headline, before the next headline or EOF, whatever comes first. v1.2+ |
create-if-not-found | boolean | optional | “If the note does not exist, create it before appending.” Defaults to false. v1.2+ |
ensure-newline | boolean | optional | “Make sure the note ends with a line break.” Defaults to false. |
silent | boolean | optional | “After updating the note, do not open it in Obsidian.” Defaults to false. |
Return values
These parameters will be added to the callbacks used for getting data back from Actions URI.
On success:
| Parameter | Description |
|---|---|
result-message | A short summary of what was done. |
On failure:
| Parameter | Description |
|---|---|
errorCode | A HTTP status code. |
errorMessage | A short summary of what went wrong. |
/daily-note/prepend
Prepends text to today’s note, either to the very beginning of the note (default) or to the section below a particular headline in a note.
If the very beginning of the note is prepended, then the front matter will be honored (i.e. the new text will be added to the note body below the front matter) unless explicitly stated otherwise.
When you prepend text to a section below a heading, the headline must be entered exactly as it appears in the note: headline levels, capitalization, punctuation etc. For example, “## My Headline”, “### My Headline”, and “## my headline” are not identical.
Parameters
In addition to the base parameters (see section “Parameters required in/ accepted by all calls”):
| Parameter | Value type | Optional? | Description |
|---|---|---|---|
content | string | The text to be added at the beginning of today’s daily note. | |
below-headline | string | optional | Prepends text below the given headline, before the next headline or EOF, whatever comes first. v1.2+ |
create-if-not-found | boolean | optional | “If the note does not exist, create it before prepending.” Defaults to false. v1.2+ |
ensure-newline | boolean | optional | “Make sure the note ends with a line break.” Defaults to false. |
ignore-front-matter | boolean | optional | “Put the text at the very beginning of the note file, even if there is front matter.” Defaults to false. |
silent | boolean | optional | “After updating the note, do not open it in Obsidian.” Defaults to false. |
Return values
These parameters will be added to the callbacks used for getting data back from Actions URI.
On success:
| Parameter | Description |
|---|---|
result-message | A short summary of what was done. |
On failure:
| Parameter | Description |
|---|---|
errorCode | A HTTP status code. |
errorMessage | A short summary of what went wrong. |
/daily-note/search-string-and-replace
Does text replacement in today’s daily note. The search term is used as-is, i.e. it’s a string search.
Parameters
In addition to the base parameters (see section “Parameters required in/ accepted by all calls”):
| Parameter | Value type | Optional? | Description |
|---|---|---|---|
search | string | Text string that should be replaced. | |
replace | string | Replacement text. | |
silent | boolean | optional | “After updating the note, do not open it in Obsidian.” Defaults to false. |
Return values
These parameters will be added to the callbacks used for getting data back from Actions URI.
On success:
| Parameter | Description |
|---|---|
result-message | A short summary of what was done. |
On failure:
| Parameter | Description |
|---|---|
errorCode | A HTTP status code. |
errorMessage | A short summary of what went wrong. |
/daily-note/search-regex-and-replace
Does text replacement in today’s daily note. The search term is used as a pattern, i.e. it’s a regular expression search.
Capturing is supported. Example: the note contains the text “and it was good”, the search value is /(it) (was)/ and the replace value is $2 $1 — after the replacement the note would be changed to “and was it good”.
Modifiers for case-insensitive and global search (/…/i, /…/g, /…/gi) are supported as well. See MDN for examples.
Parameters
In addition to the base parameters (see section “Parameters required in/ accepted by all calls”):
| Parameter | Value type | Optional? | Description |
|---|---|---|---|
search | string | Text pattern that should be replaced. | |
replace | string | Replacement text. | |
silent | boolean | optional | “After updating the note, do not open it in Obsidian.” Defaults to false. |
Return values
These parameters will be added to the callbacks used for getting data back from Actions URI.
On success:
| Parameter | Description |
|---|---|
result-message | A short summary of what was done. |
On failure:
| Parameter | Description |
|---|---|
errorCode | A HTTP status code. |
errorMessage | A short summary of what went wrong. |