Get Suggestions

Back to overview

Endpoint

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

Returns suggestions for a misspelled word

Request Parameters

Query parameter Value Type Value
word String Specifies the incorrect word that has to be determined for suggestions.
language String The language that is used to spell check the specified text.
max Integer Specifies the maximum number of suggestions that has to be determined.

Response Format

On success, the HTTP status code in the response header is OK (200). The response body contains an array of strings with suggestions.

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

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