Getting Started with the GrammarBot API

Thanks for choosing the Grammar Bot API to integrate detection of grammar and spelling errors into your project. Using a new API can sometimes be a challenge, so we’ve written a quick 3-minute guide to walk you through how to make your first API call and interpret the results.

Step 1: Get an API Key

Use this link or the Signup button below to get your API key.

SIGNUP NOW

Step 2: Submit Text & Receive Grammar Corrections

Using the GrammarBot API is as easy as making a request and receiving suggested spelling and grammar corrections in JSON format. Just add your API key in the code below:

cURL / Shell

curl -X POST https://neural.grammarbot.io/v1/check \
  -H "Content-Type: application/json" \
  -d '{"text": "This be the best", "api_key": <API KEY>}'

Python

import requests
import json

url = "https://neural.grammarbot.io/v1/check"
headers = {
    "Content-Type": "application/json"
}
data = {
    "text": "This be the best",
    "api_key": <API KEY>
}

response = requests.post(url, headers=headers, data=json.dumps(data))
print(response.json())

Example Response (JSON)

{
  "correction": "This is the best",
  "status": 200,
  "edits": [
    {
      "start": 5,
      "end": 7,
      "replace": "is",
      "edit_type": "MODIFY",
      "err_cat": "GRMR",
      "err_type": "",
      "err_desc": ""
    }
  ],
  "latency": 0.901
}

For more information on this entire process, the API request options, and the API results object, please view our documentation site:

https://docs.grammarbot.io/

NOTE: Browser-based “AJAX” requests will not work due to CORS restrictions. To use in a browser, create a server-side script that acts as a proxy.

Tutorials

Take your learning a step further with these tutorials to help you get up and running quickly:

Coming soon

Request Limits

Text longer than 5,000 characters must be split into separate requests. Contact us if your application requires more than this and you are unable to split the requests on your side.

Custom Development - Hire Us

Who better to integrate GrammarBot into your application or service than GrammarBot? The cost of hiring our team is often (if not usually) less expensive than working with your own internal development staff. We offer custom software development with particular expertise in NLP, Machine Learning, and AI. Contact us for more information.

Grammar Check API Quickstart