Documentation

API URL


GET /spell-check

Headers
Code
Content-Type: application/json
Query Parameters


Example GET Request

Code
GET /api/v1/spell-check?text=Hello%20wrold%2C%20this%20is%20a%20tets&language=en&suggestions=true&includeGrammar=true

Successful Response

Status
HTML
200 OK
Body
Code
{
  "language": "en",
  "issues": [
    {
      "word": "wrold",
      "position": 6,
      "suggestions": [
        "world"
      ]
    },
    {
      "word": "tets",
      "position": 22,
      "suggestions": [
        "tests",
        "test"
      ]
    }
  ],
  "suggestions": {
    "wrold": [
      "world"
    ],
    "tets": [
      "tests",
      "test"
    ]
  },
  "grammarHints": [],
  "metadata": {
    "correlationId": "spell-1702234567890-abc123"
  }
}

Error Response

Example
Code
400 ValidationError - Missing invalid or oversized text input: Spell-check request failed schema validation
400 ValidationError - Unsupported language code: Language parameter is outside allowed enum
404 NotFound - Route not found: Requested endpoint is not implemented
429 RateLimitExceeded - Too many requests from same IP: Service rate limiter blocked request
500 InternalServerError - Unexpected runtime failure in spell-check pipeline: Internal processing failure

Last Updated:  May 4, 2026