Check Text

Back to overview

Endpoint

GET https://api.reporting.cloud/v1/proofing/check

Checks text for spelling errors

Request Parameters

Query parameter Value Type Value
text String Specifies the text to spell check.
language String The language that is used to spell check the specified text.

Response Format

On success, the HTTP status code in the response header is OK (200). The response body contains a list of ReportingCloud IncorrectWord objects.

A Forbidden (403) is returned, if the user is not authorized.

IncorrectWord object

Key Value type Value description
length Integer Gets the length of the spelled word.
start Integer Gets the starting position of a spelled word.
text String Gets the text of the spelled word.
isDuplicate Boolean Gets a value indicating whether the spelled word is declared as incorrect, because the previous word has the same text.
language String Gets a value indicating the language the incorrect word was spelled.

Examples

Note: The code examples available for this method do not represent all supported programming languages.

Try this in the Web API Sandbox

Open Sandbox