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 Dictionaries API

Custom dictionary management

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

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

This API exposes 4 operations across 4 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.

4 operations 4 paths 5 schemas 1 GET3 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 Dictionaries 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 4

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

Dictionaries 4

Custom dictionary management

POST
/custom/createdictionary
Create custom dictionary
createDictionary body → 200400
POST
/custom/updatedictionary
Update custom dictionary
updateDictionary body → 200400
GET
/custom/listdictionaries
List custom dictionaries
listDictionaries 2 params → 200400
POST
/custom/deletedictionary
Delete custom dictionary
deleteDictionary body → 200400

Schemas 5

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

DictionaryResponse
object
2 properties
DictionaryRequest
object
2 properties
DictionaryListResponse
object
2 properties
SuccessResponse
object
2 properties
ErrorResponse
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

textgears-dictionaries-api-openapi.yml Raw ↑

Other APIs TextGears publishes across the network.

TextGears Account API
TextGears Exceptions API
TextGears Grammar API
TextGears Language API
TextGears Readability API
TextGears Summarization API