Skip to content
HALOWERK

Tonwerk

caption cefr

English only. Tokenises the caption text, resolves contractions and inflections (about 150 irregular forms plus -s/-es/-ed/-ing/-er/-est/-ly rules) and looks every word up in the CEFR-J Wordlist 1.5 (A1–B2, 7,799 entries, Tono Laboratory TUFS, free for commercial use with citation) and the Octanove Vocabulary Profile C1/C2 1.0 (CC BY-SA 4.0), both from github.com/openlanguageprofiles/olp-en-cefrj at commit d4e45b7. Names (capitalised words that are not in the lists) and numbers are skipped;.

POST https://ton.halowerk.com/v1/caption-cefr

Inputs

Fields of the published input schema
FieldTypeRequiredDescription
captionsstringNoCaptions or subtitles as SRT or WebVTT text.
captions_formatstringNoFormat of captions; auto detects WEBVTT headers, otherwise SRT.
textstringNoAlternative to captions: English plain text.
coverage_targetnumberNoShare of known tokens a learner needs (0.95 after Laufer 1989, 0.98 after Hu & Nation 2000).
target_levelstringNoWords above this level are listed as difficult.
max_wordsintegerNoMaximum number of difficult words and cues listed.
Show full input schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "captions": {
      "type": "string",
      "minLength": 10,
      "maxLength": 400000,
      "description": "Captions or subtitles as SRT or WebVTT text."
    },
    "captions_format": {
      "type": "string",
      "enum": [
        "auto",
        "srt",
        "vtt"
      ],
      "default": "auto",
      "description": "Format of captions; auto detects WEBVTT headers, otherwise SRT."
    },
    "text": {
      "type": "string",
      "minLength": 10,
      "maxLength": 200000,
      "description": "Alternative to captions: English plain text."
    },
    "coverage_target": {
      "type": "number",
      "enum": [
        0.9,
        0.95,
        0.98
      ],
      "default": 0.95,
      "description": "Share of known tokens a learner needs (0.95 after Laufer 1989, 0.98 after Hu & Nation 2000)."
    },
    "target_level": {
      "type": "string",
      "enum": [
        "A1",
        "A2",
        "B1",
        "B2",
        "C1",
        "C2"
      ],
      "default": "B1",
      "description": "Words above this level are listed as difficult."
    },
    "max_words": {
      "type": "integer",
      "minimum": 1,
      "maximum": 200,
      "default": 30,
      "description": "Maximum number of difficult words and cues listed."
    }
  }
}

Open original schema

Published input example

{
  "text": "I have a dog. It is big and black. My mother likes the dog. We go to the park every day. The dog runs and plays with a ball. I am happy.",
  "target_level": "A2"
}

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 →