Skip to content

Update Proseguard Defaults

PUT
/api/settings/proseguard

Update global ProseGuard default settings.

ProseGuardDefaultsUpdate
object
enabled
Any of:
boolean
autoReviseEnabled
Any of:
boolean
structuralEnabled
Any of:
boolean
stylisticEnabled
Any of:
boolean
semanticEnabled
Any of:
boolean
continuityEnabled
Any of:
boolean
maxSentenceLength
Any of:
integer
>= 5 <= 100
maxParagraphLength
Any of:
integer
>= 20 <= 500
maxEmDashesPerParagraph
Any of:
integer
<= 10
maxEllipsesPerParagraph
Any of:
integer
<= 10
bannedPhrases
Any of:
Array<string>
bannedWords
Any of:
Array<string>
maxWordRepetitionPerParagraph
Any of:
integer
>= 1 <= 20
minWordLengthForRepetition
Any of:
integer
>= 1 <= 10
povMode
Any of:
string
Allowed values: first second third_limited third_omniscient none
forbidPov
Any of:
Array<string>
characterPronouns
Any of:
object
key
additional properties
Array<string>
dialoguePovExempt
Any of:
boolean
narrationYouSeverity
Any of:
string
Allowed values: error warning ignore
forbiddenTerms
Any of:
Array<string>
allowedTerms
Any of:
Array<string>
requiredNameForms
Any of:
object
key
additional properties
string
aiismsEnabled
Any of:
boolean
aiismsFlaggedWords
Any of:
Array<string>
aiismsFlaggedPhrases
Any of:
Array<string>
aiismsFlaggedDialogueTags
Any of:
Array<string>
aiismsFlaggedNames
Any of:
Array<string>
aiismsFilterWords
Any of:
Array<string>
maxRevisionAttempts
Any of:
integer
>= 1 <= 5
autoReviseSeverity
Any of:
string
Allowed values: error warning

Successful Response

SettingsUpdateResponse

Shared response envelope for every settings update endpoint.

status is "success" when at least one field changed, "noop" when the request carried no updatable fields. updated_fields lists the snake_case keys that were actually persisted so the caller can display exactly what changed.

object
status
required
Status
string
message
required
Message
string
updatedFields
required
Updatedfields
Array<string>

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