Textwerk
house style check
Rule types: forbidden (term with optional replacement and reason; inflected German forms matched by suffix -e/-en/-er/-es/-n/-s/-em/-ern, replacement only for the exact form), prefer (variants that should be written as the preferred spelling, replaced automatically with matching initial capital), require (term that must appear at least once), max_sentence_words (limit per sentence) and pattern (regular expression in RE2 syntax via re2-wasm, linear time, with message and optional.
POST https://text.halowerk.com/v1/house-style-checkInputs
| Field | Type | Required | Description |
|---|---|---|---|
| text | string | Yes | Text to check. |
| rules | array | Yes | House style rules. |
Show full input schema
{
"type": "object",
"additionalProperties": false,
"required": [
"text",
"rules"
],
"properties": {
"text": {
"type": "string",
"minLength": 1,
"maxLength": 100000,
"description": "Text to check."
},
"rules": {
"type": "array",
"minItems": 1,
"maxItems": 200,
"description": "House style rules.",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"enum": [
"forbidden",
"prefer",
"require",
"max_sentence_words",
"pattern"
],
"description": "Rule type."
},
"term": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "forbidden/require: the term."
},
"replacement": {
"type": "string",
"maxLength": 200,
"description": "forbidden/pattern: replacement text."
},
"reason": {
"type": "string",
"maxLength": 300,
"description": "Why the rule exists (returned with findings)."
},
"inflections": {
"type": "boolean",
"default": true,
"description": "forbidden: also match inflected forms."
},
"case_sensitive": {
"type": "boolean",
"default": false,
"description": "forbidden/prefer/require: match case exactly."
},
"variants": {
"type": "array",
"minItems": 1,
"maxItems": 20,
"items": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"description": "prefer: spellings to replace."
},
"preferred": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "prefer: the house spelling."
},
"limit": {
"type": "integer",
"minimum": 5,
"maximum": 200,
"description": "max_sentence_words: maximum words per sentence."
},
"pattern": {
"type": "string",
"minLength": 1,
"maxLength": 500,
"description": "pattern: RE2 regular expression (no lookaround or backreferences)."
},
"message": {
"type": "string",
"maxLength": 300,
"description": "pattern/require: message for findings."
}
}
}
}
}
}Published input example
{
"text": "Wir bieten eigentlich die beste Lösung. Senden Sie uns eine Emailadresse.",
"rules": [
{
"type": "forbidden",
"term": "eigentlich",
"reason": "filler word"
},
{
"type": "prefer",
"variants": [
"Emailadresse",
"Email-Adresse"
],
"preferred": "E-Mail-Adresse"
}
]
}Result & documentation
Machine-readable documentation of this hub
Source of this page: the published HALOWERK catalog. Updated: 2026-11-17 UTC.
More endpoints in this hub
- Textwerk0.002 USDC
acronym ideas
POSThttps://text.halowerk.com/v1/acronym-ideasSplits the title into words, marks German and English stop words (and, of, für, und ), and enumerates in word order every combination of the first 1-3 letters of each significant word (stop words contribute 0 or 1 letter when allowed), with
- Textwerk0.005 USDC
agg check
POSThttps://text.halowerk.com/v1/agg-checkApplies documented rules to the ad text and its first line or title: explicit age limits and age ranges, youth-related team wording and career-stage target groups (age); native-speaker, accent and origin requirements, nationality (ethnic or
- Textwerk0.002 USDC
anglicism replace
POSThttps://text.halowerk.com/v1/anglicism-replaceLooks up every word in about 1,050 entries that OpenThesaurus (export 2026-10-30, LGPL-2.1 or CC BY-SA 4.0) labels English, Anglicism or Denglisch, matching inflected forms from german-pos-dict 1.2.2 (CC BY-SA 4.0) and English heads of comp