Sign in

v1

latestOpenAPI 3.1.02026-08-047777149.4 KB
Knowledge Base

Create a Knowledge Base note

Create a note. Leave resourcePaths empty for a global note, or set them to scope the note to specific resources. Use resourceSelectors with tag matchTags to attach the note to every resource carrying a given tag.

post/api/v4/workspaces/{workspace}/notes

Path parameters

workspacestring required

Workspace short name

Request body

titlestring nullable

Short note title

contentstring required

Note content

resourcePathsstring[]

Canonical resource paths to scope the note. Omit or leave empty for a global note.

abstractEntitiesstring[]

Normalized entity tokens (optional)

tagsstring[]

Author-facing labels

status'active' | 'deprecated'

Response

Note created

noteIdstring uuid

Unique note identifier

titlestring nullable

Short note title

contentstring

Note content (max 20000 chars)

resourcePathsstring[]

Authored explicit resource paths

lastResolvedAtstring date-time nullable
resolutionStatestring nullable

ok | pending | error

indexingStatestring nullable

USearch index state (completed | failed | queued | ...)

abstractEntitiesstring[]
tagsstring[]

Author-facing labels

statusstring

Note lifecycle status (active | deprecated)

verifiedboolean

Whether note is human-verified

authorEmailstring nullable
createdAtstring date-time
updatedAtstring date-time
sourceKindstring

Origin: "manual" or external (e.g. "git")

sourcestring nullable

Origin/collection (e.g. repo URL)

sourceIdstring nullable

Identifier within the source (e.g. file path)

sourceRefstring nullable

Version pointer at last sync (e.g. commit)

readOnlyboolean

True for externally-synced notes (edit at source)