Method: POST
Content Type: application/json
Request Body
Attribute | Type | Mandatory | Description |
---|
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"). |
language | String | No | Language of the input text. Supported values: 'english' (default) or 'german'. This determines which readability metrics will be calculated - Flesch-Kincaid for English or Wiener Sachtextformel for German. |
Response (When language=english)
Attribute | Type | Description |
---|
data.flesh_kincaid_reading_ease.score | Number | 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. |
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 true else false . |
data.flesh_kincaid_reading_ease.class | String | Describes the readability class or category, such as College for complex texts, the Flesh Kincaid Reading Ease Table contains all possible values. |
data.flesh_kincaid_reading_ease.class_label | String | Provides a descriptive label for the readability class,the Flesh Kincaid Reading Ease Table contains all possible values like Difficult to read . |
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
Score | Class | Class Label |
---|
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. |
Sample Response (When language=english)
Response (When language=german)
Attribute | Type | Description |
---|
data.wiener_sachtextformel.score | Number | The Wiener Sachtextformel score, typically ranging from 4 to 15. |
data.wiener_sachtextformel.level | Number | Approximate grade level (score divided by 4). |
data.wiener_sachtextformel.label | Boolean | True if complex (score > 8), False if simple. |
data.wiener_sachtextformel.class | String | Readability class based on score ranges. |
data.wiener_sachtextformel.class_label | String | Descriptive label of the readability level. |
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 to read the text. |
data.stats.speaking_time | Number | The estimated time in seconds to speak the text. |
data.stats.avg_word_length | Number | Average length of words in characters. |
data.stats.avg_sentence_length | Number | Average length of sentences in words. |
data.stats.avg_paragraph_length | Number | Average length of paragraphs in sentences. |
Wiener Sachtextformel Score Table
Score Range | Class | Class Label |
---|
< 4.5 | 4th grade | Very Easy (4th grade). |
4.5 - 7.4 | 5th-6th grade | Easy (5th-6th grade). |
7.5 - 9.4 | 7th-8th grade | Moderate (7th-8th grade). |
9.5 - 11.4 | 9th-10th grade | Difficult (9th-10th grade). |
≥ 11.5 | 11th grade+ | Very Difficult (11th grade+). |
Sample Response (When language=german)
HTTP Response Codes
The method may return one of the following HTTP status codes:
Status Code | Description |
---|
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. |