Spell Checker

Overview

A spell check API you can call to check spelling and correct text: send English text and get back whether it passes, how many distinct misspellings were found, and suggested corrections for each misspelled word. Turn on autocorrect to get correctedText, the text with each misspelling replaced by its first suggestion. Paid plans add total and per-word occurrence counts, and offsets to get the start and end position of every occurrence for highlighting in an editor. Spell Checker works by checking each word of the text against an English dictionary and suggesting likely replacements for the ones it does not recognise.

Live Test Spell Checker API →

Endpoint

One host, one path per API. The block below shows this call in four languages; every one of them is the same HTTP request. Making requests covers the timeouts, retries and parameter rules that apply to all of them. The SDKs wrap the same call in a typed client.

1
2
3
4
5
6
7
8

curl -X POST https://api.apiverve.com/v1/spellchecker \
  -H "x-api-key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
  "text": "I neeed to call my friend on telephine today!",
  "autocorrect": true,
  "offsets": true
}'

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

const res = await fetch('https://api.apiverve.com/v1/spellchecker', {
  method: 'POST',
  headers: {
    'x-api-key': 'your_api_key_here',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "text": "I neeed to call my friend on telephine today!",
  "autocorrect": true,
  "offsets": true
}),
});

if (!res.ok) throw new Error(`${res.status} ${await res.text()}`);

const { data } = await res.json();
console.log(data);

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

import requests

res = requests.post(
    "https://api.apiverve.com/v1/spellchecker",
    headers={"x-api-key": "your_api_key_here"},
    json={
    "text": "I neeed to call my friend on telephine today!",
    "autocorrect": True,
    "offsets": True
},
    timeout=15,
)
res.raise_for_status()

print(res.json()["data"])

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

package main

import (
	"fmt"
	"io"
	"net/http"
	"strings"
)

func main() {
	body := strings.NewReader(`{
  "text": "I neeed to call my friend on telephine today!",
  "autocorrect": true,
  "offsets": true
}`)
	req, _ := http.NewRequest("POST", "https://api.apiverve.com/v1/spellchecker", body)
	req.Header.Set("Content-Type", "application/json")
	req.Header.Set("x-api-key", "your_api_key_here")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	out, _ := io.ReadAll(res.Body)
	fmt.Println(string(out))
}

Replace your_api_key_here with the key from your dashboard. When the inputs arrive as a list rather than one at a time, batch requests run up to 200 of them through this same API in a single call.

Authentication

Send your key in the x-api-key header. That is the only auth step — there is no token exchange and no per-endpoint scope to configure. Authentication covers creating, rotating and revoking keys.

Parameters

Sent as JSON in the request body. Premium parameters are accepted on every plan but only take effect on plans that include them.

Response

Every API returns the same three top-level keys, so one response handler covers your whole integration: status, error and data. Only data changes shape. Response format covers the envelope, the other output formats and how premium fields are withheld.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46

{
  "status": "ok",
  "error": null,
  "data": {
    "spellPass": false,
    "mispellingsFound": 2,
    "totalOccurrences": 2,
    "corrections": [
      {
        "word": "neeed",
        "suggestions": [
          "needed",
          "need",
          "needy",
          "Neel",
          "needs"
        ],
        "occurrences": 1,
        "offsets": [
          {
            "start": 2,
            "end": 7
          }
        ]
      },
      {
        "word": "telephine",
        "suggestions": [
          "telephone",
          "telephoned",
          "telephoner",
          "telephones",
          "telephony"
        ],
        "occurrences": 1,
        "offsets": [
          {
            "start": 29,
            "end": 38
          }
        ]
      }
    ],
    "correctedText": "I needed to call my friend on telephone today!"
  }
}

Response fields

Paths are relative to data. Premium fields are absent rather than zeroed on plans that do not include them, so check for presence instead of comparing to 0.

Errors

Read the HTTP status first, then error for the specific reason. The body names the parameter that has to change. Error handling covers the full status list and which of them are worth retrying.

Use cases

Rich Text Editors

Flag typos in user-submitted drafts in real time and display replacement suggestions directly inside the editing interface.

Customer Support Chat

Before sending agent replies to customers, scan message drafts to detect misspelled words and prevent communication errors.

Form Submission Sanitization

Job boards inspect candidate resumes and cover letters upon upload to tally spelling mistakes before forwarding applications to recruiters.

Student Essay Assessment

To automate rubric scoring, learning platforms scan student papers to count uncorrected typos and show teachers the identified errors.

Other ways to use Spell Checker

Set up Spell Checker on APIVerve, or reach the same source a different way. Your APIVerve account and credits work on all of them — one key, one balance.

Related

More in Text Processing: