ReportingCloud

Proofing

Endpoint

To check the spelling of a text from your application, call the endpoints below /v1/proofing. GET /v1/proofing/check returns the misspelled and the repeated words of a text, each with its position, length and dictionary and whether it is returned because it repeats the word before it. GET /v1/proofing/suggestions returns up to max corrections for one misspelled word, and GET /v1/proofing/availabledictionaries lists the dictionaries. The text or word and the dictionary are query parameters: language takes a dictionary name such as en_US.dic, as the examples show.

Check and suggestions count against the spell checking quota, the proofing transactions of your plan, one per request, however many words the text has. A request answered with an error counts none, and availabledictionaries doesn't count. The .NET SDK calls the endpoints with CheckText, GetSuggestions and GetAvailableDictionaries, the PHP SDK with proofingCheck, getProofingSuggestions and getAvailableDictionaries, the Java SDK with checkText, getSuggestions and getAvailableDictionaries and the Ruby SDK with check_text, get_suggestions and get_available_dictionaries. Spell Checking shows how the three work together.

Methods

MethodEndpointDescription
GET/v1/proofing/availabledictionariesReturns all available dictionaries for supported proofing languages.
GET/v1/proofing/checkChecks text for spelling errors.
GET/v1/proofing/suggestionsReturns suggestions for a misspelled word.