note

The catch-all. Use it when something is worth keeping but does not fit the other verbs — context, caveats, warnings about the shape of the codebase.

Parameters

string

required

The free-form note to store.

'org' | 'agent'

default:"org"

org (default) writes to the shared team memory. agent keeps it private to the identity in the X-Vex-Agent header. See Scope.

string

Optional space slug. Omit to write to the org’s default store.

Examples

{
  "content": "The legacy/ directory is scheduled for deletion after Q3 — do not invest in refactoring it"
}

{
  "content": "The odd retry logic in the webhook handler exists because a partner's endpoint returns 200 before it has actually processed anything"
}

Guidance

If you find yourself reaching for note constantly, check whether the content is really a decision or a fact. Those types carry more weight in recall, so using the right verb makes the memory easier to find later.

⌘I

Overview

Reading

Writing

Artifacts

Managing

Parameters

Examples

Guidance

​Parameters

​Examples

​Guidance

Parameters

Examples

Guidance