# Alibaba Cloud Natural Language Processing API

> Alibaba Cloud Natural Language Processing API on Apizie: 5 endpoints (Creates an asynchronous prediction by calling CreateAsyncPredict, Calls GetAsyncPredict to retrieve asynchronous prediction results, Retrieves the prediction results of a model, Calls a pre-trained model service, …) 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://zieapi.vercel.app/v1/cloud:aliyun-nlp-automl/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-nlp-automl`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/nlp-automl
- Page: https://zieapi.vercel.app/api/cloud/aliyun-nlp-automl
- OpenAPI: https://zieapi.vercel.app/api/cloud/aliyun-nlp-automl/openapi.json

Alibaba Cloud OpenAPI for Natural Language Processing (nlp-automl, version 2019-11-11). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Creates an asynchronous prediction by calling CreateAsyncPredict
`POST https://zieapi.vercel.app/v1/cloud:aliyun-nlp-automl/create-async-predict` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nlp-automl.cn-hangzhou.aliyuncs.com |
| ModelId | integer | no | The model ID. Not required when creating an asynchronous prediction by service name and service version. Required otherwise |
| Content | string | no | The prediction content. Maximum length: 1024 bytes |
| ModelVersion | string | no | The version number of the model. If this parameter is not specified, the latest published version is returned. Specify this parameter when… |
| DetailTag | string | no | Specifies whether to return detailed extraction results for text entity extraction models. Valid values: true and false |
| TopK | integer | no | The number of top results to return |
| FileType | string | no | The file type |
| FileUrl | string | no | The HTTP URL where the file is stored |
| FileContent | string | no | The Base64-encoded file content |
| FetchContent | string | no | The prediction text to return |
| ServiceName | string | no | The service name |
| ServiceVersion | string | no | The service version |

### Calls GetAsyncPredict to retrieve asynchronous prediction results
`POST https://zieapi.vercel.app/v1/cloud:aliyun-nlp-automl/get-async-predict` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nlp-automl.cn-hangzhou.aliyuncs.com |
| AsyncPredictId | integer | yes | The asynchronous prediction ID. You can obtain this ID by calling the CreateAsyncPredict operation |

### Retrieves the prediction results of a model
`POST https://zieapi.vercel.app/v1/cloud:aliyun-nlp-automl/get-predict-result` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nlp-automl.cn-hangzhou.aliyuncs.com |
| ModelId | integer | yes | The model ID |
| Content | string | yes | The prediction result, in JSON string format |
| ModelVersion | string | no | The model version |
| DetailTag | string | no | The label type |
| TopK | integer | no | 0 indicates that the prediction has not started. 1 indicates that the prediction has started |

### Calls a pre-trained model service
`POST https://zieapi.vercel.app/v1/cloud:aliyun-nlp-automl/run-pre-train-service` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nlp-automl.cn-hangzhou.aliyuncs.com |
| ServiceName | string | yes | The service name |
| ServiceVersion | string | no | The service version |
| PredictContent | string | yes | The prediction input |

### version
`POST https://zieapi.vercel.app/v1/cloud:aliyun-nlp-automl/version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nlp-automl.cn-hangzhou.aliyuncs.com |

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:aliyun-nlp-automl/create-async-predict" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud Natural Language Processing API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:aliyun-nlp-automl/create-async-predict with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud Natural Language Processing API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud Natural Language Processing itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud Natural Language Processing API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-nlp-automl.

### What is the status of the Alibaba Cloud Natural Language Processing API?
Needs your own provider key (bring your own key)