Skip to content

Update Insight Settings

PUT
/api/writing/insights/settings

Update insight settings.

InsightSettings

User-configurable insight toggles (RULE #5).

object
loreGapsEnabled
Loregapsenabled
boolean
default: true
unlinkedRefsEnabled
Unlinkedrefsenabled
boolean
default: true
completenessEnabled
Completenessenabled
boolean
default: true
consistencyEnabled
Consistencyenabled
boolean
default: true
consistencyThreshold
Consistencythreshold
number
default: 0.35
maxInsightsPerScan
Maxinsightsperscan
integer
default: 50

Successful Response

InsightSettings

User-configurable insight toggles (RULE #5).

object
loreGapsEnabled
Loregapsenabled
boolean
default: true
unlinkedRefsEnabled
Unlinkedrefsenabled
boolean
default: true
completenessEnabled
Completenessenabled
boolean
default: true
consistencyEnabled
Consistencyenabled
boolean
default: true
consistencyThreshold
Consistencythreshold
number
default: 0.35
maxInsightsPerScan
Maxinsightsperscan
integer
default: 50

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