Dovetail Seeker Documentation

Spell Check API

Dovetail Seeker Web API includes a spell checking service. It accepts web requests that contains text to check for misspelled words and returns suggestions for each misspelled word in JSON data format.

The spell check service currently only supports the English language.

Usages

The spell checking service is an HTTP endpoint that accepts either GET or POST requests with text parameter as the input and JSON as the output.

Input

URL:

/seeker/spell/check?text={text}

Format:

JSON

HTTP Method(s):

• GET

Parameters

Parameter	Required	Default	Description
text	yes	n/a	The words to spell check

Output

Content-Type: application/json

Property	Description
Word	The misspelled word
Suggestions	A list of suggested words

Response:

[{
  Word:"tst",
  Suggestions:["ts", "ts"]
}]

Examples

An example of doing an HTTP GET request with a single word.

Request:

GET /seeker/spell/check?text=tst

Response:

[{
  "Word":"tst",
  "Suggestions":["tat","ts","st","test","est"]
}]

Browsers impose limits on the maximum number of characters allowed in the address bar. If you are potentially checking large amounts of text, you can invoke the spell check with an HTTP POST.

An example of doing an HTTP POST request with a full sentence.

Request:

POST /seeker/spell/check 
HTTP/1.1
Content-Length: 144
Content-type: application/x-www-form-urlencoded
text=That is, your spelling. To get an idea, take this simple test. 
Is it affidavit or affidavid? accommodate or accomodate? conquer or conquor?

Response:

[{
  "Word":"affidavid",
  "Suggestions":[
    "affidavit","affianced","affiliated","affirmative","affiliation"
  ]
},{
  "Word":"accomodate",
  "Suggestions":[
    "accommodate","accommodating","accommodation","accomplice","accompanist"
  ]
},{
  "Word":"conquor",
  "Suggestions":[
    "conquer","conquest","conquistador","conjuror","conductor"
  ]
}]