Overview
Grammar Check sends your `text` to a helper service built on harper-core 3, the Rust library behind the open-source Harper grammar checker, with an APIVerve layer on top that tunes it for automatic correction. Leading and trailing whitespace is trimmed first; line breaks inside the text are kept. An empty string returns a 400 error, and an input the checker service rejects also returns a 400 rather than a 500.
The text is parsed as Markdown, so inline code, links and URLs are not checked. The English variant is detected from the spelling the writer already uses and returned in `dialect`; British, Canadian, Australian and Indian spellings such as colour or theatre are not changed to American ones. Harper's grammar rules then run over the text, covering subject-verb agreement, a/an, their/they're/there, its/it's, your/you're, could of, repeated words, sentence capitalisation and several hundred common word-choice mistakes. Wording and style advice (shorter phrasings, en dashes and similar preferences) is not reported, because applying it automatically would rewrite correct text.
Spelling suggestions are ranked by how people actually mistype: swapped letters, a missing or extra double letter, a wrong vowel, a neighbouring key and words that sound alike count as smaller mistakes than arbitrary edits, and common words rank ahead of rare ones. A word typed in lowercase is never corrected to a proper noun, and the case you typed is kept, so TOMOROW becomes TOMORROW. Capitalised words in the middle of a sentence are treated as names and left alone unless they are one slip away from a known place or name. Acronyms, words with digits, camelCase identifiers and common technical terms such as JSON, OAuth or npm are not flagged.
`errorCount` is the number of reported problems and `modified` is true when there is at least one. `corrected` is built by applying the first suggestion of every problem, working from the end of the text backwards so earlier offsets stay valid; overlapping problems are reduced to one first, so every correction applies cleanly.
Each entry in `corrections` carries `rule` (the kind of problem, for example `Spelling`, `Agreement`, `Repetition`, `Capitalization` or `Word Choice`), `message`, `position.start` and `position.end` as character offsets into the trimmed text, and `suggestions`, the replacement strings for that span, best first. An empty-string suggestion means delete the span. Offsets count characters, not bytes, so they line up with JavaScript string indexes for most text. On the Free plan `corrections` is null and only the summary fields are returned.
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.
curl -X POST https://api.apiverve.com/v1/grammarcheck \
-H "x-api-key: your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"text": "The the pig snorted when I saw it on the barn gate. I was a little mad becuase it woke up my pupppppy"
}'const res = await fetch('https://api.apiverve.com/v1/grammarcheck', {
method: 'POST',
headers: {
'x-api-key': 'your_api_key_here',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"text": "The the pig snorted when I saw it on the barn gate. I was a little mad becuase it woke up my pupppppy"
}),
});
if (!res.ok) throw new Error(`${res.status} ${await res.text()}`);
const { data } = await res.json();
console.log(data);import requests
res = requests.post(
"https://api.apiverve.com/v1/grammarcheck",
headers={"x-api-key": "your_api_key_here"},
json={
"text": "The the pig snorted when I saw it on the barn gate. I was a little mad becuase it woke up my pupppppy"
},
timeout=15,
)
res.raise_for_status()
print(res.json()["data"])package main
import (
"fmt"
"io"
"net/http"
"strings"
)
func main() {
body := strings.NewReader(`{
"text": "The the pig snorted when I saw it on the barn gate. I was a little mad becuase it woke up my pupppppy"
}`)
req, _ := http.NewRequest("POST", "https://api.apiverve.com/v1/grammarcheck", 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.
A 401 means the key is missing, invalid or expired. A 403 means the key is valid but not permitted here — blocked by a key restriction or an IP allow-list. Running out of credits is a 429.
Parameters
Sent as JSON in the request body. Premium parameters are accepted on every plan but only take effect on plans that include them.
| Parameter | Type | Description |
|---|---|---|
textRequired | string | The English text you want to check for grammatical and spelling errors length 0–50000 |
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.
{
"status": "ok",
"error": null,
"data": {
"modified": true,
"corrected": "The pig snorted when I saw it on the barn gate. I was a little mad because it woke up my puppy",
"errorCount": 3,
"dialect": "American",
"corrections": [
{
"rule": "Repetition",
"message": "Did you mean to repeat this word?",
"position": {
"start": 0,
"end": 7
},
"suggestions": [
"The"
]
},
{
"rule": "Spelling",
"message": "Did you mean `because`?",
"position": {
"start": 71,
"end": 78
},
"suggestions": [
"because"
]
},
{
"rule": "Spelling",
"message": "Did you mean `puppy`?",
"position": {
"start": 93,
"end": 101
},
"suggestions": [
"puppy",
"puppetry"
]
}
]
}
}
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.
| Field | Type | Example | Description |
|---|---|---|---|
modified | boolean | true | Indicates whether any grammar or spelling errors were found |
corrected | string | "The pig snorted when I saw it on the barn gate. I was a little mad because it woke up my puppy" | The text with grammar and spelling corrections applied |
errorCount | number | 3 | Total number of errors found in the text |
dialect | string | "American" | The English variant the text was checked against, detected from its spelling: American, British, Canadian, Australian or Indian |
correctionsPremium | array[3] | Array of corrections with details about each error | |
rulePremium | string | "Repetition" | The kind of problem found, such as Spelling, Agreement, Repetition, Capitalization or Word Choice |
messagePremium | string | "Did you mean to repeat this word?" | Description of the error |
positionPremium | object | {...} | Start and end position of the error in the text |
startPremium | number | 0 | Character offset where the flagged text begins |
endPremium | number | 7 | Character offset where the flagged text ends |
suggestionsPremium | array | [The] | Replacement text for the flagged span, best first. An empty string means the span should be deleted |
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.
| Status | Meaning | What to do |
|---|---|---|
400 | Input was rejected | Read error; it names the parameter. |
401 | Key missing or invalid | Check the header name and the key value. |
403 | Key valid, but not permitted | A key restriction or IP allow-list; see key scoping. |
429 | Rate limited, or out of credits | Read error to tell them apart; see rate limits. |
Start from a template
A working app built on this API, ready to deploy with your own key. Vercel asks for the key when you deploy; the code is on GitHub to change first.
Grammar Checker
Proofread any text and review each suggested fix in place: take it, keep your wording, then copy the result.
- Next.js
- TypeScript
Use cases
- Content Management Proofing
- Flag grammar mistakes in submitted blog drafts and substitute corrected sentences before publishing articles to readers.
- Customer Support Messaging
- When agents write replies in ticketing desks, the system uses the error count to warn them of uncorrected typos.
- Resume Intake Screening
- Job portals scan cover letters during applicant uploads, noting whether the text was modified to preserve clean candidate profiles.
- Student Essay Feedback
- Learning management platforms pass student submissions to display the number of errors and return properly formatted text.
Other ways to use Grammar Check
Set up Grammar Check 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:
