# Alibaba Cloud Tingwu API

> Alibaba Cloud Tingwu API on Apizie: 8 endpoints (Creates a Tingwu task, including an offline transcription task or a real-time meeting task, Creates a custom vocabulary of transcription phrases, Deletes a vocabulary, Query the job status and job result., …) 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-tingwu/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

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

Alibaba Cloud OpenAPI for Tingwu (tingwu, version 2023-09-30). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Creates a Tingwu task, including an offline transcription task or a real-time meeting task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-tingwu/create-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://tingwu.cn-beijing.aliyuncs.com |
| type | string | yes | The task type. Valid values: offline: indicates an offline task, such as offline transcription. realtime: indicates a real-time task, such… |
| operation | string | no | The operation to perform. Valid values: start: creates the task. This is the default value. In most cases, you do not need to explicitly… |
| AppKey | string | no | The AppKey of the project created in the console |
| Input | object | no | The basic information parameters configured when you create a task. Note that the required parameters vary based on the task type. When… |
| Parameters | object | no | The algorithm-related parameters set when creating a task. You can set them as needed |

### Creates a custom vocabulary of transcription phrases
`POST https://zieapi.vercel.app/v1/cloud:aliyun-tingwu/create-transcription-phrases` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://tingwu.cn-beijing.aliyuncs.com |
| Description | string | no | The description of the phrases list |
| Name | string | yes | The name of the phrases list |
| WordWeights | string | yes | A JSON-formatted string that represents a map of words and their corresponding weights |

### Deletes a vocabulary
`POST https://zieapi.vercel.app/v1/cloud:aliyun-tingwu/delete-transcription-phrases` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://tingwu.cn-beijing.aliyuncs.com |
| PhraseId | string | yes | The vocabulary ID |

### Query the job status and job result.
`GET https://zieapi.vercel.app/v1/cloud:aliyun-tingwu/get-task-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://tingwu.cn-beijing.aliyuncs.com |
| TaskId | string | yes | The TaskId returned when the job was created |

### Queries information about hotword lists
`GET https://zieapi.vercel.app/v1/cloud:aliyun-tingwu/get-transcription-phrases` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://tingwu.cn-beijing.aliyuncs.com |
| PhraseId | string | yes | Hotword list ID |

### Lists all of a user's hot phrase lists
`GET https://zieapi.vercel.app/v1/cloud:aliyun-tingwu/list-transcription-phrases` (byok)

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

### Update a hotword list
`POST https://zieapi.vercel.app/v1/cloud:aliyun-tingwu/update-transcription-phrases` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://tingwu.cn-beijing.aliyuncs.com |
| PhraseId | string | yes | The ID of the hotword list |
| Description | string | no | A description of the hotword list |
| Name | string | yes | The name of the hotword list |
| WordWeights | string | yes | A JSON map string that defines hotwords and their weights |

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

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

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

## FAQ

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

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

### Can AI agents use the Alibaba Cloud Tingwu 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-tingwu.

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