Get info API version 2

The current response of the get_info command, with the check types and the check kit of each language.

Version 2 gives all the supported languages in one languages object.

For each language, the object gives the display name, the text direction, the check kit, and the available check types.

Use version 2 for new integrations.

Command name: get_info

API endpoint

See Overview.

Parameters

Name	Type	Required	Description
cmd	string	Yes	Command name. Set it to get_info.
version	number	Yes	Response version. Set it to 2 to get the version 2 response.
check_kit	string	No	The check kit that the service uses to resolve the checkKit value of each language. If you omit this parameter, the service resolves the default check kit of each language. See Check kits.
serviceid	string	Cloud only	Cloud API key. It is required for Cloud requests. It is not used on-premises.

Set check_kit only if you send the same check_kit value in the subsequent check requests. If the two values are different, the response does not agree with the check results.

Request example

Cloud

https://svc.webspellchecker.net/api?cmd=get_info&version=2&check_kit=ai_lt_hs1&serviceid=[your-service-id]

On-premises

http(s)://<host>:<port>/<virtual_dir>/api?cmd=get_info&version=2&check_kit=ai_lt_hs1

Response

The example shows two languages. The full response contains all the languages that the service supports.

{
  "languages": {
    "auto": {
      "name": "Autodetect",
      "checkTypes": {
        "spelling": {

        },
        "grammar": {

        },
        "style": {

        },
        "autocomplete": {

        },
        "autocorrect": {

        },
        "generate": {

        }
      }
    },
    "en_US": {
      "name": "English (US)",
      "direction": "ltr",
      "checkKit": {
        "name": "ai_lt_hs1"
      },
      "checkTypes": {
        "spelling": {

        },
        "grammar": {

        },
        "style": {

        },
        "autocomplete": {

        },
        "autocorrect": {

        },
        "generate": {

        }
      }
    }
  },
  "langList": {
    "ltr": {
      "auto": "Autodetect",
      "en_US": "English (US)"
    },
    "rtl": {
    }
  },
  "generateLangList": {
    "en_US": "English (US)"
  },
  "banner": false,
  "session": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "canRemoveBranding": true,
  "sendStatistics": true,
  "prompts": {
    "shorten": "Shorten",
    "expand": "Expand",
    "rewrite": "Rewrite",
    "improve": "Improve",
    "make_formal": "Make formal",
    "make_informal": "Make informal",
    "summarize": "Summarize",
    "proofread": "Proofread"
  },
  "maxGenerateInputSize": 3000,
  "minGenerateInputSize": 30
}

The response can contain more fields that are reserved for internal use. The table below describes the public fields.

Response fields

Field	Type	Description
languages	object	All the supported languages. Each key is a language code. See Language object.
langList	object	All the supported languages, grouped by text direction, ltr and rtl. Each item maps a language code to a display name. It contains the same languages as the languages object. This field is kept for compatibility with version 1.
generateLangList	object	The languages available for the AI writing assistant. Each item maps a language code to a display name.
prompts	object	The text operations of the AI writing assistant. Each item maps an operation ID to a display name.
minGenerateInputSize	number	The minimum number of characters that the AI writing assistant accepts.
maxGenerateInputSize	number	The maximum number of characters that the AI writing assistant accepts.

Language object

Each item of languages has these fields.

Field	Type	Description
name	string	The display name of the language.
direction	string	The text direction, ltr or rtl.
checkKit	object	The check kit that the service resolves for the language. The name field gives the check kit name.
checkTypes	object	The check types that the language supports. See Check types.

The auto code is not a language. It tells the service to detect the language of the text.

The auto item does not have the direction field and the checkKit field.

Check types

A key is present in checkTypes only if the language supports that check type. The value is an object.

Check type	Description
spelling	Spell check. See Spell and grammar check.
grammar	Grammar check. See Spell and grammar check.
style	Style check with the style guide rules. See Style check.
autocomplete	Text autocomplete. See Text autocomplete.
autocorrect	Spelling autocorrect. See Spelling autocorrect.
generate	Text operations of the AI writing assistant. See AI writing assistant (AIWA).

See also

• Get info API version 1 for the default response format.

• Supported languages for the full language list.

• Check kits for the engine combinations that a check kit selects.