Spell Check API

The Spell Check API retrieves “Did you mean?” suggestions, along with other spelling and grammar corrections.

Endpoint

GET https://app.keyspider.io/api/v1/{{Organization-Id}}/{{API-Key}}/spell?q=freshwors

Try Yourself: Spell Check API Swagger workplace

Description: You can interact with the live API to experience and explore the capabilities of the Spell Check API. The demo allows you to simulate API requests, view responses, and understand how the Spell Check API functions in a real-world scenario. Feel free to input different search queries or words to see how the API responds with spell corrections.

Query Parameters

• q (required): The search query string.

Request Example

curl -X 'GET' 
  'https://app.keyspider.io/api/v1/16575912397417890_8007/80rf53f98adf5526f2b5fffffbf55b24/spell?q=freshwors' 
  -H 'accept: application/json'

Response

This endpoint provides spell correction suggestions, including “Did you mean?” alternatives, for a given word.

Response Format

The response is in JSON format and contains the spelling correction data.

Response Structure

• code (integer): HTTP response code indicating the success of the API request.
• message (string): A message describing the status of the response.
• spell (array): An array containing spell correction information.
  • {input_word} (string): The input word for which spell correction is performed.
  • {correction} (object): Details about the spell correction.
  • suggestion (array of objects): An array of suggestion objects for the correction.
    • freq (integer): Frequency of the suggestion in the dataset.
    • word (string): The suggested corrected word.

Example Response

{
  "code": 200,
  "message": "success",
  "spell": [
    "freshwors",
    {
      "suggestion": [
        {
          "freq": 236,
          "word": "freshworks"
        }
      ]
    }
  ]
}

Developers can use this API response to implement spell correction features in their applications, suggesting valid alternatives for misspelled words to improve text accuracy and user experience.