Resource
knowledge_note
A single piece of situational knowledge — a fact, caveat, or tip — attached to a concept or a specific entity, and reachable through the knowledge graph from related entities.
Configuration
scopeKnowledgeScope!OptionalInitial visibility; defaults to PERSONAL.
Allowed values
PERSONAL — Visible to and weighted up for its author only.
TENANT — Shared knowledge, visible to the whole tenant.
statusKnowledgeStatus!OptionalSet on creationInitial review status; defaults to LIVE. Pass PENDING to contribute a proposed note awaiting confirmation.
Allowed values
PENDING — Proposed (e.g. distilled by an agent) and awaiting human confirmation; excluded from retrieval until confirmed.
LIVE — Confirmed and active; visible per `scope` and surfaced by retrieval.
set once, at creation
kindKnowledgeAttachmentKind!RequiredSet on creationSelects the target: CONCEPT requires conceptId; ENTITY requires entityId.
Allowed values
CONCEPT — The note is about a concept in the ontology (`conceptId` is set).
ENTITY — The note is about a specific entity (`entityType` + `entityId` are set).
set once, at creation
conceptIdConceptIDOptionalSet on creationConcept to attach to, required when kind is CONCEPT.
References concept
set once, at creation
entityIdStringOptionalSet on creationThe entity to attach to, required when kind is ENTITY — a TypeID (e.g. "wcr_01K…") whose prefix names the entity kind.
set once, at creation
bodyString!RequiredThe note's free-text content.
provenanceKnowledgeProvenance!OptionalSet on creationHow the note originated; defaults to MANUAL.
Allowed values
MANUAL — A person wrote the note directly.
CHAT_DISTILLED — Distilled by AI from a chat/assistant conversation.
JOURNEY_CAPTURED — Captured automatically while a user carried out a journey/workflow.
set once, at creation
Read-only values
Show values
idKnowledgeNoteID!Read onlyUnique identifier for the note.
computed by the platform
tenantIdTenantID!Read onlyTenant that owns this note.
computed by the platform
authorUserIdUserIDRead onlyUser who authored the note; null for system-generated notes.
References service_account
computed by the platform
entityTypeStringRead onlyEntity kind (TypeID prefix, e.g. "workcenter") when kind is ENTITY; otherwise null.
computed by the platform
confirmationsInt!Read onlyNumber of times the note has been confirmed. Higher confirmation raises its trust weight in retrieval ranking.
computed by the platform
supersededByKnowledgeNoteIDRead onlyIf this note has been replaced, the ID of the note that replaces it; otherwise null.
References knowledge_note
computed by the platform
createdAtString!Read onlyISO-8601 timestamp when the note was created.
computed by the platform
updatedAtString!Read onlyISO-8601 timestamp when the note was last modified.
computed by the platform
Lifecycle
The CLI can create this resource. The platform assigns its id.
When replacement is needed, the existing resource is removed before its replacement is created.