General API: Reference
The General API (G3) is a general-purpose Natural Language Understanding (NLU) API. It provides a wide range of linguistic analyses, from basic language detection to complex relation extraction and semantic tagging.
Authorization
All requests to the General API must include a valid API key. You can provide the key either as a user_key request parameter or via the Authorization header:
Authorization: user_key <YOUR_API_KEY>
Functions
The table below summarizes the available endpoints in the General API. These endpoints allow you to perform various analyses on individual documents or batches of text.
| Endpoint | Description | ||
|---|---|---|---|
| Request | 200 Response | ||
| Account: Information about your subscription | |||
GET /account | Returns information about the current user account, including the plan type, used quotas, and billing period. | ||
| — | AccountInfo | ||
| Analysis: General NLU processing | |||
POST /v3/analysis | The primary endpoint for NLU. Performs one or more requested analyses (entities, tags, sentiment, etc.) on the input text. | ||
| Request | Response | ||
GET /v3/analysis | A simplified GET version of the analysis endpoint where text and parameters are passed as query arguments. | ||
| query parameters | Response | ||
POST /v3/analysis/batch | Submits a list of documents for analysis in a single request. | ||
| BatchRequest | List[Response] | ||
| Specialized Analyses: Shortcut endpoints | |||
POST /v3/entities | Shortcut endpoint specifically for named and general entity recognition. | ||
| Request | Response | ||
POST /v3/tags | Shortcut endpoint specifically for semantic tagging and categorization. | ||
| Request | Response | ||
POST /v3/sentiment | Shortcut endpoint specifically for document and item-level sentiment analysis. | ||
| Request | Response | ||
POST /v3/language | Shortcut endpoint specifically for language detection. | ||
| Request | Response | ||
POST /v3/relations | Shortcut endpoint specifically for relation and dependency analysis. | ||
| Request | Response | ||
POST /v3/correction | Performs spelling and diacritics correction on the input text. | ||
| Request | Response | ||
For full technical details, including interactive examples and schema definitions, please refer to the Swagger Documentation.