Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

TextGears Exceptions API

Custom exception (whitelist) management

TextGears Exceptions API is one of 7 APIs that TextGears publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Exceptions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and rate-limit docs.

This API exposes 3 operations across 3 paths, and defines 5 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.

3 operations 3 paths 5 schemas 1 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://api.textgears.com
Authentication
API Key, HTTP Basic
License
Terms of Service
Resource Areas
1

Authentication & Security 2

TextGears Exceptions 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 parameter
  • apiKeyHeader — API key passed as HTTP Basic Authorization header value

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 1 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Exceptions 3

Custom exception (whitelist) management

POST
/custom/addexception
Add dictionary exception
addException body → 200400
GET
/custom/listexceptions
List dictionary exceptions
listExceptions 6 params → 200400
POST
/custom/deleteexception
Delete dictionary exception
deleteException body → 200400

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are ExceptionRequest (6 properties), ErrorResponse (3 properties), SuccessResponse (2 properties), ExceptionListResponse (2 properties). Each schema is shown below with its type and property counts.

ExceptionResponse
object
2 properties
ExceptionListResponse
object
2 properties
SuccessResponse
object
2 properties
ErrorResponse
object
3 properties
ExceptionRequest
object
6 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

textgears-exceptions-api-openapi.yml Raw ↑

Other APIs TextGears publishes across the network.

TextGears Account API
TextGears Dictionaries API
TextGears Grammar API
TextGears Language API
TextGears Readability API
TextGears Summarization API