This API calculates the readability score of text, providing insights into their ease of comprehension.
It's a valuable tool for assessing the readability of text, making it useful for content creators, educators, and researchers. Whether you're working on educational materials, marketing content, or research papers, this API helps you gauge how accessible your text is to different audiences.
A successful request returns the readability score, grade level, and other relevant metrics. In case of an issue, the response includes an error code and a message to assist in troubleshooting
Extract Readability Score
|text||String||Yes||The text or content for which you want to calculate the readability score metics to give text in multiple paragraph add new-lines ("\n\n")|
|data.flesh_kincaid_reading_ease.score||Number||The Flesch Reading Ease score ranges from 1 to 100, The |
|data.flesh_kincaid_reading_ease.level||Number||The Flesch-Kincaid Grade of the given text.|
|data.flesh_kincaid_reading_ease.label||Boolean||If the Flesch Reading Ease score is greater then 70 it is |
|data.flesh_kincaid_reading_ease.class||String||Describes the readability class or category, such as |
|data.flesh_kincaid_reading_ease.class_label||String||Provides a descriptive label for the readability class,the |
|data.stats.paragraphs||Number||The total number of paragraphs in the text.|
|data.stats.sentences||Number||The total count of sentences in the text.|
|data.stats.words||Number||The total number of words in the text.|
|data.stats.characters||Number||The total character count in the text.|
|data.stats.reading_time||Number||The estimated time in seconds it would take to read the entire text.|
|data.stats.speaking_time||Number||The estimated time in seconds it would take to verbally speak or present the text.|
|data.stats.avg_word_length||Number||Average length of words in the text (measured in characters).|
|data.stats.avg_sentence_length||Number||Average length of sentences in the text (typically measured in words).|
|data.stats.avg_paragraph_length||Number||Average length of paragraphs in the text (often measured in sentences or words).|
Flesh Kincaid Reading Ease Table
|Greater than 90||5th grade||Very easy to read. Easily understood by an average 11-year-old student.|
|90.0–80.0||6th grade||Easy to read. Conversational English for consumers.|
|80.0–70.0||7th grade||Fairly easy to read.|
|70.0–60.0||8th & 9th grade||Plain English. Easily understood by 13- to 15-year-old students.|
|60.0–50.0||10th to 12th grade||Fairly difficult to read.|
|50.0–30.0||College||Difficult to read.|
|30.0–10.0||College graduate||Very difficult to read. Best understood by university graduates.|
|Less than 10.0||Professional||Extremely difficult to read. Best understood by university graduates.|
HTTP Response Codes
The method may return one of the following HTTP status codes:
|200||The request was successful.|
|401||Required authentication information is either missing or not valid for the resource.|
|400||Invalid input - the image urls are corrupt or not accessible.|
|500||If any unexpected error occurs while processing the request.|
All requests to ApyHub services need to be authenticated, currently we support
basic authenticationmechanisms. You can generate and view your existing credentials from workspace settings (on the left side of the navbar) and go to applications.
Points to note:
- Credential secrets are generated on the fly and are not stored in plain text, so on generating a credential please save the secrets somewhere safe.
- Use the
apy-tokenas the header parameter to pass the token.
- Use the
Authorizationheader to send the basic authentication credentials.
To search for a specific error code, enter the code in the search box below. Alternatively, you can click on the button to view a complete list of all error codes.