TextGears Readability API
Text readability scoring and analysis
TextGears Readability API is one of 7 APIs that TextGears publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Readability. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and rate-limit docs.
This API exposes 2 operations across 2 paths, and defines 6 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.
Requests are made against 4 base URLs: https://api.textgears.com, https://eu.api.textgears.com, https://us.api.textgears.com, https://sg.api.textgears.com.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
TextGears Readability API declares
2 security schemes
for authenticating requests.
An API key is passed in the query as key (apiKeyQuery).
It accepts HTTP basic authentication (apiKeyHeader).
By default, every request must be authenticated.
apiKeyQuery— API key passed as a query parameterapiKeyHeader— API key passed as HTTP Basic Authorization header value
Paths & Operations 2
Across 2 paths, the API surfaces 2 operations — 2 POST. Each is listed below with its method, path, parameters, and response codes.
Text readability scoring and analysis
Schemas 6
The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are GrammarError (7 properties), BaseRequest (6 properties), ErrorResponse (3 properties), ReadabilityResponse (2 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from TextGears 6
Other APIs TextGears publishes across the network.