CheckRequest

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/languagetools/main/json-schema/check-request.json",
  "title": "CheckRequest",
  "description": "Request body for POST /check - check a text for grammar and style issues",
  "type": "object",
  "required": ["language"],
  "properties": {
    "text": {
      "type": "string",
      "description": "The text to be checked. This or 'data' is required."
    },
    "data": {
      "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."
    },
    "language": {
      "type": "string",
      "description": "A language code like 'en-US', 'de-DE', 'fr', or 'auto' to guess the language automatically.",
      "examples": ["en-US", "de-DE", "fr", "auto"]
    },
    "username": {
      "type": "string",
      "description": "Your username/email for Premium API access."
    },
    "apiKey": {
      "type": "string",
      "format": "password",
      "description": "Your API key for Premium API access."
    },
    "dicts": {
      "type": "string",
      "description": "Comma-separated list of dictionaries to include words from."
    },
    "motherTongue": {
      "type": "string",
      "description": "A language code of the user's native language, enabling false friends checks."
    },
    "preferredVariants": {
      "type": "string",
      "description": "Comma-separated list of preferred language variants, used with language=auto."
    },
    "enabledRules": {
      "type": "string",
      "description": "IDs of rules to be enabled, comma-separated."
    },
    "disabledRules": {
      "type": "string",
      "description": "IDs of rules to be disabled, comma-separated."
    },
    "enabledCategories": {
      "type": "string",
      "description": "IDs of categories to be enabled, comma-separated."
    },
    "disabledCategories": {
      "type": "string",
      "description": "IDs of categories to be disabled, comma-separated."
    },
    "enabledOnly": {
      "type": "boolean",
      "default": false,
      "description": "If true, only the rules and categories specified with enabledRules or enabledCategories are enabled."
    },
    "level": {
      "type": "string",
      "enum": ["default", "picky"],
      "description": "If set to 'picky', additional rules will be activated for formal text checking."
    }
  }
}