Writing Assistant Object
The Writing Assistant object provides a comprehensive analysis of a submitted text, including scores, readability metrics, and detailed corrections.
score object
An object containing the overall score, readability, and text statistics.
readability object
Readability score for the submitted text. Score ranges between 0 to 100. Higher score means the text is more readable.
The estimated readability level of the submitted text.
Available values:
- 1 - Text is readable for 5th grader
- 2 - Text is readable for 6th grader
- 3 - Text is readable for 7th grader
- 4 - Text is readable for 8th-9th grader
- 5 - Text is readable for 10th-12th grader
- 6 - Text is readable for college student
- 7 - Text is readable for college graduate
- 8 - Text is readable for professional
Text corresponding to the estimated readability level. For example: “7th Grader”.
Description corresponding to the estimated readability level. For example: “Very easy to read”.
statistics object
Number of sentences in the submitted text.
Average number of words in a sentence.
Average number of characters in a word.
Estimated reading time of the submitted text.
Estimated speaking time of the submitted text.
corrections object
Total number of grammar corrections.
Overall grammar score.
Grammar category weight in the overall score. This value is configurable upon submission.
Total number of mechanics corrections.
Overall mechanics score.
Mechanics category weight in the overall score. This value is configurable upon submission.
Total number of sentence structure corrections.
Overall sentence structure score.
Sentence structure category weight in the overall score. This value is configurable upon submission.
Total number of word choice corrections.
Overall word choice score.
Word choice category weight in the overall score. This value is configurable upon submission.
Overall writing score. The score is calculated as a weighted average of the correction categories above. Weight for each category is configurable upon submission.
corrections object
An object containing the detailed corrections for the text.
text object
Corrections to be applied on the textual version. Each position in the inner arrays corresponds to a single correction to be applied to the textual version. If you use the submit endpoint, the textual version can be retrieved by using the Export endpoint and exporting the crawled version.
chars object
The character positions of the corrections for the textual version. All nested arrays have the same length and each coordinate corresponds to one correction.
The classification of this correction. For example: 12 is Capitalization Error. For a full list of correction types refer to Correction Types documentation.
Starting character position of the suggested text to be corrected in the textual version.
Length in characters of the suggested text to be corrected in the textual version.
The recommended text to substitute into the textual version.
scannedDocument object
Metadata about the scan.
The unique scan id provided by you.
Unsigned Integer
Total number of words found in the scanned text.
Unsigned Integer
Number of excluded words in the submitted content.
Overall credits used for the scan.
The creation time of the scan.
Timezone: UTC+0
metadata object
The submitted url after all http redirects.
Extracted canonical url from the scanned document.
Publication date of the scanned document.
Creation date of the scanned document.
Last modification date of the scanned document.
Scanned document author.
Scanned document organization.
Scanned document filename.
Example
Section titled “Example”{ "score": { "corrections": { "grammarCorrectionsCount": 2, "grammarCorrectionsScore": 87, "grammarScoreWeight": 1.0, "mechanicsCorrectionsCount": 9, "mechanicsCorrectionsScore": 38, "mechanicsScoreWeight": 1.0, "sentenceStructureCorrectionsCount": 0, "sentenceStructureCorrectionsScore": 100, "sentenceStructureScoreWeight": 1.0, "wordChoiceCorrectionsCount": 1, "wordChoiceCorrectionsScore": 93, "wordChoiceScoreWeight": 1.0, "overallScore": 79 }, "readability": { "score": 59, "readabilityLevel": 5, "readabilityLevelText": "10th to 12th Grader", "readabilityLevelDescription": "Fairly difficult to read" }, "statistics": { "sentenceCount": 5, "averageSentenceLength": 12.2, "averageWordLength": 5.5, "readingTimeSeconds": 16.0, "speakingTimeSeconds": 28.2 } }, "corrections": { "text": { "chars": { "types": [ 5, 18, 3, 18, 18, 18, 18, 10, 18, 16, 18, 18 ], "starts": [ 13, 22, 61, 104, 118, 136, 179, 233, 288, 347, 353, 374 ], "lengths": [ 2, 10, 9, 6, 8, 35, 13, 9, 12, 4, 8, 11 ], "operationTexts": [ "an ", "plagiarism ", "businesses ", "their ", "original.", "texts from the internet and data bases ", "similarities.", "multilingual ", "positives, ", "it's ", "useful ", "maintaining " ] } } }, "scannedDocument": { "scanId": "{scanId}", "totalWords": 61, "totalExcluded": 0, "actualCredits": 1, "expectedCredits": 1, "creationTime": "2025-08-11T06:46:01.2886658Z" }}