This Utility API calculates the readability score of pdf and document files. A readability score is a number that tells you how easy it will be for someone to read a particular piece of text.
The ApyHub readability assessment API simplifies text evaluation with features like comprehensive readability scores, grade level insights for precise audience targeting, and additional metrics for linguistic complexity. Troubleshooting is made efficient through clear error codes and messages in the API response.
This Utility API is ideal for different use cases:. Content creators can tailor marketing content and materials for optimal audience comprehension. Educators can benefit from this Utility API by aligning educational materials with students' cognitive abilities, fostering engaging learning experiences. Researchers can also find value in improving the accessibility of research papers, ensuring complex findings are understandable to a diverse readership.
Extract Readability Score from File
|The source pdf or document file should be in
.docx format for which you want to calculate the readability score metics.
|The Flesch Reading Ease score ranges from 1 to 100, The
Flesh Kincaid Reading Ease Table is an example of values. While the maximum score is 121.22, there is no limit on how low the score can be. A negative score is valid.
|The Flesch-Kincaid Grade of the given text.
|If the Flesch Reading Ease score is greater then 70 it is
|Describes the readability class or category, such as
College for complex texts, the
Flesh Kincaid Reading Ease Table contains all possible values.
|Provides a descriptive label for the readability class,the
Flesh Kincaid Reading Ease Table contains all possible values like
Difficult to read.
|The total number of paragraphs in the text.
|The total count of sentences in the text.
|The total number of words in the text.
|The total character count in the text.
|The estimated time in seconds it would take to read the entire text.
|The estimated time in seconds it would take to verbally speak or present the text.
|Average length of words in the text (measured in characters).
|Average length of sentences in the text (typically measured in words).
|Average length of paragraphs in the text (often measured in sentences or words).
Flesh Kincaid Reading Ease Table
|Greater than 90
|Very easy to read. Easily understood by an average 11-year-old student.
|Easy to read. Conversational English for consumers.
|Fairly easy to read.
|8th & 9th grade
|Plain English. Easily understood by 13- to 15-year-old students.
|10th to 12th grade
|Fairly difficult to read.
|Difficult to read.
|Very difficult to read. Best understood by university graduates.
|Less than 10.0
|Extremely difficult to read. Best understood by university graduates.
HTTP Response Codes
The method may return one of the following HTTP status codes:
|The request was successful.
|Required authentication information is either missing or not valid for the resource.
|Invalid input - the image urls are corrupt or not accessible.
|If any unexpected error occurs while processing the request.
All requests to ApyHub services need to be authenticated, currently we support
basic authentication mechanisms.
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.