API Documentation

Getting Started

Welcome to the GrammarCheck.ai API. Our API provides developers with high-performance text processing tools, including real-time grammar checking, intelligent paraphrasing, and plagiarism detection.

To start using the API, you first need to generate an API Key from your Access Credentials tab. Once you have a key, you can authenticate your requests by including it in your HTTP headers.

Authentication

GrammarCheck.ai uses API keys to authenticate requests. All API requests should be made over HTTPS. Unauthorized requests will return a 401 Unauthorized error.

API Key

Authorization:  Bearer YOUR_SECRET_KEY

Limitation Page

Our API has certain limitations based on your subscription plan. These include word limits per request and rate limits per minute.

For most plans, the maximum word limit per request is 1000 words. If you need higher limits, please contact our support team or upgrade your plan.

Grammar Check

Analyze text for grammatical errors, spelling mistakes, and punctuation issues.

curl -X POST "https://www.grammarcheck.ai/api/user/grammarcheck-api" \
     -H "Authorization: Bearer YOUR_SECRET_KEY" \
     -H "Content-Type: application/json" \
     -d '{"text": "Your text here"}'

Parameters

Parameter	Type	Description
`text`	string	The text you want to check for grammar.
`lang`	string	Optional. Currently only available in English ('en'). Default: 'en'

Examples

Basic Grammar Check Request

123

{
    "text": "Your long text here...",
    "lang": "en"  // default: en
}

Example Response

123456789

{
    "status": true,
    "data": {
        "message": "Success",
        "original": "This is a example.",
        "corrected": "This is an example.",
        "tagged": "This is <span class=\"grammarCheck_api\">an</span> example."
    },
}

Rate Limits

To ensure fair usage and system stability, we implement rate limiting on all API endpoints. The number of allowed requests depends on your plan.

Standard plans typically allow 20 requests per minute. Exceeding this limit will result in a 429 Too Many Requests error.

Error Codes

Grammarcheck.ai uses standard HTTP status codes to indicate the success or failure of an API request.

Common Errors

STATUS	ERROR	DESCRIPTION
401	Unauthorized	1. API key is required. 2. Incorrect API key provided.
413	Payload Too Large	The text may not be greater than allowed words.
417	Expectation Failed	1. An internal error occurred while processing the request. 2. Unable to paraphrase the text. 3. Unable to check plagiarism. 4. An unexpected error occurred.
422	Unprocessable Entity	One or more request parameters are invalid or missing.
429	Too Many Requests	The rate limit of requests per minute depends on your plan.