> 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-1.md).

# Get info API version 1

The default response of the get\_info command, with a separate language list for each check type.

Version 1 is the default response of the `get_info` command.

It gives the supported languages as a separate list for each check type.

{% hint style="info" %}
Use [version 2](/v6.18.1/api-reference/auxiliary-api-commands/get-info-api/version-2.md) for new integrations. Version 2 gives the check types of each language in one structure.
{% endhint %}

**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 | No         | Response version. Omit this parameter to get the version 1 response.          |
| `serviceid` | string | Cloud only | Cloud API key. It is required for Cloud requests. It is not used on-premises. |

### Request example

{% tabs %}
{% tab title="Cloud" %}

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

{% endtab %}

{% tab title="On-premises" %}

```
http(s)://<host>:<port>/<virtual_dir>/api?cmd=get_info
```

{% endtab %}
{% endtabs %}

### Response

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

```json
{
    "langList": {
        "ltr": {
            "auto": "Autodetect",
            "en_US": "English (US)"
        },
        "rtl": {
        }
    },
    "grammarLangList": {
        "ltr": {
            "auto": "Autodetect",
            "en_US": "English (US)"
        },
        "rtl": {
        }
    },
    "cdModificationTime": 1704364640,
    "programVersion": "6.17.0.0 master:1d0c284 (1109) #1009",
    "freeze": 0,
    "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                                                                                                                                                  |
| ---------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `langList`             | object | The languages available for the spell check. The languages are grouped by text direction, `ltr` and `rtl`. Each item maps a language code to a display name. |
| `grammarLangList`      | object | The languages available for the grammar check. It has the same structure as `langList`.                                                                      |
| `generateLangList`     | object | The languages available for the AI writing assistant. Each item maps a language code to a display name.                                                      |
| `programVersion`       | string | The version of the application.                                                                                                                              |
| `cdModificationTime`   | number | The time of the last change to the custom dictionaries, in Unix time.                                                                                        |
| `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.                                                                                      |

{% hint style="info" %}
The `auto` code in `langList` and in `grammarLangList` is not a language. It tells the service to detect the language of the text.
{% endhint %}

### See also

* [Get info API version 2](/v6.18.1/api-reference/auxiliary-api-commands/get-info-api/version-2.md) for the current response format.
* [Supported languages](/v6.18.1/features/supported-languages.md) for the full language list.
* [AI writing assistant (AIWA)](/v6.18.1/features/ai-writing-assistant-aiwa.md) for the text operations in `prompts`.
