Skip to content

Update ambient awareness settings (partial)

PUT
/api/context/settings

Patch fields on AmbientAwarenessSettings and persist.

Any partial update flips preset to "custom" so the UI reflects that the user has moved off a preset.

AmbientSettingsUpdateRequest

PUT /api/context/settings request — partial update of ambient settings.

All fields optional so the frontend can patch a single toggle without round-tripping the whole object.

object
enabled
Any of:
boolean
observeDocumentEvents
Any of:
boolean
observeSessionEvents
Any of:
boolean
observeViewChanges
Any of:
boolean
observeEntityMentions
Any of:
boolean
pickupCardEnabled
Any of:
boolean
nudgesEnabled
Any of:
boolean
nudgesPerSessionMax
Any of:
integer
<= 5
firstSessionPrimerEnabled
Any of:
boolean
broadcastDebounceMs
Any of:
integer
>= 500 <= 10000
observationHistorySize
Any of:
integer
>= 20 <= 500

Successful Response

AmbientSettingsResponse

GET /api/context/settings response — current AmbientAwarenessSettings.

object
enabled
required
Enabled
boolean
preset
required
Preset
string
observeDocumentEvents
required
Observedocumentevents
boolean
observeSessionEvents
required
Observesessionevents
boolean
observeViewChanges
required
Observeviewchanges
boolean
observeEntityMentions
required
Observeentitymentions
boolean
pickupCardEnabled
required
Pickupcardenabled
boolean
nudgesEnabled
required
Nudgesenabled
boolean
nudgesPerSessionMax
required
Nudgespersessionmax
integer
firstSessionPrimerEnabled
required
Firstsessionprimerenabled
boolean
broadcastDebounceMs
required
Broadcastdebouncems
integer
observationHistorySize
required
Observationhistorysize
integer

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object