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-feedbackContent-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." }
{ "jsonrpc": "2.0", "status": true, "result": { "wordCount": { "value": 328, "msg": "You have written much more than the minimum number of words. You have good writing fluency.", "score": 9 }, "sentenceCount": { "sentenceLength": { "value": 20.5, "msg": "An appropriate average sentence length for this task is 20-25 words. Your sentences are the right length.", "score": 8 }, "sentenceVariance": { "value": 7.07, "msg": "It is important to vary the length of your sentences. You have a moderate degree of variability in your writing, which is appropriate for an academic writing task such as this.", "score": 9 } }, "paragraphCount": { "value": 5, "msg": "I was expecting 4 paragraphs. You have too many paragraphs for an essay writing task like this.", "score": 6 }, "exclamationMarks": { "value": 0, "msg": "Never use exclamation marks in academic writing.", "score": 0 }, "cohesion": { "value": 1, "msg": "Show the relationship of your ideas with the appropriate set of transition words. These are the transitions I expected to see: although, again, also, significantly, however, respectively", "score": 5 }, "requiredStructures": { "value": 0, "msg": "You are missing some of the concepts in the chart. These are the concepts I expected to see you cover: men, women, education, full-time, part-time", "score": 0 }, "lemmatizedVocabulary": { "value": 0, "msg": "You used some of the words in your writing that I was expecting, but not as many as I wanted to see. Here are the bas forms of the words I was looking for: increase, indicate, period, respect, result, chart, considerable, decline, decrease, enrol, tertiary", "score": 5 }, "targetStructure": { "value": 2, "msg": "You have mentioned some of the information contained in the chart. I anticipated you would usemore of these items: more, less, than, about the same, increase, decrease, increases, decreases, increased, decreased, decline, rise, rises, rising, rose, declining, declines, declined, there were, there was, thousand, million, further, education, male, female, decades, 1970/71, 1980/81, 1990/91", "score": 5 }, "clicheProfile": { "value": 0, "msg": "Keep your writing fresh by avoiding clichés.", "score": 0, "words": [] }, "errorCount": { "errorData": { "jsonrpc": "2.0", "status": true, "result": [ { "msg": "Use an article with singular countable nouns. \"It is a common belief\"", "context": "It is common belief that children should be educated a foreign language for children at primary school rather than secondary school.", "suggestions": [ { "value": "It is a common belief" } ], "marked_text": "\t\t\tIt is common belief that children should be educated...", "rule_id": "ARTICLE", "rule_sub_id": "ARTICLE", "category_name": "Article error", "url_rule": "" }, { "msg": "You have left out a required preposition. Did you mean \"educated in a foreign language\"? ", "context": "It is common belief that children should be educated a foreign language for children at primary school rather than secondary school.", "suggestions": [ { "value": "educated in a foreign language" } ], "marked_text": "...s common belief that children should be educated a foreign language for children at prim...", "rule_id": "SHOULD_be_educated_A_FOREIGN_LANGUAGE", "rule_sub_id": "MISSING PREPOSITION", "category_name": "Preposition missing error", "url_rule": "" }, { "msg": "It is probably redundant to repeat \"children.\" Did you mean \"children should be educated in a foreign language at primary school\"? ", "context": "It is common belief that children should be educated a foreign language for children at primary school rather than secondary school.", "suggestions": [ { "value": "children should be educated in a foreign language at primary school" } ], "marked_text": "...n should be educated a foreign language for children at primary school rather than secondary...", "rule_id": "SHOULD_BE_EDUCATED_A_FOREIGN_LANGUAGE", "rule_sub_id": "REDUNDANT", "category_name": "Redundant Phrase error", "url_rule": "" }, { "msg": "An \"issue\" is a topic for debate and discussion or a problem to resolve. The word \"beneficial\" means favorable or advantageous, so it is clearly the wrong word for this context. Try these alternatives: \"this issue is pertinent\" or \"this argument has merit\"", "context": "While this issue is beneficial to some extent, I strongly side with it.", "suggestions": [ { "value": "this issue is pertinent" }, { "value": "this argument has merit" } ], "marked_text": "...ather than secondary school. While this issue is beneficial to some extent, I strongly side with it...", "rule_id": "wrong word in this context", "rule_sub_id": "WORD_CHOICE", "category_name": "Word choice error", "url_rule": [ { "value": "https://blog.virtualwritingtutor.com/word-choice-errors/" } ] }, { "msg": "When you side with someone, you support him or her in a debate. You cannot side with a thing or an abstraction. Try these alternatives: \"I strongly side with them\" or \"I strongly support it\"", "context": "While this issue is beneficial to some extent, I strongly side with it.", "suggestions": [ { "value": "I strongly side with them" }, { "value": "I strongly support it" } ], "marked_text": "...s beneficial to some extent, I strongly side with it. No doubt, it is much better for chi...", "rule_id": "wrong word in this context", "rule_sub_id": "WORD_CHOICE", "category_name": "Word choice error", "url_rule": [ { "value": "https://blog.virtualwritingtutor.com/word-choice-errors/" } ] }, { "msg": "If you are referring to primary schools in general, remove the definite article. It sounds like you are referring a specific school. Revise: \"at primary school\".", "context": "Firstly, at the primary school, children can learn faster than that at secondary school.", "suggestions": [ { "value": "at primary school" } ], "marked_text": "...eurological development. \t\t\tFirstly, at the primary school, children can learn fast...", "rule_id": "Remove-ARTICLE_suitable", "rule_sub_id": "ADJECTIVE_ORDER", "category_name": "Adjective word order error", "url_rule": "" }, { "msg": "The relative pronoun \"who\" seems to be missing here. Try this: \"It is true that children who are between five and nine years old have\".", "context": "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.", "suggestions": [ { "value": "It is true that children who are between five and nine years old have" } ], "marked_text": "...at at secondary school. It is true that children are between five and nine years old hav...", "rule_id": "WHO_MISSING", "rule_sub_id": "WHOM", "category_name": "Relative pronoun error", "url_rule": "" }, { "msg": "Your words are in the wrong order. \"twice as fast as people\". (wo08)", "context": "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.", "suggestions": [ { "value": "twice as fast as people" } ], "marked_text": "...ld have the capacity to remember things fast twice as people in others age group. For inst...", "rule_id": "word_order8", "rule_sub_id": "WORD_ORDER", "category_name": "Word order error", "url_rule": "" }, { "msg": "Adjectives and noun modifiers are almost never plural in English. Don't put an -s on \"other\" when used as an adjective. Revise: \"other age groups\". ", "context": "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.", "suggestions": [ { "value": "other age groups" } ], "marked_text": "...remember things fast twice as people in others age group. For instance, in China child...", "rule_id": "ADJECTIVE_AGREEMENT_31", "rule_sub_id": "NUMBER_AGREEMENT", "category_name": "Number agreement error", "url_rule": [ { "value": "https://blog.virtualwritingtutor.com/50-common-errors/#adjective-agreement-error" } ] }, { "msg": "You seem to have left out a word. Did you mean \"One research study has shown\"? ", "context": "One research shown that learning any language could activate various new parts, which were never used before in their brain.", "suggestions": [ { "value": "One research study has shown" } ], "marked_text": "...ful for developing a child’s brain. One research shown that learning any language could ...", "rule_id": "ONE_RESEARCH", "rule_sub_id": "MISSING_WORD", "category_name": "Missing word error", "url_rule": "" }, { "msg": "You need an auxiliary with a past participle when form in the Present Perfect: \"One research has shown\"?", "context": "One research shown that learning any language could activate various new parts, which were never used before in their brain.", "suggestions": [ { "value": "One research has shown" } ], "marked_text": "...eveloping a child’s brain. One research shown that learning any language could activa...", "rule_id": "MISSING_AUX_IN_PRESENT_PERFECT", "rule_sub_id": "MISSING_AUXILIARY", "category_name": "Missing auxiliary error", "url_rule": "" }, { "msg": "Your subject \"School\" is singular, so conjugate your verb for a singular subject: \"School also has \".", "context": "Hence, School also have to play an important role to generate the suitable environment and methods for children learning language.", "suggestions": [ { "value": "School also has " } ], "marked_text": "...fore in their brain. Hence, School also have to play an important role to generate t...", "rule_id": "NON3PRS_VERB", "rule_sub_id": "VERB_AGREEMENT", "category_name": "Verb agreement error", "url_rule": [ { "value": "https://blog.virtualwritingtutor.com/verb-agreement-errors" } ] }, { "msg": "There is unlikely to be only one suitable environment. You mean any suitable environment, so use an indefinite article. Revise: \"a suitable environment\".", "context": "Hence, School also have to play an important role to generate the suitable environment and methods for children learning language.", "suggestions": [ { "value": "a suitable environment" } ], "marked_text": "...e to play an important role to generate the suitable environment and methods for ch...", "rule_id": "Remove-ARTICLE_suitable", "rule_sub_id": "ADJECTIVE_ORDER", "category_name": "Adjective word order error", "url_rule": "" }, { "msg": "You need an article before the word \"language.\" Did you mean \"a language\" or \"the language\"?", "context": "Hence, School also have to play an important role to generate the suitable environment and methods for children learning language.", "suggestions": [ { "value": "a language" }, { "value": "the language" } ], "marked_text": "...nment and methods for children learning language. \t\t\tOn the other hand, at secondary sch...", "rule_id": "LEARNING_LANGUAGE", "rule_sub_id": "ARTICLE_NEEDED", "category_name": "Missing article error", "url_rule": [ { "value": "https://blog.virtualwritingtutor.com/article-errors/" } ] }, { "msg": "Your subject (subjects) is plural, but you have used a verb conjugated for a singular subject. Revise \"subjects, which are\". ", "context": "On the other hand, at secondary school, pupils have to learn more subjects, which is compulsory in the curriculum such as Chemistry, Biology and History.", "suggestions": [ { "value": "subjects, which are" } ], "marked_text": "...pils have to learn more subjects, which is compulsory in the curriculum such as Ch...", "rule_id": "NNS_WHICH_IS", "rule_sub_id": "VERB_AGREEMENT", "category_name": "Verb agreement error", "url_rule": "" }, { "msg": "You have written a series of items, but you have not separated them with commas consistently. Consider adding a comma here: \"Chemistry, Biology, and History\".", "context": "On the other hand, at secondary school, pupils have to learn more subjects, which is compulsory in the curriculum such as Chemistry, Biology and History.", "suggestions": [ { "value": "Chemistry, Biology, and History" } ], "marked_text": "...ry in the curriculum such as Chemistry, Biology and History. Therefore, they have to spend ...", "rule_id": "COMMA_SERIES", "rule_sub_id": "PUNCTUATION_VWT", "category_name": "Punctuation error", "url_rule": [ { "value": "https://blog.virtualwritingtutor.com/comma-rules-and-errors/" } ] }, { "msg": "Remove the preposition \"on\" before a gerund after the phrase \"spend time.\" \"spend time learning\".", "context": "Therefore, they have to spend time on learning more subjects, leading to the lack of time to learn another language.", "suggestions": [ { "value": "spend time learning" } ], "marked_text": "...ory. Therefore, they have to spend time on learning more subjects, leading to the ...", "rule_id": "PREPOSITION_NOT_NEEDED", "rule_sub_id": "PREPOSITION_NOT_NEEDED", "category_name": "Preposition not needed error", "url_rule": "" }, { "msg": "You have used the definite article where an indefinite article is needed. Try this: \"leading to a lack of time\".", "context": "Therefore, they have to spend time on learning more subjects, leading to the lack of time to learn another language.", "suggestions": [ { "value": "leading to a lack of time" } ], "marked_text": "...e on learning more subjects, leading to the lack of time to learn another language....", "rule_id": "INDEFINITE_ARTICLE_NOT_DEFINITE", "rule_sub_id": "ARTICLE", "category_name": "Article error", "url_rule": "" }, { "msg": "The article is missing before the noun: \"a multinational company\", \"the multinational companies\". Alternatively, use a plural. \"companies\". (ART012)", "context": "These days, workers prefer working at multinational company, where it has high salary and healthy working place.", "suggestions": [ { "value": "a multinational company" }, { "value": "the multinational companies" }, { "value": "companies" } ], "marked_text": ".... These days, workers prefer working at multinational company, where it has high salary and healthy w...", "rule_id": "MISSING_ARTICLE", "rule_sub_id": "ARTICLE_UNCOUNTABLE", "category_name": "Article and uncountable noun error", "url_rule": [ { "value": "https://blog.virtualwritingtutor.com/article-errors/" } ] }, { "msg": "The word \"salary\" should be plural or have an indefinite article. Revise: \"high salaries\" or \"a high salary\".", "context": "These days, workers prefer working at multinational company, where it has high salary and healthy working place.", "suggestions": [ { "value": "high salaries" }, { "value": "a high salary" } ], "marked_text": "...ultinational company, where it has high salary and healthy working place. Hence, pupil...", "rule_id": "ARTICLE", "rule_sub_id": "ARTICLE", "category_name": "Article error", "url_rule": "" }, { "msg": "These words are never used together. Instead, we usually say this: \"a healthy workplace\"", "context": "These days, workers prefer working at multinational company, where it has high salary and healthy working place.", "suggestions": [ { "value": "a healthy workplace" } ], "marked_text": "...y, where it has high salary and healthy working place. Hence, pupils have to being multilingu...", "rule_id": "wrong word in this context", "rule_sub_id": "WORD_CHOICE", "category_name": "Word choice error", "url_rule": [ { "value": "https://blog.virtualwritingtutor.com/word-choice-errors/" } ] }, { "msg": "Use an infinitive form after \"have to.\" Try this: \"pupils have to be multilingual\".", "context": "Hence, pupils have to being multilingual to have more job prospects in these companies.", "suggestions": [ { "value": "pupils have to be multilingual" } ], "marked_text": "...hy working place. Hence, pupils have to being multilingual to have more job prospects...", "rule_id": "VERB_FORM_ERROR", "rule_sub_id": "VERB_FORM_ERROR", "category_name": "Verb form error", "url_rule": "" }, { "msg": "Did you mean \"effect\"?", "context": "To 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.", "suggestions": [ { "value": "effect" } ], "marked_text": "... and language learning has a beneficial affect on kids' growing brains. It is without dou...", "rule_id": "AFFECT_EFFECT", "rule_sub_id": "CONFUSED_WORDS", "category_name": "Commonly confused words", "url_rule": [ { "value": "http://grammar.yourdictionary.com/style-and-usage/affect-effect-grammar.html" } ] }, { "msg": "An \"issue\" is a topic for debate and discussion or a problem to resolve. An issue cannot, by definition, do good. Try these alternatives: \"this proposal would do more good than harm\" or \"this policy would do more good than harm\"", "context": "It is without doubt that despite a few burdensome aspects, this issue would still do more good than harm.", "suggestions": [ { "value": "this proposal would do more good than harm" }, { "value": "this policy would do more good than harm" } ], "marked_text": "... despite a few burdensome aspects, this issue would still do more good than harm.", "rule_id": "wrong word in this context", "rule_sub_id": "WORD_CHOICE", "category_name": "Word choice error", "url_rule": [ { "value": "https://blog.virtualwritingtutor.com/word-choice-errors/" } ] } ], "error_dnsty": { "Article error": { "count": 3, "type": "error_density", "label": "Article error", "words": [] }, "Preposition missing error": { "count": 1, "type": "error_density", "label": "Preposition missing error", "words": [] }, "Redundant Phrase error": { "count": 1, "type": "error_density", "label": "Redundant Phrase error", "words": [] }, "Word choice error": { "count": 4, "type": "error_density", "label": "Word choice error", "words": [] }, "Adjective word order error": { "count": 2, "type": "error_density", "label": "Adjective word order error", "words": [] }, "Relative pronoun error": { "count": 1, "type": "error_density", "label": "Relative pronoun error", "words": [] }, "Word order error": { "count": 1, "type": "error_density", "label": "Word order error", "words": [] }, "Number agreement error": { "count": 1, "type": "error_density", "label": "Number agreement error", "words": [] }, "Missing word error": { "count": 1, "type": "error_density", "label": "Missing word error", "words": [] }, "Missing auxiliary error": { "count": 1, "type": "error_density", "label": "Missing auxiliary error", "words": [] }, "Verb agreement error": { "count": 2, "type": "error_density", "label": "Verb agreement error", "words": [] }, "Missing article error": { "count": 1, "type": "error_density", "label": "Missing article error", "words": [] }, "Punctuation error": { "count": 1, "type": "error_density", "label": "Punctuation error", "words": [] }, "Preposition not needed error": { "count": 1, "type": "error_density", "label": "Preposition not needed error", "words": [] }, "Article and uncountable noun error": { "count": 1, "type": "error_density", "label": "Article and uncountable noun error", "words": [] }, "Verb form error": { "count": 1, "type": "error_density", "label": "Verb form error", "words": [] }, "Commonly confused words": { "count": 1, "type": "error_density", "label": "Commonly confused words", "words": [] } } }, "feedback": { "value": 24, "msg": "You have errors in your writing. Check them and learn to avoid them in the future.", "score": 0 } }, "argumentStrength": { "value": 0.4, "msg": "It is important to maintain a neutral tone in academic writing and simply report the information without giving a strong opinion. You have done that. Good job.", "score": 9 }, "bandScore": 5.6 } }

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: