# Text Analytics Client API

> Text Analytics Client API on Apizie: 11 endpoints (Submit analysis job, Get analysis status and results, Get healthcare analysis job status and results, Cancel healthcare prediction job, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/cloud:azure-cognitiveservices-text-analytics/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:azure-cognitiveservices-text-analytics`
- Category: Cloud
- Status: byok
- Source: https://learn.microsoft.com/rest/api/azure/
- Page: https://apizie.tech/api/cloud/azure-cognitiveservices-text-analytics
- OpenAPI: https://apizie.tech/api/cloud/azure-cognitiveservices-text-analytics/openapi.json

The Text Analytics API is a suite of natural language processing (NLP) services built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as…

## Endpoints

### Submit analysis job
`POST https://apizie.tech/v1/cloud:azure-cognitiveservices-text-analytics/analyze` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com). |
| ApiVersion | string | yes | Text Analytics API version (for example, v3.0). |
| body | object | no | JSON request body |

### Get analysis status and results
`GET https://apizie.tech/v1/cloud:azure-cognitiveservices-text-analytics/analyze-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com). |
| ApiVersion | string | yes | Text Analytics API version (for example, v3.0). |
| jobId | string | yes | Job ID for Analyze |
| showStats | boolean | no | (Optional) if set to true, response will contain request and document level statistics. |
| $top | integer | no | (Optional) Set the maximum number of results per task. When both $top and $skip are specified, $skip is applied first. |
| $skip | integer | no | (Optional) Set the number of elements to offset in the response. When both $top and $skip are specified, $skip is applied first. |

### Get healthcare analysis job status and results
`GET https://apizie.tech/v1/cloud:azure-cognitiveservices-text-analytics/health-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com). |
| ApiVersion | string | yes | Text Analytics API version (for example, v3.0). |
| jobId | string | yes | Job ID |
| $top | integer | no | (Optional) Set the maximum number of results per task. When both $top and $skip are specified, $skip is applied first. |
| $skip | integer | no | (Optional) Set the number of elements to offset in the response. When both $top and $skip are specified, $skip is applied first. |
| showStats | boolean | no | (Optional) if set to true, response will contain request and document level statistics. |

### Cancel healthcare prediction job
`POST https://apizie.tech/v1/cloud:azure-cognitiveservices-text-analytics/cancel-health-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com). |
| ApiVersion | string | yes | Text Analytics API version (for example, v3.0). |
| jobId | string | yes | Job ID |

### Submit healthcare analysis job
`POST https://apizie.tech/v1/cloud:azure-cognitiveservices-text-analytics/health` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com). |
| ApiVersion | string | yes | Text Analytics API version (for example, v3.0). |
| model-version | string | no | (Optional) This value indicates which model will be used for scoring. If a model-version is not specified, the API should default to the… |
| stringIndexType | string | no | (Optional) Specifies the method used to interpret string offsets. Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For… |
| loggingOptOut | boolean | no | (Optional) If set to true, you opt-out of having your text input logged for troubleshooting. By default, Text Analytics logs your input… |
| body | object | yes | JSON request body |

### Named Entity Recognition
`POST https://apizie.tech/v1/cloud:azure-cognitiveservices-text-analytics/entities-recognition-general` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com). |
| ApiVersion | string | yes | Text Analytics API version (for example, v3.0). |
| model-version | string | no | (Optional) This value indicates which model will be used for scoring. If a model-version is not specified, the API should default to the… |
| showStats | boolean | no | (Optional) if set to true, response will contain request and document level statistics. |
| loggingOptOut | boolean | no | (Optional) If set to true, you opt-out of having your text input logged for troubleshooting. By default, Text Analytics logs your input… |
| stringIndexType | string | no | (Optional) Specifies the method used to interpret string offsets. Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For… |
| body | object | yes | JSON request body |

### Entities containing personal information
`POST https://apizie.tech/v1/cloud:azure-cognitiveservices-text-analytics/entities-recognition-pii` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com). |
| ApiVersion | string | yes | Text Analytics API version (for example, v3.0). |
| model-version | string | no | (Optional) This value indicates which model will be used for scoring. If a model-version is not specified, the API should default to the… |
| showStats | boolean | no | (Optional) if set to true, response will contain request and document level statistics. |
| loggingOptOut | boolean | no | (Optional) If set to true, you opt-out of having your text input logged for troubleshooting. By default, Text Analytics logs your input… |
| domain | string | no | (Optional) if specified, will set the PII domain to include only a subset of the entity categories. Possible values include: 'PHI', 'none'. |
| stringIndexType | string | no | (Optional) Specifies the method used to interpret string offsets. Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For… |
| piiCategories | array | no | (Optional) describes the PII categories to return |
| body | object | yes | JSON request body |

### Linked entities from a well known knowledge base
`POST https://apizie.tech/v1/cloud:azure-cognitiveservices-text-analytics/entities-linking` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com). |
| ApiVersion | string | yes | Text Analytics API version (for example, v3.0). |
| model-version | string | no | (Optional) This value indicates which model will be used for scoring. If a model-version is not specified, the API should default to the… |
| showStats | boolean | no | (Optional) if set to true, response will contain request and document level statistics. |
| loggingOptOut | boolean | no | (Optional) If set to true, you opt-out of having your text input logged for troubleshooting. By default, Text Analytics logs your input… |
| stringIndexType | string | no | (Optional) Specifies the method used to interpret string offsets. Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For… |
| body | object | yes | JSON request body |

### Key Phrases
`POST https://apizie.tech/v1/cloud:azure-cognitiveservices-text-analytics/key-phrases` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com). |
| ApiVersion | string | yes | Text Analytics API version (for example, v3.0). |
| model-version | string | no | (Optional) This value indicates which model will be used for scoring. If a model-version is not specified, the API should default to the… |
| showStats | boolean | no | (Optional) if set to true, response will contain request and document level statistics. |
| loggingOptOut | boolean | no | (Optional) If set to true, you opt-out of having your text input logged for troubleshooting. By default, Text Analytics logs your input… |
| body | object | yes | JSON request body |

### Detect Language
`POST https://apizie.tech/v1/cloud:azure-cognitiveservices-text-analytics/languages` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com). |
| ApiVersion | string | yes | Text Analytics API version (for example, v3.0). |
| model-version | string | no | (Optional) This value indicates which model will be used for scoring. If a model-version is not specified, the API should default to the… |
| showStats | boolean | no | (Optional) if set to true, response will contain request and document level statistics. |
| loggingOptOut | boolean | no | (Optional) If set to true, you opt-out of having your text input logged for troubleshooting. By default, Text Analytics logs your input… |
| body | object | yes | JSON request body |

### Sentiment
`POST https://apizie.tech/v1/cloud:azure-cognitiveservices-text-analytics/sentiment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com). |
| ApiVersion | string | yes | Text Analytics API version (for example, v3.0). |
| model-version | string | no | (Optional) This value indicates which model will be used for scoring. If a model-version is not specified, the API should default to the… |
| showStats | boolean | no | (Optional) if set to true, response will contain request and document level statistics. |
| loggingOptOut | boolean | no | (Optional) If set to true, you opt-out of having your text input logged for troubleshooting. By default, Text Analytics logs your input… |
| opinionMining | boolean | no | (Optional) if set to true, response will contain not only sentiment prediction but also opinion mining (aspect-based sentiment analysis)… |
| stringIndexType | string | no | (Optional) Specifies the method used to interpret string offsets. Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For… |
| body | object | yes | JSON request body |

## Example
```
curl "https://apizie.tech/v1/cloud:azure-cognitiveservices-text-analytics/analyze" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Text Analytics Client API?
Create a free Apizie key, then send POST https://apizie.tech/v1/cloud:azure-cognitiveservices-text-analytics/analyze with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Text Analytics Client API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Text Analytics Client itself also needs your own key from azure.com.

### Can AI agents use the Text Analytics Client API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:azure-cognitiveservices-text-analytics.

### What is the status of the Text Analytics Client API?
Needs your own provider key (bring your own key)