Open visible Markdown through the Files surface, including Plugin-owned and Daily note files.

GET

/api/v1/notes/files/open

curl --request GET \
  --url 'https://example.com/api/v1/notes/files/open?path=example' \
  --header 'Authorization: Bearer <token>'

The path is relative to the authenticated User’s Home and is checked by store::note_path before every filesystem read. Re-indexing before return gives live editing a current stable Note identity after Files created or restored the file; the shared Notes list applies its own ownership filter. Resolve existence in this Home before Markdown type validation, so foreign paths and missing paths have the same response and lookup cost (#867). Route: /api/v1/notes/files/open. Inputs: path. Safe reads can use bounded retries.

Authorizations

• installationBearer
• browserSession

Parameters

Query Parameters

path

required

string

Responses

200

Media typeapplication/json

object

body

required

string

canvas

Validated render data for Canvas; an invalid imported file has no scene.

etag

required

string

id

required

string

path

required

string

properties

required

title

required

string

Example^generated

{
  "body": "example",
  "canvas": "example",
  "etag": "example",
  "id": "example",
  "path": "example",
  "properties": "example",
  "title": "example"
}