• Share:
  • Bokomaru Publications

API Documentation

Virtual Writing Tutor is a web service for checking the spelling and style of English text. This page documents the API.

Posting

API Keys

We require users to register for an API key.

To generate an API key, fill in the form below and click the "Generate" button.

Check Grammar

The VWT grammar checking service is provided at https://virtualwritingtutor.com/API/checkgrammar.php. For any call you have to use POST.

Variables

Key

Value

Description

text

the sentence to check

Required, this is the data to check.

Response

A typical response will look like this:

input : text ( e.g. "He has go to beach by his friend Jane." )

output : { "status": "1", "message": "Successfully checked",

"error_grammar_count_total": 2, "error_grammar_percent": "23%",

"check_grammar_feedback": [ { "context": "He has go to beach by his friend Jane.",

"error_grammar": "has go",

"feedback_grammar": "You probably need a past participle here. Try this instead: ''has gone''." }, {

"context": "He has go to beach by his friend Jane.",

} ] }

If an error occurs, you'll get a response like this:

<Sample>

The usual cause is a bad API key or the grammar checker is updating and so unavailable for 30 seconds while the system loads the new rules.

Check Spelling

This call checks one word at a time. The VWT grammar checking service is provided at   https://virtualwritingtutor.com/API/checkspelling.php . For any call you have to use POST.

Variables

Key

Value

Description

text

the word to check

Required, this is the data to check.

Response

A typical response consists of multiple metric values, like this:

key : text

value : frgg

response : { "mistake_spelling": "frgg",

"suggestion_spelling": "frig, frog, forgo, freq" }

Need help for installation?

Contact us for an affordable installation service.

Get your API

First name* :

Last name* :

Email* :

Website* :

IP:

Terms

  • Reselling the API service to a third party is not permitted.

  • The API user will publically display a hyperlink to VirtualWritingTutor.com on the website where the API is used, crediting the Virtual Writing Tutor.

  • Bokomaru Publications, the owner and operator of VirtualWritingTutor.com, will endeavor to maintain uninterrupted service for the duration of the paid subscription to the API, but the API user acknowledges that Bokomaru Publications will not be held liable for interruptions of service.

I agree to these terms and conditions: