> 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.11.0/api-reference/legacy-api-commands/check-spelling-api.md).
# Check spelling API
[Check API](/v6.11.0/api-reference/check-api.md) combines all available check types and is a replacement for older Check spelling API and [Grammar check API](/v6.11.0/api-reference/legacy-api-commands/grammar-check-api.md).
**Command name:** check\_spelling
Here is a list of all possible parameters and values that can be used with the **check\_spelling** command.
| # | Parameter | Possible Values | Default Value | Description |
| -- | ---------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 1 | format | | json | The response format for output data. |
| 2 | callback | |
| A callback function name that will be used to manipulate with the JSON data received from the server. Such approach enables sharing of data bypassing same-origin policy. It can be used only along with “format=json”. |
| 3 | out\_type | - positions – Return positions and length of misspelled words in a given text and their suggestions.
- words – Return misspelled words and their suggestions.
| words | A type of data output specifying the way to return misspelled words positions in the provided text or exact words. |
| 4 | ignore\_all\_caps | - 0 – Do not ignore all words written in capital letters (e.g. UPPERCASE).
- 1 – Ignore all words written in capital letters.
| 0 | Ignore capitalized words. |
| 5 | ignore\_words\_with\_numbers | - 0 – Do not ignore words that contain numbers (e.g. Number1).
- 1 – Ignore words that contain numbers.
| 0 | Ignore words containing numbers. |
| 6 | ignore\_mixed\_case | - 0 – Do not ignore words with mixed case letters (e.g. MixedCase).
- 1 – Ignore words with mixed case letters.
| 0 | Ignore words written with mixed case letters. |
| 7 | ignore\_domain\_names | - 0 – Do not ignore web addresses that start with either “www”, “http:” or “https:” and end with a domain name.
- 1 – Ignore web addresses and domain names.
| 0 | Ignore domain names, web addresses. |
| 8 | text | |
| A piece of text which will be sent for check. The text has to be in the UTF-8 encoding. Any found tags in the text will be interpreted as a plan text as well.
Avoid using # and & symbols in the text.
|
| 9 | slang | | en\_US | A short code of a language which will be used for spell checking. |
| 10 | user\_dictionary | - user dictionary name (e.g. testdict)
|
| A user dictionary name which will be used during spell checking. |
| 11 | user\_wordlist | |
| The list of additional comma-separated words which will be used for spell checking. |
| 12 | custom\_dictionary | - custom dictionary IDs (e.g. 100694)
|
| Global custom dictionary ID(s) which can be used during spell checking.
Each new Dictionary on the creation obtains its unique Dictionary ID. Depending on the type of the version of product you are using, refer to Cloud or Server guides respectively.
|
| 13 | version | 1.0 | 1.0 | The version of Web API. |
| 14 | customerid | |
| A special service ID value (activation key) that has to be passed to a request query. It's obtained upon subscription to the Cloud services (paid or trial).
Applicable only for the Cloud version.
|
#### Example 1: \[GET] Check spelling
Request URL (GET):
```javascript
http(s)://endpoint/?cmd=check_spelling&format=json&text=This sampl text demonstrates the work of the WebSpellChecker Web API service.&out_type=words&slang=en_US
```
**Parameters:**
* Command: *check\_spelling*
* Format: *json*
* Text: *This sampl text demonstrates the work of the WebSpellChecker Web API service.*
* Output: *words*
* Language: *en\_US*
**Response:**
```javascript
[
{
"word": "sampl",
"ud": false,
"suggestions": [
"sample",
"sampled",
"sampler",
"samples",
"ample",
"amply",
"scamp",
"stamp"
]
}
]
```
#### **Example 2: \[POST] Check spelling**
Here we use the same request and parameters as described in example above but form it as a POST request.
Request URL (GET):
```javascript
http(s)://endpoint/?
```
Body (Raw):
```javascript
cmd=check_spelling&
text=This sampl text demonstrates the work of the WebSpellChecker Web API service.&
out_type=words&
slang=en_US
```
**Response:**
```javascript
[
{
"word": "sampl",
"ud": false,
"suggestions": [
"sample",
"sampled",
"sampler",
"samples",
"ample",
"amply",
"scamp",
"stamp"
]
}
]
```