---
title: "Check a text"
method: POST
path: "/check"
---

# Check a text

`POST /check`

The main feature - check a text with LanguageTool for possible style and grammar issues.

## Response `200`

the result of checking the text

- object
  - `software` object
    - `name` string, required — Usually 'LanguageTool'.
    - `version` string, required — A version string like '3.3' or '3.4-SNAPSHOT'.
    - `buildDate` string, required — Date when the software was built, e.g. '2016-05-25'.
    - `apiVersion` integer, required — Version of this API response. We don't expect to make incompatible changes, so this can also be increased for newly added fields.
    - `status` string — An optional warning, e.g. when the API format is not stable.
    - `premium` boolean — true if you're using a Premium account with all the premium text checks (since LanguageTool 4.2)
  - `language` object — The language used for checking the text.
    - `name` string, required — Language name like 'French' or 'English (US)'.
    - `code` string, required — ISO 639-1 code like 'en', 'en-US', or 'ca-ES-valencia'
    - `detectedLanguage` object, required — The automatically detected text language (might be different from the language actually used for checking).
      - `name` string, required — Language name like 'French' or 'English (US)'.
      - `code` string, required — ISO 639-1 code like 'en', 'en-US', or 'ca-ES-valencia'.
  - `matches` object[]
    - `message` string, required — Message about the error displayed to the user.
    - `shortMessage` string — An optional shorter version of 'message'.
    - `offset` integer, required — The 0-based character offset of the error in the text.
    - `length` integer, required — The length of the error in characters.
    - `replacements` object[], required — Replacements that might correct the error. The array can be empty, in this case there is no suggested replacement.
      - `value` string — the replacement string
    - `context` object, required
      - `text` string, required — Context of the error, i.e. the error and some text to the left and to the left.
      - `offset` integer, required — The 0-based character offset of the error in the context text.
      - `length` integer, required — The length of the error in characters in the context.
    - `sentence` string, required — The sentence the error occurred in (since LanguageTool 4.0 or later)
    - `rule` object
      - `id` string, required — An rule's identifier that's unique for this language.
      - `subId` string — An optional sub identifier of the rule, used when several rules are grouped.
      - `description` string, required
      - `urls` object[] — An optional array of URLs with a more detailed description of the error.
        - `value` string — the URL
      - `issueType` string — The <a href="http://www.w3.org/International/multilingualweb/lt/drafts/its20/its20.html#lqissue-typevalues">Localization Quality Issue Type</a>. This is not defined for all languages, in which case it will always be 'Uncategorized'.
      - `category` object, required
        - `id` string — A category's identifier that's unique for this language.
        - `name` string — A short description of the category.

---

[API](https://skmtc.dev/languagetool/apis/languagetool-api.md) · [All operations](https://skmtc.dev/languagetool/apis/languagetool-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/languagetool/languagetool-api/revisions/b03e9c3b31e2/schema)