> For the complete documentation index, see [llms.txt](https://docs.wproofreader.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.wproofreader.com/v6.18.1/api-reference/auxiliary-api-commands/get-info-api/version-2.md). # 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](/v6.18.1/api-reference/overview.md#api-endpoint). ### 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](/v6.18.1/deployment/configuration/application-server/check-kits.md). | | `serviceid` | string | Cloud only | Cloud API key. It is required for Cloud requests. It is not used on-premises. | {% hint style="warning" %} Set `check_kit` only if you send the same `check_kit` value in the subsequent [check](/v6.18.1/api-reference/check-api.md) requests. If the two values are different, the response does not agree with the check results. {% endhint %} ### Request example {% tabs %} {% tab title="Cloud" %} ``` https://svc.webspellchecker.net/api?cmd=get_info&version=2&check_kit=ai_lt_hs1&serviceid=[your-service-id] ``` {% endtab %} {% tab title="On-premises" %} ``` http(s)://://api?cmd=get_info&version=2&check_kit=ai_lt_hs1 ``` {% endtab %} {% endtabs %} ### Response The example shows two languages. The full response contains all the languages that the service supports. ```json { "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](#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](#check-types). | {% hint style="info" %} 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. {% endhint %} #### 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](/v6.18.1/features/spell-and-grammar-check.md). | | `grammar` | Grammar check. See [Spell and grammar check](/v6.18.1/features/spell-and-grammar-check.md). | | `style` | Style check with the style guide rules. See [Style check](/v6.18.1/features/style-check.md). | | `autocomplete` | Text autocomplete. See [Text autocomplete](/v6.18.1/features/text-autocomplete.md). | | `autocorrect` | Spelling autocorrect. See [Spelling autocorrect](/v6.18.1/features/spelling-autocorrect.md). | | `generate` | Text operations of the AI writing assistant. See [AI writing assistant (AIWA)](/v6.18.1/features/ai-writing-assistant-aiwa.md). | ### See also * [Get info API version 1](/v6.18.1/api-reference/auxiliary-api-commands/get-info-api/version-1.md) for the default response format. * [Supported languages](/v6.18.1/features/supported-languages.md) for the full language list. * [Check kits](/v6.18.1/deployment/configuration/application-server/check-kits.md) for the engine combinations that a check kit selects.