Skip to content

Get Project Settings

GET
/api/writing/worldspell/settings/{project_id}

Get WorldSpell settings for a project.

project_id
required
Project Id
string

Successful Response

WorldSpellProjectSettingsResponse

Response wrapping project settings.

object
projectId
required
Projectid
string
settings
required
WorldSpellProjectSettings

Per-project WorldSpell configuration. Persisted to DB.

object
ignoredRules
Ignoredrules

LanguageTool rule IDs permanently ignored

Array<string>
disabledCategories
Disabledcategories

LanguageTool categories to skip

Array<string>
minSeverity
Minseverity

Minimum severity to report

string
default: info
Allowed values: error warning info
language
Language

LanguageTool language code

string
default: en-US
maxSuggestions
Maxsuggestions

Max replacement suggestions per violation

integer
default: 5 >= 1 <= 10
categorySeverityOverrides
Categoryseverityoverrides

Per-category severity overrides. Keys are LanguageTool categories (GRAMMAR, TYPOS, STYLE, …), values override the built-in severity map. Empty dict uses defaults. Authors who don’t want spelling typos to count as full errors can set {‘TYPOS’: ‘warning’} here instead of disabling the whole category.

object
key
additional properties
string
Allowed values: error warning info

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