v1

latestOpenAPI 3.1.02026-08-047777149.4 KB

Knowledge Base

Publish (upsert) a KB note from an external source

Upsert a note identified by its sourceKind/source/sourceId. The content is the full markdown note with YAML frontmatter. dryRun=true validates without writing. Requires workspace admin. Synced notes become read-only in the CRUD API.

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

Path parameters

workspacestring required

Workspace short name

Request body

sourceKindstring

Origin type, e.g. "git"

sourcestring required

Origin/collection (e.g. repo URL)

sourceIdstring required

Stable id within the source (e.g. file path)

sourceRefstring nullable

Version pointer (e.g. commit)

sourceMetadataobject nullable

contentstring required

Markdown note with YAML frontmatter

dryRunboolean

Validate only; write nothing

Response

Sync result

statusstring

created | updated | unchanged | rejected

appliedboolean

okboolean

noteIdstring nullable