Skip to content
HALOWERK

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-check

Inputs

Fields of the published input schema
FieldTypeRequiredDescription
textstringYesText to check.
rulesarrayYesHouse 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."
          }
        }
      }
    }
  }
}

Open original schema

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

All endpoints in this hub →