Skip to content
HALOWERK

Textwerk

dictation score

Aligns the written text with the reference word by word (minimum edit alignment over words and punctuation) and classifies every difference by German orthography rule types: capitalisation (Groß-/Kleinschreibung), das/dass, ß/ss, umlaut and ä/e, consonant doubling (Schärfung), vowel length marking (Dehnung: h, ie, double vowels), final devoicing (d/t, g/k, b/p), wrong ending, compound written apart or together (Getrennt-/Zusammenschreibung), missing and extra words, and missing, extra or.

POST https://text.halowerk.com/v1/dictation-score

Inputs

Fields of the published input schema
FieldTypeRequiredDescription
referencestringYesOriginal dictation text.
attemptstringYesText written by the learner.
punctuationbooleanNoCount punctuation errors.
Show full input schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "reference",
    "attempt"
  ],
  "properties": {
    "reference": {
      "type": "string",
      "minLength": 1,
      "maxLength": 20000,
      "description": "Original dictation text."
    },
    "attempt": {
      "type": "string",
      "minLength": 1,
      "maxLength": 20000,
      "description": "Text written by the learner."
    },
    "punctuation": {
      "type": "boolean",
      "default": true,
      "description": "Count punctuation errors."
    }
  }
}

Open original schema

Published input example

{
  "reference": "Der Hund läuft schnell über die große Wiese.",
  "attempt": "der Hunt leuft schnel über die grosse Wiese"
}

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 →