Essay Checker API Documentation

The Virtual Writing Tutor provides web services for checking essays in English. Our essay checker API allows for the integration of essay proofreading and scoring services into any website or application. This page documents the essay API.

Please note that we recommend that automatically generated feedback and scores be used to support learning and not for high stakes decisions unless reviewed and validated by a human teacher.

This webpage is intended for programmers only. English language learners should go to the grammar checker page to login for a free member's account.

Need help with installation? Contact us for an affordable installation service.

We require users to register for an API key*. To generate an API key*, fill in the form below and click the "Generate" button.

*Note: If you already have a grammar checker API key, then there is no need to generate another. We recommend that you use same API key.

URLHEADERSMETHODREQUESTRESPONSE
https://console.virtualwritingtutor.com/console/essay/essay-tasksvwtApiKey

(This is your API key)
GET { "jsonrpc": "2.0", "status": true, "result": [ { "task_name": "IELTS", "task_link": "ielts" }, { "task_name": "Actively Engaged in Academic Writing", "task_link": "actively-engaged-in-academic-writing" }, { "task_name": "Actively Engaged at College", "task_link": "actively-engaged-at-college" }, { "task_name": "Actively Engaged on the Job", "task_link": "actively-engaged-on-the-job" }, { "task_name": "Actively Engaged Online", "task_link": "actively-engaged-online" }, { "task_name": "Actively Engaged in Persuasion", "task_link": "actively-engaged-in-persuasion" } ] }
URLHEADERSMETHODREQUESTRESPONSE
https://console.virtualwritingtutor.com/console/essay/test-list/ielts*

*(ielts) is task_link from previous API (Step 1) output
vwtApiKey

(This is your API key)
GET { "jsonrpc": "2.0", "status": true, "result": [ { "test_name": "TASK 1 test 1", "task_name": "IELTS", "test_link": "t1-task 1 test 1" }, { "test_name": "TASK 1 test 2", "task_name": "IELTS", "test_link": "t1-task 1 test 2" }, { "test_name": "TASK 1 test 3", "task_name": "IELTS", "test_link": "t1-task 1 test 3" }, { "test_name": "TASK 2 test 1", "task_name": "IELTS", "test_link": "t2-task 2 test 1" }, { "test_name": "TASK 2 test 2", "task_name": "IELTS", "test_link": "t2-task 2 test 2" }, { "test_name": "TASK 2 test 3", "task_name": "IELTS", "test_link": "t2-task 2 test 3" }, { "test_name": "TASK 2 test 4", "task_name": "IELTS", "test_link": "t2-task 2 test 4" } ] }
URLHEADERSMETHODREQUESTRESPONSE
https://console.virtualwritingtutor.com/console/essay/test-info/t1-task 1 test 1*

*(t1-task 1 test 1) is test_link from previous API (Step 2) output
vwtApiKey

(This is your API key)
GET { "jsonrpc": "2.0", "status": true, "result": [ { "test_name": "TASK 1 test 1", "test_link": "t1-task 1 test 1", "task_name": "IELTS", "task_type": "1", "test_question": <p><i>Answer the question below provided by the&nbsp;<a href="https://www.ielts.org/-/media/pdfs/120430_academic_writing_task_1a.ashx?la=en" target="_blank">official IELTS website</a>.</i></p><p><i>You have 20 minutes. Write a minimum of 150 words.</i></p><p><b>The chart below shows the number of men and women in further education in Britain in three periods and whether they were studying full-time or part-time. Summarise the information by selecting and reporting the main features, and make comparisons where relevant.</b></p>, "test_image": "https://expressdev.virtualwritingtutor.com/ielts_task_tests_img/e9f46e40-d967-11e9-a7ff-f7dbba79e4f1.jpg", "test_timer": 20 } ] }
URLHEADERSMETHODREQUESTRESPONSE
https://console.virtualwritingtutor.com/console/essay/test-feedback

(* For HTML response)

Content-Type: application/json

vwtApiKey

(This is your API key)
POST*test_link (t1-task 1 test 1) is the test_link from step 2 API output

{ "test_link" : "t1-task 1 test 1","text":"It is common belief that children should be educated a foreign language for children at primary school rather than secondary school. While this issue is beneficial to some extent, I strongly side with it. No doubt, it is much better for children to begin learning a foreign language at primary school because children are fast learners and acquiring a new language is good for their neurological development.\nFirstly, at the primary school, children can learn faster than that at secondary school. It is true that children are between five and nine years old have the capacity to remember things fast twice as people in others age group. For instance, in China children can learn three languages such as German, English and France at an early age.\nSecondly, learning a foreign language is helpful for developing a child’s brain. One research shown that learning any language could activate various new parts, which were never used before in their brain. Hence, School also have to play an important role to generate the suitable environment and methods for children learning language.\nOn the other hand, at secondary school, pupils have to learn more subjects, which is compulsory in the curriculum such as Chemistry, Biology and History. Therefore, they have to spend time on learning more subjects, leading to the lack of time to learn another language. In addition, in modern days, it is necessary that children have to learn a foreign language. These days, workers prefer working at multinational company, where it has high salary and healthy working place. Hence, pupils have to being multilingual to have more job prospects in these companies.\nTo sum up, instruction in a second language at elementary school is better than leaving it until later in life because kids learn new languages quickly when young and language learning has a beneficial affect on kids' growing brains. It is without doubt that despite a few burdensome aspects, this issue would still do more good than harm." }

https://console.virtualwritingtutor.com/console/essay/test-feedback/json

(* For JSON response)

Content-Type: application/json

vwtApiKey

(This is your API key)
POST*test_link (t1-task 1 test 1) is the test_link from step 2 API output

{ "test_link" : "t1-task 1 test 1","text":"It is common belief that children should be educated a foreign language for children at primary school rather than secondary school. While this issue is beneficial to some extent, I strongly side with it. No doubt, it is much better for children to begin learning a foreign language at primary school because children are fast learners and acquiring a new language is good for their neurological development.\nFirstly, at the primary school, children can learn faster than that at secondary school. It is true that children are between five and nine years old have the capacity to remember things fast twice as people in others age group. For instance, in China children can learn three languages such as German, English and France at an early age.\nSecondly, learning a foreign language is helpful for developing a child’s brain. One research shown that learning any language could activate various new parts, which were never used before in their brain. Hence, School also have to play an important role to generate the suitable environment and methods for children learning language.\nOn the other hand, at secondary school, pupils have to learn more subjects, which is compulsory in the curriculum such as Chemistry, Biology and History. Therefore, they have to spend time on learning more subjects, leading to the lack of time to learn another language. In addition, in modern days, it is necessary that children have to learn a foreign language. These days, workers prefer working at multinational company, where it has high salary and healthy working place. Hence, pupils have to being multilingual to have more job prospects in these companies.\nTo sum up, instruction in a second language at elementary school is better than leaving it until later in life because kids learn new languages quickly when young and language learning has a beneficial affect on kids' growing brains. It is without doubt that despite a few burdensome aspects, this issue would still do more good than harm." }
URLHEADERSMETHODREQUESTRESPONSE
https://console.virtualwritingtutor.com/console/auth/info?vwtapikey=xxxxxxxx*

*(xxxxxxxx) is your API key
N/AGET { "jsonrpc": "2.0", "status": true, "result": [ { "client_name": "xxx", "client_email": "xxx", "api_key": "xxxxxxxx", "used_essay_hits": 1, "total_essay_hits": 100, "remaining_essay_hits": 99, "used_grammar_hits": 100, "total_grammar_hits": 100, "remaining_grammar_hits": 0 } ] }

For Step 1 to Step 3, the system will not register any hits, so your account will not be debited any calls while them. For each single call during Step 4 (which generates feedback), your account will be debited 1 call because the system registers 1 hit each time.

See below for the price list

No.Package NamePriceDuration(in months)Total hits

Terms

  • The API user will publicly 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: