Skip to content

Read a note

GET
/notes/{query}
curl --request GET \
--url http://127.0.0.1:7677/notes/example \
--header 'Authorization: Bearer <token>'

Resolves the query in order: full UUID, UUID prefix (8+ chars), filename, then FTS search (top hit).

query
required
string

Full UUID, 8+ char UUID prefix, or filename

Note

Media type application/json
object
data
object
id
required
string format: uuid
title
required
string
description
string
tags
required
Array<string>
type
required
string
Allowed values: user feedback project reference knowledge snippet file
repository
string
created
required
string format: date-time
updated
required
string format: date-time
content
required

Markdown body

string
filePath
required

Absolute path on the server’s filesystem

string
Example
{
"data": {
"type": "user"
}
}

Note not found

Media type application/json
object
error
required
string
Example generated
{
"error": "example"
}