Notes

Get a note by id

Returns the full note (including content) for the given note UUID. Returns 400 for a malformed UUID and 404 when no such note exists in the vault.

get/api/notes/by-id/{id}

Request

  • Base URL: https://api.engram.page
  • URL: https://api.engram.page/api/notes/by-id/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Note UUID

Response

Note

contentstring
content_hashstring nullable
descriptionstring nullable

OKF frontmatter description field

fm_createdstring date-time nullable

OKF frontmatter created/date field

fm_timestampstring date-time nullable

OKF frontmatter timestamp/modified/updated field

folderstring nullable
idstring uuid nullable
mtimenumber float

Client mtime (epoch seconds)

parse_reasonobject nullable

Present when parse_status is "degraded": {code, message, detail}

parse_status'ok' | 'degraded' nullable

Frontmatter parse outcome

pathstring required
resourcestring nullable

OKF frontmatter resource field

tagsstring[]
titlestring nullable
typestring nullable

OKF frontmatter type field

updated_atstring date-time nullable
versioninteger nullable

Example response

{
  "path": "Projects/engram.md"
}

Changes

No recorded changes to this operation across all 1 revision of this API.