Download OpenAPI specification:Download
Documentation of the OX Software GmbH SpellCheck service Http API.
Check spelling of the given paragraphs, using the given locales.
Array of objects Paragraphs consisting of texts to check spelling for. | |
noReplacements | boolean Default: false Optional property to specify if replacments should be retrieved and returned for the current request. Default is set to false, so that replacements are returned if not specified. |
{- "paragraph": [
- {
- "locale": "string",
- "word": "string"
}
], - "noReplacements": false
}
{- "spellResult": [
- {
- "length": 0,
- "locale": "string",
- "start": 0,
- "word": "string",
- "replacements": [
- "string"
]
}
]
}
Check spelling of the given text using the given locale.
locale | string The locale to be used to check the spelling of the given text. |
text | string The text to check spelling for, using the given locale and required language encoding of the used dictionary. |
offset | integer Offset that is added to the appropriate character position within the response for detected, misspelled words. |
noReplacements | boolean Default: false Optional property to specify if replacments should be retrieved and returned for the current request. Default is set to false, so that replacements are returned if not specified. |
{- "locale": "string",
- "text": "string",
- "offset": 0,
- "noReplacements": false
}
{- "spellResult": [
- {
- "length": 0,
- "locale": "string",
- "start": 0,
- "word": "string",
- "replacements": [
- "string"
]
}
]
}
Checking if a word is misspelled, using the given locale.
locale | string The locale to be used to check the spelling of the given word. |
word | string The word to check spelling for, using the given locale and required language encoding of the used dictionary. |
{- "locale": "string",
- "word": "string"
}
{- "spellResult": true
}
Retrieving the suggested replacements for a given word, using the given locale.
locale | string The locale to be used to check the spelling of the given word. |
word | string The word to check spelling for, using the given locale and required language encoding of the used dictionary. |
{- "locale": "string",
- "word": "string"
}
{- "spellResult": [
- "string"
]
}