API Reference

Language

Check and correct grammar and spelling. Use the simple one-shot endpoint or the detailed match format when you want to decide which suggestions to apply.

Overview

Two complementary endpoints: /v1/language/correct returns the corrected text in one call — ideal when you just want clean output. /v2/check and /v2/languages return the detailed match format, giving you per-issue control over which suggestions to apply.

Correct text

POST/v1/language/correct

Scopelanguage

One-shot correction. Applies detected suggestions and returns the cleaned-up text.

Request

textrequiredstring: Text to check and correct.
languagestring: Language code (e.g. en, nl). Defaults to the service default or "auto".
pickyboolean: Enable stricter checking rules.
service_idstring: Optional. Route to a specific language service (see GET /v1/services). Falls back to the org’s default language service when omitted.

json

{
  "text": "Teh qick brown fox.",
  "language": "en",
  "picky": false
}

Response · 200

originalstring: The text you sent, unchanged.
correctedstring: Text with corrections applied.
corrections_appliednumber: Number of corrections made.

json

{
  "original": "Teh qick brown fox.",
  "corrected": "The quick brown fox.",
  "corrections_applied": 2
}

Detailed check

POST/v2/check

Scopelanguage

Returns every detected issue with position, suggestions and rule info — you decide which suggestions to apply.

Request

Same body as /v1/language/correct.

json

{
  "text": "Teh qick brown fox.",
  "language": "en"
}

Response · 200

Each match includes its position (offset / length), a list of replacements to choose from, and rule metadata.

json

{
  "matches": [
    {
      "message": "Possible typo",
      "shortMessage": "Typo",
      "replacements": [{ "value": "The" }],
      "offset": 0,
      "length": 3,
      "rule": {
        "id": "MORFOLOGIK_RULE_EN_US",
        "description": "Possible spelling mistake",
        "category": { "id": "TYPOS", "name": "Typos" }
      }
    }
  ],
  "language": { "name": "English", "code": "en" }
}

List supported languages

GET/v2/languages

Scopelanguage

List the languages the checker currently supports.

Response · 200

json

[
  { "name": "English (US)", "code": "en", "longCode": "en-US" },
  { "name": "Dutch", "code": "nl", "longCode": "nl-NL" }
]