# Alibaba Cloud LingMou API

> Alibaba Cloud LingMou API on Apizie: 25 endpoints (Closes one or more sessions of a chat instance, Confirms the status of a digital human avatar, Copies a broadcast template to create a private broadcast scene, Creates a background material, …) 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-lingmou/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

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

Alibaba Cloud OpenAPI for LingMou (lingmou, version 2025-05-27). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Closes one or more sessions of a chat instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-lingmou/close-chat-instance-sessions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://lingmou.cn-beijing.aliyuncs.com |
| instanceId | string | yes | The ID of the chat instance. You can find this ID on the order page |
| sessionIds | string | no | The IDs of sessions to be closed (JSON-encoded) |

### Confirms the status of a digital human avatar
`POST https://zieapi.vercel.app/v1/cloud:aliyun-lingmou/confirm-train-pic-avatar` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://lingmou.cn-beijing.aliyuncs.com |
| avatarId | string | yes | The ID of the digital human avatar |
| status | string | yes | Specifies the confirmation status of the digital human avatar |

### Copies a broadcast template to create a private broadcast scene
`POST https://zieapi.vercel.app/v1/cloud:aliyun-lingmou/copy-broadcast-scene-from-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://lingmou.cn-beijing.aliyuncs.com |
| name | string | yes | The broadcast name |
| ratio | string | yes | The aspect ratio. Examples: 9:16 and 16:9 |
| templateId | string | yes | The template ID |

### Creates a background material
`POST https://zieapi.vercel.app/v1/cloud:aliyun-lingmou/create-background-pic` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://lingmou.cn-beijing.aliyuncs.com |
| ossKey | string | no | The key for the object in Object Storage Service (OSS) |
| filename | string | no | The filename |

### Creates broadcast audio
`POST https://zieapi.vercel.app/v1/cloud:aliyun-lingmou/create-broadcast-audio` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://lingmou.cn-beijing.aliyuncs.com |
| fileName | string | no | The file name |
| ossKey | string | no | The object key for the file in OSS |

### Create a broadcast sticker
`POST https://zieapi.vercel.app/v1/cloud:aliyun-lingmou/create-broadcast-sticker` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://lingmou.cn-beijing.aliyuncs.com |
| fileName | string | no | File name |
| ossKey | string | no | OSS file folder |

### Synthesizes a video from a broadcast template
`POST https://zieapi.vercel.app/v1/cloud:aliyun-lingmou/create-broadcast-video-from-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://lingmou.cn-beijing.aliyuncs.com |
| name | string | no | The name of the video |
| templateId | string | no | The ID of the broadcast template. Call ListBroadcastTemplates… |
| variables | array | no | A list of dynamic variables in the broadcast template. You can use these variables to replace images, text, the global digital human, the… |
| videoOptions | object | no | The video output options |

### Creates a chat configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-lingmou/create-chat-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://lingmou.cn-beijing.aliyuncs.com |
| backgroundId | string | no | The ID of the background asset. This parameter is optional if the avatar has an opaque background |
| avatarId | string | no | The avatar ID. This parameter is required |

### Create a real-time digital human session.
`POST https://zieapi.vercel.app/v1/cloud:aliyun-lingmou/create-chat-session` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://lingmou.cn-beijing.aliyuncs.com |
| id | string | yes | 即对话数字人的项目ID，通过灵眸控制台对话互动 (https://avatar.console.aliyun.com/lingmou/chat)页面点击对话项目右下角更多选项查看 |
| license | string | no | 灵眸平台颁发的个人凭证（在使用端渲染数字人的场景下必填） |
| platform | string | no | 运行SDK的平台（在使用端渲染数字人的场景下必填） |
| instanceId | string | yes | 需要在数字人实时交互服务… |
| appId | string | no | Valid appId attached to an instance of an audio-driven client-rendering type order |
| deviceId | string | no | Valid deviceId attached to an instance of an audio-driven client-rendering type order |

### Create a no-training-required photo-based digital human
`POST https://zieapi.vercel.app/v1/cloud:aliyun-lingmou/create-no-train-pic-avatar` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://lingmou.cn-beijing.aliyuncs.com |
| name | string | no | Digital human Name |
| gender | string | no | Gender |
| imageOssPath | string | no | The path of the uploaded image. This parameter is required |
| expressiveness | string | no | Expressiveness (enthusiastic/normal), which affects the degree of expressiveness of your digital human avatar |
| transparent | string | no | Background: transparent or solid color. Select transparent if you require background removal. Select solid color if you have already… |
| jwtToken | string | no | JWT containing additional login authentication information. This parameter is deprecated |
| generateAssets | string | no | Specifies whether to generate assets. If you only want to perform image availability detection without generating assets, set this… |

### Create a TTS voice
`POST https://zieapi.vercel.app/v1/cloud:aliyun-lingmou/create-ttsvoice-custom` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://lingmou.cn-beijing.aliyuncs.com |
| name | string | yes | Voice name. |
| gender | string | no | Gender (optional). FEMALE MALE |
| ossKey | string | yes | OSS file key |
| fileName | string | yes | File name |

### Create a digital human trained with an image
`POST https://zieapi.vercel.app/v1/cloud:aliyun-lingmou/create-train-pic-avatar` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://lingmou.cn-beijing.aliyuncs.com |
| name | string | yes | Name of the digital human trained with an image |
| imageOssPath | string | yes | Image path |
| gender | string | yes | Gender |
| templateId | string | no | Action template ID |
| transparent | string | no | Background: transparent or solid color |
| generateAssets | string | no | Whether to generate assets |
| bizType | string | no | Business type. (Can be empty; default value is: BROADCAST if empty.) |

### Deletes a broadcast sticker
`POST https://zieapi.vercel.app/v1/cloud:aliyun-lingmou/delete-broadcast-sticker` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://lingmou.cn-beijing.aliyuncs.com |
| stickerId | string | yes | The ID of the broadcast sticker to delete |

### Query the details of a broadcast template
`GET https://zieapi.vercel.app/v1/cloud:aliyun-lingmou/get-broadcast-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://lingmou.cn-beijing.aliyuncs.com |
| templateId | string | yes | Template ID |

### After creating a custom voice, wait at least 1 minute before checking its status
`GET https://zieapi.vercel.app/v1/cloud:aliyun-lingmou/get-ttsvoice-by-id-custom` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://lingmou.cn-beijing.aliyuncs.com |
| voiceId | string | no | The voice ID |

### Queries the training status of a photo avatar. Wait at least 20 minutes after submitting a training task…
`GET https://zieapi.vercel.app/v1/cloud:aliyun-lingmou/get-train-pic-avatar-status` (byok)

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

### Gets an upload credential for training-free dialog image assets
`GET https://zieapi.vercel.app/v1/cloud:aliyun-lingmou/get-upload-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://lingmou.cn-beijing.aliyuncs.com |
| type | string | no | The resource type. This parameter is required. Supported types: `INPUT_CHAT_BACKGROUND_PIC`: Use this type with `CreateBackgroundPic`.… |
| jwtToken | string | no | A JWT that contains additional authentication information. This parameter is deprecated |

### Retrieves a batch of broadcast audios using a list of audio IDs
`GET https://zieapi.vercel.app/v1/cloud:aliyun-lingmou/list-broadcast-audios-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://lingmou.cn-beijing.aliyuncs.com |
| audioIds | string | no | A list of audio IDs (JSON-encoded) |

### List broadcast templates
`GET https://zieapi.vercel.app/v1/cloud:aliyun-lingmou/list-broadcast-templates` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://lingmou.cn-beijing.aliyuncs.com |
| page | integer | no | The page number, starting from 1 |
| size | integer | no | Page size |
| nextToken | string | no | Paging token value. You do not need to follow this |
| maxResults | integer | no | Maximum number of return results. You do not need to follow this |

### Batch query broadcast videos by ID list
`GET https://zieapi.vercel.app/v1/cloud:aliyun-lingmou/list-broadcast-videos-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://lingmou.cn-beijing.aliyuncs.com |
| videoIds | string | no | List of video IDs (JSON-encoded) |

### View your own voice list. For newly added custom voices, we recommend that you wait at least 1 minute after…
`GET https://zieapi.vercel.app/v1/cloud:aliyun-lingmou/list-private-ttsvoices-custom` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://lingmou.cn-beijing.aliyuncs.com |
| name | string | no | Title |
| pageIndex | integer | yes | Page index |
| pageSize | integer | yes | Number of data entries per page |
| nextToken | string | no | Paging cursor |
| maxResults | integer | no | Page size. When paging, the response includes the quantity. To retrieve subsequent pages, use the same parameters as the initial page. The… |

### Lists the public broadcast scene templates
`GET https://zieapi.vercel.app/v1/cloud:aliyun-lingmou/list-public-broadcast-scene-templates` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://lingmou.cn-beijing.aliyuncs.com |
| tags | string | no | The parameter for filtering by tags |
| page | integer | no | The page number. The default value is 1 |
| size | integer | no | The page size. The default value is 20 |
| nextToken | string | no | The token that marks the start of the next page of results. To get the next page, set this parameter to the `nextToken` value from the… |
| maxResults | integer | no | The maximum number of results to return in a single call |

### Retrieves a list of template materials
`GET https://zieapi.vercel.app/v1/cloud:aliyun-lingmou/list-template-material` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://lingmou.cn-beijing.aliyuncs.com |
| page | integer | yes | The page number. Starts from 1 |
| size | integer | yes | The number of entries per page |
| maxResults | integer | no | Reserved |
| nextToken | string | no | Reserved |
| templateIds | string | no | One or more template IDs, separated by commas (,) |

### Queries the sessions of a chat instance
`GET https://zieapi.vercel.app/v1/cloud:aliyun-lingmou/query-chat-instance-sessions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://lingmou.cn-beijing.aliyuncs.com |
| instanceId | string | yes | The ID of the chat instance. You can find the instance ID on the order page |
| sessionIds | string | no | A list of session IDs (JSON-encoded) |

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

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

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:aliyun-lingmou/close-chat-instance-sessions" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

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

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

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

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