Skip to content

Find notes by meaning, not exact words: `{query, results: [{path, score, heading, snippet,

POST
/datanotes/operations/semantic_search/
curl --request POST \
--url https://example.com/datanotes/operations/semantic_search/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "query": "example", "limit": 10, "tables": null, "folder": null, "min_score": null }'

Find notes by meaning, not exact words: {query, results: [{path, score, heading, snippet, table?}]}, one result per note (its best passage), best first. Use it for vague questions (“the dinner where we talked about moving”, “what did I decide about the car”) and to find the rows to read or update; then read_note / select_rows for the details. Filters: tables (qualified or short names), folder, min_score (cosine 0–1; ~0.5+ is usually relevant). limit: default 10, max 100. Fails with a clear message when semantic search is not enabled in the engine settings.

Media typeapplication/json
object
query
required
string
limit
integer
default: 10
tables
Any of:
Array<string>
folder
Any of:
string
min_score
Any of:
number

Done.

Media typeapplication/json
object
query
required
string
results
required

One result per note, best first.

Array<object>
object
path
required
string
score
required

Similarity, 0..1.

number
heading
required

Heading of the best passage.

string
snippet
required
string
table

Qualified table of a row note.

string

Example generated

{
"query": "example",
"results": [
{
"path": "example",
"score": 1,
"heading": "example",
"snippet": "example",
"table": "example"
}
]
}

Bad input: the body is not a JSON object, or an argument is unknown, missing or of the wrong type.

Media typeapplication/json
object
error
required

What went wrong, for a person or an agent.

string

Example generated

{
"error": "example"
}

Missing or wrong bearer token.

Media typeapplication/json
object
error
required

What went wrong, for a person or an agent.

string

Example generated

{
"error": "example"
}

Unexpected error.

Media typeapplication/json
object
error
required

What went wrong, for a person or an agent.

string

Example generated

{
"error": "example"
}