# | 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 | 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 plain text as well. Avoid using # and & symbols in the text. |
|
4 | tokens | - Array of strings, e.g. ["This is a sentence number 1.", "This is a sentence number 2."]
|
| A piece of text separated in tokens that will be sent for check. The text should be presented as an array of strings. Right now each string is a token which equals one sentence. You can use either tokens or text at a time in a request. However, using text is more common. |
|
5 | lang | | en_US | A short code of a language which will be used for check. |
6 | disable_spelling | | false | Disable the check text for spelling errors. |
7 | disable_grammar | | false | Disable the check text for grammar and style problems. |
8 | user_dictionary | - user dictionary name (e.g. testdict)
|
| A user dictionary name which will be used during spell checking. |
9 | user_wordlist | |
| The list of additional comma-separated words which will be used for spell checking. |
10 | 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. |
|
11 | 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. |
12 | 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. |
13 | 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. |
14 | 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. |
15 | min_word_length | - minimal number of letters in a word to be checked
| 3 | The minimal number of letters in the word which will be checked for spelling. E.g. if 3 is specified, the words with 2 letters and less will be ignored. |
16 | custom_punctuation | - string of chars (e.g. “-“)
| - | A list of characters that should be considered as delimiters during spelling check. |
17 | short_answer | | false | Shorten every static string JSON key name, like messages or type down to its first character, for example: - m - matches, message
- o - offset
- l - length
- t - type
- r - rule
- s - suggestions
|
18 | 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. |
|
19 | auto_lang_priorities | {"en":"en_US", "es":"es_ES"} |
| Priority of language dialect for auto-detected language code. For example, of auto-detect returns "en", then American English will be used as a language for check. |
20 | disable_style_guide | | false | Disabling style guide functionality starting WebSpellChecker v.5.29.0.0 |
21 | disabled_rules | | []
| Disabling specific grammar rules IDs starting WebSpellChecker v.5.29.0.0 |
22 | disabled_categories | | [] | Disabling specific grammar rules categories starting WebSpellChecker v.5.29.0.0 |
23 | enforce_ai | | false | To replace the classic algorithmic engines with an AI-powered engine starting WebSpellChecker v.5.25.0.0. It only works along with American, British, Canadian and Australian English. |