Spelling

Engine Type	Supported?
Crawler-based Engine	YES
API-based Engine	YES

Spell check search request.

The language used in your spelling correction will match the language of your indexed documents.

There are 3 different spelling options:

Spelling Options	Description
strict	Returns a spelling correction value when there are no results matching the submitted query
always	Returns a possible spelling correction even if there are query matched results
retry	Automatically retries the search request with the spelling corrected value if there are no results, but there is a spelling correction. Note that retry can lead to a slight decline in performance as a result of running 2 queries.

q
required: The query used within your search.
engine_key
required: The Engine Key associated with your Engine. Found within your dashboard.
spelling
optional: Values can be strict, always, or retry.

Example - Returns suggestions for the query "spprt" using the always parameter. The correct query, "support", returns in the spelling_suggestion object.

curl -XGET 'https://search-api.swiftype.com/api/v1/public/engines/search.json' \
  -H 'Content-Type: application/json' \
  -d '{
        "engine_key": "5jZG1gmmCTFYbSSDjpqq",
        "q":"spport",
        "spelling": "always"
      }'

  {
    "record_count": 0,
    "records": {
      "page": []
    },
    "info": {
      "page": {
        "query": "spport",
        "current_page": 1,
        "num_pages": 0,
        "per_page": 20,
        "total_result_count": 0,
        "facets": {},
        "spelling_suggestion": {
          "text": "support",
          "score": 0.036801625
        }
      }
    },
    "errors": {}
  }

Stuck? Looking for help? Contact support or check out the Site Search community forum!

Site Search

Guides

Site Search API

API Reference

API Clients

Plugins

Resources

Spelling