LanguageTool Check API
The Check API from LanguageTool — 1 operation(s) for check.
OpenAPI Specification
swagger: '2.0'
info:
contact:
x-twitter: languagetoolorg
description: 'Check texts for style and grammar issues with <a href=''https://languagetool.org''>LanguageTool</a>. Please consider the following default limitations:<ul><li>your daily request limit depending on <a href=''https://languagetool.org/editor/settings/access-tokens''>your plan</a> <li>maximum number of requests per minute: 20 (free) / 80 (Premium) <li>maximum number of characters per minute: 75,000 (free) / 300,000 (Premium) <li>maximum number of characters per request: 20,000 (free) / 60,000 (Premium) <li>for the free version, also consider the <a href=''https://dev.languagetool.org/public-http-api''>limitations documented here</a> <li><b>Note:</b> any parameters or outputs not part of this documentation are internal and must not be relied on</ul> Need more generous limits? Just <a href=''https://languagetool.org/proofreading-api''>contact us</a>.'
title: LanguageTool Check API
version: 1.1.2
x-apisguru-categories:
- text
x-logo:
url: https://api.apis.guru/v2/cache/logo/https_twitter.com_languagetoolorg_profile_image.jpeg
x-origin:
- format: swagger
url: https://languagetool.org/http-api/languagetool-swagger.json
version: '2.0'
x-providerName: languagetool.org
host: api.languagetoolplus.com
basePath: /v2
schemes:
- https
produces:
- application/json
tags:
- name: Check
paths:
/check:
post:
description: The main feature - check a text with LanguageTool for possible style and grammar issues.
parameters:
- description: The text to be checked. This or 'data' is required.
in: formData
name: text
required: false
type: string
- description: "The text to be checked, given as a JSON document that specifies what's text and what's markup. This or 'text' is required. Markup will be ignored when looking for errors. Example text: <pre>A <b>test</b></pre>JSON for the example text: <pre>{\"annotation\":[\n {\"text\": \"A \"},\n {\"markup\": \"<b>\"},\n {\"text\": \"test\"},\n {\"markup\": \"</b>\"}\n]}</pre> <p>If you have markup that should be interpreted as whitespace, like <tt><p></tt> in HTML, you can have it interpreted like this: <pre>{\"markup\": \"<p>\", \"interpretAs\": \"\\n\\n\"}</pre><p>The 'data' feature is not limited to HTML or XML, it can be used for any kind of markup. Entities will need to be expanded in this input."
in: formData
name: data
required: false
type: string
- description: A language code like `en-US`, `de-DE`, `fr`, or `auto` to guess the language automatically (see `preferredVariants` below). For languages with variants (English, German, Portuguese) spell checking will only be activated when you specify the variant, e.g. `en-GB` instead of just `en`.
in: formData
name: language
required: true
type: string
- description: 'Set to get Premium API access: Your username/email as used to log in at languagetool.org.'
in: formData
name: username
type: string
- description: 'Set to get Premium API access: <a target=''_blank'' href=''https://languagetool.org/editor/settings/access-tokens''>your API key</a>'
format: password
in: formData
name: apiKey
type: string
- description: Comma-separated list of dictionaries to include words from; uses special default dictionary if this is unset
in: formData
name: dicts
type: string
- description: A language code of the user's native language, enabling false friends checks for some language pairs.
in: formData
name: motherTongue
type: string
- description: Comma-separated list of preferred language variants. The language detector used with `language=auto` can detect e.g. English, but it cannot decide whether British English or American English is used. Thus this parameter can be used to specify the preferred variants like `en-GB` and `de-AT`. Only available with `language=auto`. You should set variants for at least German and English, as otherwise the spell checking will not work for those, as no spelling dictionary can be selected for just `en` or `de`.
in: formData
name: preferredVariants
type: string
- description: IDs of rules to be enabled, comma-separated
in: formData
name: enabledRules
type: string
- description: IDs of rules to be disabled, comma-separated
in: formData
name: disabledRules
type: string
- description: IDs of categories to be enabled, comma-separated
in: formData
name: enabledCategories
type: string
- description: IDs of categories to be disabled, comma-separated
in: formData
name: disabledCategories
type: string
- default: false
description: If true, only the rules and categories whose IDs are specified with `enabledRules` or `enabledCategories` are enabled.
in: formData
name: enabledOnly
type: boolean
- description: If set to `picky`, additional rules will be activated, i.e. rules that you might only find useful when checking formal text.
enum:
- default
- picky
in: formData
name: level
type: string
responses:
'200':
description: the result of checking the text
schema:
properties:
language:
description: The language used for checking the text.
properties:
code:
description: ISO 639-1 code like 'en', 'en-US', or 'ca-ES-valencia'
type: string
detectedLanguage:
description: The automatically detected text language (might be different from the language actually used for checking).
properties:
code:
description: ISO 639-1 code like 'en', 'en-US', or 'ca-ES-valencia'.
type: string
name:
description: Language name like 'French' or 'English (US)'.
type: string
required:
- name
- code
type: object
name:
description: Language name like 'French' or 'English (US)'.
type: string
required:
- name
- code
- detectedLanguage
type: object
matches:
items:
properties:
context:
properties:
length:
description: The length of the error in characters in the context.
type: integer
offset:
description: The 0-based character offset of the error in the context text.
type: integer
text:
description: Context of the error, i.e. the error and some text to the left and to the left.
type: string
required:
- text
- offset
- length
type: object
length:
description: The length of the error in characters.
type: integer
message:
description: Message about the error displayed to the user.
type: string
offset:
description: The 0-based character offset of the error in the text.
type: integer
replacements:
description: Replacements that might correct the error. The array can be empty, in this case there is no suggested replacement.
items:
properties:
value:
description: the replacement string
type: string
type: object
type: array
rule:
properties:
category:
properties:
id:
description: A category's identifier that's unique for this language.
type: string
name:
description: A short description of the category.
type: string
type: object
description:
type: string
id:
description: An rule's identifier that's unique for this language.
type: string
issueType:
description: 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'.
type: string
subId:
description: An optional sub identifier of the rule, used when several rules are grouped.
type: string
urls:
description: An optional array of URLs with a more detailed description of the error.
items:
properties:
value:
description: the URL
type: string
type: object
type: array
required:
- id
- description
- category
type: object
sentence:
description: The sentence the error occurred in (since LanguageTool 4.0 or later)
type: string
shortMessage:
description: An optional shorter version of 'message'.
type: string
required:
- message
- offset
- length
- replacements
- context
- sentence
type: object
type: array
software:
properties:
apiVersion:
description: Version of this API response. We don't expect to make incompatible changes, so this can also be increased for newly added fields.
type: integer
buildDate:
description: Date when the software was built, e.g. '2016-05-25'.
type: string
name:
description: Usually 'LanguageTool'.
type: string
premium:
description: true if you're using a Premium account with all the premium text checks (since LanguageTool 4.2)
type: boolean
status:
description: An optional warning, e.g. when the API format is not stable.
type: string
version:
description: A version string like '3.3' or '3.4-SNAPSHOT'.
type: string
required:
- name
- version
- buildDate
- apiVersion
type: object
summary: Check a text
tags:
- Check