Search Notes (Deep)
Deprecated. Use POST /v1/external/workspaces/{workspaceGuid}/notes/search
for workspace-scoped deep search, which also accepts workspace-system and
team API keys. This endpoint stays available for backward compatibility.
Keyword-required deep search. Returns notes hydrated with their primary documents (one-pager, custom) so an MCP/LLM client can read content alongside metadata in a single call.
When to use this vs GET /v1/external/notes?keyword=...
GET /v1/external/notes?keyword=...— lightweight: returns matched note metadata only. Cheaper.POST /v1/external/notes/search(this) — heavy: also returns the matched notes’ documents. Use when you need to understand the context behind a topic, not just see which notes match.
Behavior
- Requires a user-scoped API key (team-only API keys return
400). - When the search index is unavailable or fails, the response sets
degraded=trueanddegradedReasonto one ofsearch_index_unavailable/search_index_degradedand returns an emptynotesarray — clients should surface this to the user/LLM. - Document content is structured (
sections); each document carries atruncatedflag when the combined section text exceeded the 5,000 char search budget. nextCursoris reserved for future use and is currently alwaysnull.
인증
API key in format {id}.{secret}.
The notes an endpoint returns depend on the key type. A user key reaches the notes that user can see in the app, including notes in their own private folders. A system key (workspace or organization, no user identity) reaches only notes that sit in a folder shared with all workspace members. Notes in a private folder, in a folder shared with only some members, or in no folder at all fall outside a system key's read scope, and scopes do not widen that boundary.
List and search endpoints drop out-of-scope notes from the response without an
error. Single-note reads and their sub-resources return 404, the same response
as a deleted note. See What notes a system key reads.
본문
응답
Matched notes with their documents.
Matched notes, ordered by full-text relevance with createdAt desc as tiebreaker.
true when the response was produced via a fallback path (e.g.,
search index unavailable). When degraded, notes may be empty and
quality is reduced.
Machine-readable reason when degraded=true. null otherwise.
search_index_unavailable, search_index_degraded, null