Skip to content

Get ProseGuard configuration

GET
/api/writing/proseguard/config/{project_id}

Get ProseGuard behavior configuration for a project.

project_id
required
Project Id
string

Successful Response

ProseGuardConfig

User-configurable ProseGuard behavior settings.

Controls how ProseGuard operates during generation, including auto-revision behavior and severity thresholds.

Attributes: enabled: Master toggle for ProseGuard auto_revise_enabled: Whether to automatically revise on violations max_revision_attempts: Hard cap on revision attempts (1-3) auto_revise_severity: Only auto-revise at this severity or higher

object
enabled
Enabled

Master toggle for ProseGuard

boolean
default: true
autoReviseEnabled
Autoreviseenabled

Automatically revise content on violations

boolean
maxRevisionAttempts
Maxrevisionattempts

Maximum revision attempts (hard cap)

integer
default: 2 >= 1 <= 5
autoReviseSeverity
Autoreviseseverity

Only auto-revise at this severity level or higher

string
default: error
Allowed values: error warning

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