Skip to main content
POST
text.readability.check

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
text
string
required

Exact submitted text, including whitespace; at most 5000 Unicode code points. May contain personal data.

Required string length: 1 - 5000

Response

The result

scores
object
required

Eleven named readability metrics on their own scales.

statistics
object
required

Reported text counts and syllable statistics; time units are unspecified and omitted.

sentences
object[]
required

Up to 100 flagged sentences.

Maximum array length: 100
truncated
boolean
required

Some sentence details or text were cut.