# Alibaba Cloud Beebot API

> Alibaba Cloud Beebot API on Apizie: 97 endpoints (Retrieves the connection information for streaming calls, Suggests FAQs from the knowledge base based on a user query, Retrieves the welcome message, Cancels or interrupts a specified conversation, …) 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-chatbot/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

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

Alibaba Cloud OpenAPI for Beebot (chatbot, version 2022-04-08). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Retrieves the connection information for streaming calls
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/apply-for-stream-access-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| AgentKey | string | no | The key of the business space. If this parameter is not set, the default business space is accessed. You can obtain the key value on the… |

### Suggests FAQs from the knowledge base based on a user query
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/associate` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | no | The unique identifier of the robot |
| Utterance | string | no | The user utterance |
| Perspective | string | no | The perspective code, which is used to call answers from different perspectives under the same knowledge title. When assembling request… |
| SessionId | string | no | The session ID, which is used to identify a visitor's session and maintain context information. For a new visitor, you do not need to pass… |
| RecommendNum | integer | no | The number of recommended questions, ranging from 1 to 10. This parameter takes effect only when recommendations are returned. The number… |
| AgentKey | string | no | The business space key. If not specified, the default business space is accessed. Obtain the key value from the business management page… |

### Retrieves the welcome message
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/begin-session` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| AgentKey | string | no | The key of the workspace. If this parameter is not set, the default workspace is accessed. You can obtain the key on the business… |
| InstanceId | string | no | The InstanceId |
| SandBox | string | no | The SandBox |
| VendorParam | string | no | The VendorParam |
| SessionId | string | no | The SessionId |

### Cancels or interrupts a specified conversation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/cancel-chat` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| AgentKey | string | no | The business space key. If this parameter is not specified, the default business space is accessed. You can obtain the key value on the… |
| SessionId | string | no | The session ID, which is used to identify a visitor's session and maintain context information. For a new visitor, you do not need to… |
| ChatId | string | no | The ID that identifies a single conversation |
| InstanceId | string | no | The chatbot ID |
| Type | string | no | The interruption type |
| Answer | string | no | The answer content |

### Cancels a chatbot publish task during the publishing process
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/cancel-instance-publish-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | no | The unique identifier of the chatbot |
| Id | integer | no | The task ID |
| AgentKey | string | no | The key of the business space. If not specified, the default business space is accessed. You can obtain the key on the business management… |

### Cancels a publish task that is in progress
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/cancel-publish-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| Id | integer | no | The publish task ID |
| AgentKey | string | no | The business space key. If not specified, the default business space is accessed. You can obtain the key value from the business… |

### Initiates a conversation with a chatbot by using the unique chatbot identifier (chatbot ID). This operation…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/chat` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | no | The unique chatbot identifier (chatbot ID). Log on to the Chatbot console and navigate to Chatbot Details > Session Interface to view the… |
| Utterance | string | no | The input from the chatbot visitor |
| SessionId | string | no | The session ID, which identifies a visitor's session and maintains context information. For a new visitor, you do not need to pass this… |
| KnowledgeId | string | no | The ID of a knowledge title in the knowledge base. If this ID is specified, the chatbot directly returns the answer for the specified… |
| SenderId | string | no | The visitor ID, which identifies the user in the current session |
| SenderNick | string | no | The nickname of the visitor in the current session |
| IntentName | string | no | The intent name in the dialog flow. If this name is specified, the chatbot directly enters this intent for Q&A |
| Perspective | string | no | The array of perspective codes, which is used to call answers from different perspectives under the same knowledge title. Example:… |
| VendorParam | string | no | A JSON-formatted set of user-defined parameters that can be passed to various dialog engines |
| SandBox | string | no | Specifies whether to use the test or production environment. Default value: false (production environment). Valid values: true: Test… |
| AgentKey | string | no | The business space key. If this parameter is not specified, the default business space is accessed. Obtain the key value from the business… |

### Ignores alerts and continues publishing when the chatbot triggers a publish alert
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/continue-instance-publish-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | no | The unique identifier of the chatbot |
| Id | integer | no | The task ID |
| AgentKey | string | no | The key of the business space. If this parameter is not specified, the default business space is accessed. You can obtain the key on the… |

### Creates a category
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/create-category` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| Name | string | yes | The category name |
| BizCode | string | no | The business code |
| KnowledgeType | integer | no | The knowledge type. Valid values: 1: FAQ category. 3: Document category. Default value: 1 |
| ParentCategoryId | integer | no | The parent category ID. Default value: -1, which indicates the root directory |
| AgentKey | string | no | The business space key. If this parameter is not specified, the default business space is accessed. You can obtain the key value from the… |

### Adds associated knowledge to a knowledge entry
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/create-conn-question` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| ConnQuestionId | integer | yes | The ID of the associated knowledge |
| KnowledgeId | integer | yes | The knowledge ID |
| AgentKey | string | no | The key of the business space. If this parameter is not specified, the default business space is accessed. You can obtain the key on the… |

### Creates an entity, specifically the meta information of the entity, such as the entity name and entity type
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/create-dsentity` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| AgentKey | string | no | The business space key. If this parameter is not set, the default business space is accessed. You can obtain the key value on the business… |
| InstanceId | string | yes | The chatbot ID |
| EntityName | string | yes | The entity name. Only Chinese characters, uppercase and lowercase letters, digits, and underscores are supported |
| EntityType | string | no | The entity type. Valid values: synonyms: synonym. regex: regular expression |

### Adds entity member information for a specified entity, including the entity value and the corresponding…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/create-dsentity-value` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| AgentKey | string | no | The key of the workspace. If this parameter is not specified, the default workspace is accessed. You can obtain the key value on the… |
| InstanceId | string | yes | The chatbot ID |
| EntityId | integer | yes | The entity ID. This parameter can be left empty when you modify an entity member |
| Content | string | yes | The entity value or regular expression |
| Synonyms | string | no | The synonym list (JSON-encoded) |

### Creates a document
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/create-doc` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| AgentKey | string | no | The business space key. If this parameter is not specified, the default business space is accessed. You can obtain the key value on the… |
| CategoryId | integer | yes | The document category ID |
| Title | string | yes | The document title |
| Content | string | no | The document content. Specify either this parameter or URL |
| Config | string | no | The document parsing and chunking configuration. Configuration item: Splitter KEY: Splitter Valid values: ParagraphSplitter:… |
| Meta | string | no | The document metadata |
| StartDate | string | no | The effective start time in UTC |
| EndDate | string | no | The effective end time in UTC |
| Url | string | no | The URL of the document. Specify either this parameter or Content. Supported formats: txt, pdf, markdown, doc, and docx. Limits for a… |
| TagIds | string | no | The list of tag IDs (JSON-encoded) |
| DocMetadata | string | no | The DocMetadata (JSON-encoded) |

### Creates a knowledge entry
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/create-faq` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| AgentKey | string | no | The key of the business space. If this parameter is not set, the default business space is accessed. You can obtain the key value from the… |
| CategoryId | integer | yes | The category ID of the knowledge entry |
| Title | string | yes | The title of the knowledge entry. Maximum length: 120 characters |
| StartDate | string | no | The effective period |
| EndDate | string | no | The expiration time |
| SolutionContent | string | no | The default answer content. This parameter is required if the fallback perspective is enabled |
| SolutionType | integer | no | The type of the default answer. Valid values: 0: plain text. 1: rich text |
| TagIdList | string | no | The list of label IDs (JSON-encoded) |

### Creates a chatbot in a sandbox environment
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/create-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| Name | string | no | The name of the chatbot. The name can be up to 50 characters in length |
| LanguageCode | string | no | The language of the chatbot service, such as zh-cn or en-us. Default value: the default language of the workspace. Valid values: the… |
| Introduction | string | no | The description of the chatbot. The description can be up to 50 characters in length |
| RobotType | string | no | The type of the chatbot. Default value: scenario_im |
| AgentKey | string | no | The workspace key. If this parameter is not specified, the default workspace is accessed. Obtain the key value from the business… |

### Publishes a sandbox chatbot to the production environment
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/create-instance-publish-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | no | The unique identifier of the chatbot instance |
| AgentKey | string | no | The key of the business space. If this parameter is not specified, the default business space is accessed. You can obtain the key from the… |

### Creates an intent. The intent includes meta information such as the intent name, intent alias, and…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/create-intent` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| AgentKey | string | no | The business space key. If this parameter is not set, the default business space is accessed. You can obtain the key value on the business… |
| InstanceId | string | yes | The chatbot ID |
| IntentDefinition | string | no | The intent definition struct (JSON-encoded) |

### Creates an advanced semantic configuration (LGF) for a specified intent
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/create-lgf` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| AgentKey | string | no | The business space key. If this parameter is not specified, the default business space is accessed. You can obtain the key value on the… |
| InstanceId | string | yes | The robot ID |
| LgfDefinition | string | no | The LGF definition information (JSON-encoded) |

### Creates a perspective
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/create-perspective` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| Name | string | no | The name of the perspective. The name can be up to 50 characters in length |
| Description | string | no | The description of the perspective |
| AgentKey | string | no | The key of the business space. If this parameter is not specified, the default business space is accessed. You can obtain the key from the… |

### Creates a publish task in the publish center
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/create-publish-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| BizType | string | no | The publish unit type. To publish a chatbot, use the CreateInstancePublishTask API |
| DataIdList | string | no | Additional publish information. Currently supported: if BizType is faq, this field specifies category IDs, indicating that only knowledge… |
| AgentKey | string | no | The workspace key. If not specified, the default workspace is accessed. Obtain the key value from the business management page of the… |

### Creates a similar question
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/create-sim-question` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| AgentKey | string | no | The business space key. If not specified, the default business space is accessed. You can obtain the key value from the business… |
| KnowledgeId | integer | yes | The knowledge ID |
| Title | string | yes | The title of the similar question. The maximum length is 120 characters |

### Creates a knowledge answer
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/create-solution` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| KnowledgeId | integer | yes | The knowledge ID |
| Content | string | yes | The content of the answer |
| ContentType | integer | no | The type of the answer. Valid values: 0: plain text. 1: rich text |
| PerspectiveCodes | string | yes | The list of perspective codes (JSON-encoded) |
| TagIdList | string | no | The list of tag IDs (JSON-encoded) |
| AgentKey | string | no | The key of the workspace. If this parameter is not specified, the default workspace is accessed. You can obtain the key on the business… |

### Creates a label
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/create-tag` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| ClientToken | string | no | The idempotence parameter |
| TagName | string | yes | The name of the label group |
| GroupId | integer | yes | The ID of the label group |
| AgentKey | string | no | AgentKey |

### Creates a tag group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/create-tag-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| ClientToken | string | no | The client token for idempotence |
| GroupName | string | yes | The name of the tag group |
| AgentKey | string | no | AgentKey |

### Adds utterance information to a specified intent
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/create-user-say` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| AgentKey | string | no | The business space key. If not specified, the default business space is accessed. You can obtain the key value from the business… |
| InstanceId | string | yes | The chatbot ID |
| UserSayDefinition | string | no | The user utterance definition information (JSON-encoded) |

### Deletes a category. A published category changes to the deleted and unpublished state, while an unpublished…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/delete-category` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| CategoryId | integer | yes | The category ID |
| AgentKey | string | no | The business space key. If this parameter is not specified, the default business space is accessed. You can obtain the key value from the… |

### Deletes the associated knowledge of a knowledge item
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/delete-conn-question` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| OutlineId | integer | yes | The ID of the association |
| AgentKey | string | no | The key of the workspace. If this parameter is not specified, the default workspace is accessed. You can obtain the key on the business… |

### Deletes an entity. This operation cascade deletes all entity members, synonyms, and regular expressions…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/delete-dsentity` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| AgentKey | string | no | Business space key. If not specified, the default business space is accessed. Obtain the key value from the business management page of… |
| InstanceId | string | yes | The chatbot ID |
| EntityId | integer | yes | The entity ID |

### Deletes a member of a specified entity. If the entity is a standard entity, the synonyms of the member are…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/delete-dsentity-value` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| AgentKey | string | no | The key of the workspace. If this parameter is not specified, the default workspace is accessed. You can obtain the key on the business… |
| InstanceId | string | yes | The robot ID |
| EntityId | integer | yes | The entity ID |
| EntityValueId | integer | yes | The entity member ID |

### Deletes a document
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/delete-doc` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| AgentKey | string | no | The key of the business space. If this parameter is not set, the default business space is accessed. You can obtain the key on the… |
| KnowledgeId | integer | yes | The knowledge ID |

### Deletes a knowledge entry
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/delete-faq` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| AgentKey | string | no | The business space key. If not specified, the default business space is accessed. You can obtain the key value from the business… |
| KnowledgeId | integer | yes | The knowledge ID |

### Deletes a chatbot from both the sandbox and production environments
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/delete-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | no | The unique identifier of the chatbot |
| AgentKey | string | no | The business space key. If this parameter is not specified, the default business space is accessed. You can obtain the key value on the… |

### Deletes an intent and cascade deletes all intent utterances and advanced semantic configurations (LGF) under…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/delete-intent` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| AgentKey | string | no | The business space key. If this parameter is not specified, the default business space is accessed. You can obtain the key value from the… |
| InstanceId | string | yes | The robot ID |
| IntentId | integer | yes | The intent ID |

### Deletes a specified advanced semantic configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/delete-lgf` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| AgentKey | string | no | The business space key. If not specified, the default business space is accessed. You can obtain the key value on the business management… |
| InstanceId | string | yes | The chatbot ID |
| IntentId | integer | yes | The intent ID |
| LgfId | integer | yes | lgf Id |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| PerspectiveId | string | no | The perspective ID |
| AgentKey | string | no | The business space key. If this parameter is not specified, the default business space is accessed. You can obtain the key value from the… |

### Deletes a similar question
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/delete-sim-question` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| AgentKey | string | no | The business space key. If this parameter is not specified, the default business space is accessed. You can obtain the key value on the… |
| SimQuestionId | integer | yes | The ID of the similar question |

### Deletes an answer
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/delete-solution` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| SolutionId | integer | yes | The ID of the answer |
| AgentKey | string | no | The key of the business space. If this parameter is not specified, the default business space is accessed. You can obtain the key on the… |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| ClientToken | string | no | The idempotence parameter |
| Id | integer | yes | The tag ID |
| GroupId | integer | yes | The tag group ID |
| AgentKey | string | no | AgentKey |

### Deletes a tag group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/delete-tag-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| ClientToken | string | no | The idempotence parameter |
| Id | integer | yes | The ID of the tag group |
| AgentKey | string | no | AgentKey |

### Modifies the utterance information of an intent
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/delete-user-say` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| AgentKey | string | no | The business space key. If this parameter is not set, the default business space is accessed. You can obtain the key value on the business… |
| InstanceId | string | yes | The robot ID |
| IntentId | integer | yes | The intent ID |
| UserSayId | integer | yes | The utterance ID |

### Queries the information of a single category
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/describe-category` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| CategoryId | integer | yes | The category ID |
| AgentKey | string | no | The key of the business space. If this parameter is not specified, the default business space is accessed. You can obtain the key value… |

### Queries the metadata of a specified entity under a specified chatbot, such as entity type, entity name,…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/describe-dsentity` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| AgentKey | string | no | The business space key. If this parameter is not set, the default business space is accessed. Obtain the key value from the business… |
| InstanceId | string | yes | The chatbot ID |
| EntityId | integer | yes | The entity ID |

### Queries the details of a document
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/describe-doc` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| AgentKey | string | no | The business space key. If this parameter is not specified, the default business space is accessed. You can obtain the key value on the… |
| KnowledgeId | integer | yes | The knowledge ID |
| ShowDetail | string | no | Specifies whether to display detailed paragraph information of the document. Valid values: true: Display. false: Ignore (default) |

### Queries the details of a knowledge entry
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/describe-faq` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| AgentKey | string | no | The business space key. If this parameter is not specified, the default business space is accessed. You can obtain the key value on the… |
| KnowledgeId | integer | yes | The knowledge ID |

### Queries the details of a chatbot
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/describe-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | no | The unique identifier of the chatbot |
| AgentKey | string | no | The key of the business space. If this parameter is not specified, the default business space is accessed. You can obtain the key on the… |

### Returns the metadata of a specified intent, such as the intent type, intent name, creation time, and…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/describe-intent` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| AgentKey | string | no | The business space key. If this parameter is not specified, the default business space is accessed. You can obtain the key value from the… |
| InstanceId | string | yes | The chatbot ID |
| IntentId | integer | yes | The intent ID |

### Queries the details of a perspective
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/describe-perspective` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| PerspectiveId | string | no | The perspective ID |
| AgentKey | string | no | The business space key. If not specified, the default business space is accessed. Obtain the key value from the business management page… |

### Retrieves the details of a tag
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/describe-tag` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| ClientToken | string | no | The idempotence parameter |
| Id | integer | yes | The tag ID |
| GroupId | integer | yes | The tag group ID |
| AgentKey | string | no | AgentKey |

### Retrieves the details of a tag group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/describe-tag-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| ClientToken | string | no | The idempotence parameter |
| Id | integer | yes | The ID of the tag group |
| AgentKey | string | no | AgentKey |

### Saves user feedback on Q&A results
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/feedback` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| MessageId | string | no | The ID that uniquely identifies a single message in a session window |
| Feedback | string | no | The feedback type, which corresponds to the FeedbackType field in the session history API. Valid values: good: Like. bad: Dislike |
| SessionId | string | no | The session ID that uniquely identifies an IM session |
| FeedbackContent | string | no | The content of the like or dislike feedback. You can directly enter the feedback content or pass in a JSON string as shown in the example.… |
| InstanceId | string | no | The unique identifier of the chatbot |
| AgentKey | string | no | The business space key. If this parameter is not specified, the default business space is accessed. You can obtain the key value on the… |

### Retrieves a token for passwordless logon in the chat window, which carries the enterprise identity of the user
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/generate-user-access-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| ExpireTime | integer | no | Reserved parameter. You do not need to specify this parameter |
| AgentKey | string | no | The key of the business space. If you do not specify this parameter, the default business space is accessed. You can obtain the key value… |
| ExtraInfo | string | no | The additional information in JSON string format |
| Email | string | no | The Email |
| Telephone | string | no | The Telephone |
| ForeignId | string | yes | The external user ID |
| Nick | string | yes | The nickname of the visitor |

### Retrieves the business space ID
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/get-agent-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | no | The instance ID |

### Retrieves the result of an asynchronous service execution. This operation is used together with the Chat…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/get-async-result` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| TaskId | string | yes | The task ID of the asynchronous service |
| AgentKey | string | no | The workspace key. If not specified, the default workspace is accessed. Obtain the key value from the business management page of the… |

### Queries the overview metrics of chatbot Q&A
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/get-bot-session-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| StartTime | string | yes | The start time of the query. The time format is yyyyMMdd, such as 20240505 |
| EndTime | string | yes | The end time of the query. The time format is yyyyMMdd, such as 20240605 |
| RobotInstanceId | string | yes | The ID of the chatbot instance |
| AgentKey | string | no | The business space key. If this parameter is not specified, the default business space is accessed. You can obtain the key value on the… |

### Queries the publish progress of a chatbot
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/get-instance-publish-task-state` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | no | The unique identifier of the chatbot |
| Id | integer | no | The task ID |
| AgentKey | string | no | The business space key. If not specified, the default business space is accessed. You can obtain the key value from the business… |

### Queries the publish progress
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/get-publish-task-state` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| Id | integer | no | The ID of the publish task |
| AgentKey | string | no | The key of the business space. If this parameter is not specified, the default business space is accessed. Obtain the key value from the… |

### Initializes an IM connection with custom settings by using the from value generated from the channel backend…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/init-imconnect` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| From | string | yes | The From |
| UserAccessToken | string | no | The UserAccessToken |
| AgentKey | string | no | The business space key. If this parameter is not specified, the default business space is accessed. You can obtain the key value on the… |

### Associates knowledge categories with a chatbot
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/link-instance-category` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | no | The unique identifier of the chatbot |
| CategoryIds | string | no | The array of FAQ category IDs to associate with the chatbot |
| AgentKey | string | no | The business space key. If this parameter is not specified, the default business space is accessed. You can obtain the key on the business… |
| AbilityType | string | no | The capability type of the category. Valid values: FAQ: Frequently asked questions. MRC: Document-based machine reading comprehension.… |

### Retrieves the list of business spaces for the current Alibaba Cloud account
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/list-agent` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| PageNumber | integer | no | The current page number. Default value: 1 |
| PageSize | integer | no | The number of records per page in the response. Maximum value: 100. Default value: 10 |
| AgentName | string | no | The business space name. You can use this parameter to search by name |
| GoodsCodes | string | no | The commodity code. You can use this parameter to filter by commodity code and query instance information |

### Retrieves the list of categories
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/list-category` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| KnowledgeType | integer | no | The knowledge type. Valid values: 1: FAQ category. 3: Document category. Default value: 1 |
| ParentCategoryId | integer | no | The ID of the parent category |
| AgentKey | string | no | The key of the business space. If not specified, the default business space is accessed. Obtain the key value from the business management… |

### Queries the list of associated questions for a knowledge item
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/list-conn-question` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| KnowledgeId | integer | yes | The knowledge ID |
| AgentKey | string | no | The business space key. If not specified, the default business space is accessed. You can obtain the key value from the business… |

### Queries the list of entities under a specified chatbot. Only the metadata of each entity is returned, such…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/list-dsentity` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| AgentKey | string | no | The business space key. If this parameter is not specified, the default business space is accessed. You can obtain the key value on the… |
| InstanceId | string | yes | The chatbot ID |
| Keyword | string | no | The filter keyword. Uses contains matching. Scope: entity name (future expansion: entity members, synonyms) |
| EntityType | string | no | If left empty, all custom entities are returned (default) |
| PageNumber | integer | no | The page number. Default value: 1 |
| PageSize | integer | no | The number of entries per page. Default value: 10 |

### Queries the list and details of entity members for a specified entity. Keyword filtering (contains) is…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/list-dsentity-value` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| AgentKey | string | no | The business space key. If not specified, the default business space is accessed. Obtain the key value from the business management page… |
| InstanceId | string | yes | The chatbot ID |
| EntityId | integer | yes | The entity ID |
| EntityValueId | integer | no | The entity member ID |
| Keyword | string | no | The search keyword for the entity member name |
| PageNumber | integer | no | The page number |
| PageSize | integer | no | The page size |

### Queries the list of chatbots
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/list-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| PageNumber | integer | no | The page number for pagination. Default value: 1 |
| PageSize | integer | no | The number of entries per page. Default value: 10 |
| RobotType | string | no | Filters chatbots by type |
| Name | string | no | Performs a fuzzy match by chatbot name |
| AgentKey | string | no | The business space key. If not specified, the default business space is accessed. Obtain the key value from the business management page… |
| Sandbox | string | no | The Sandbox |

### Queries the list of intents under a specified chatbot. Only the metadata of each intent is returned, such as…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/list-intent` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| AgentKey | string | no | The business space key. If this parameter is not specified, the default business space is accessed. You can obtain the key value on the… |
| InstanceId | string | yes | The chatbot ID |
| IntentName | string | no | The intent name |
| PageNumber | integer | no | The page number. Default value: 1 |
| PageSize | integer | no | The number of entries per page. Default value: 10 |

### Queries the advanced semantic configuration (LGF) of a specified intent
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/list-lgf` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| AgentKey | string | no | The business space key. If not specified, the default business space is accessed. You can obtain the key value from the business… |
| InstanceId | string | yes | The chatbot ID |
| IntentId | integer | yes | The intent ID |
| LgfText | string | no | The semantic configuration content to filter |
| PageNumber | integer | no | The page number. Default value: 1 |
| PageSize | integer | no | The number of entries per page. Default value: 10 |

### Retrieves the list of SaaS integration information
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/list-saas-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| AgentKey | string | no | The business space key. If this parameter is not specified, the default business space is accessed. You can obtain the key value from the… |
| SaasName | string | yes | The username of the business party |
| SaasGroupCodes | string | no | The SaaS permission group codes owned by the user. Separate multiple codes with commas (,) |

### Retrieves the list of permission integration information. You can use the permission groups returned in this…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/list-saas-permission-group-infos` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| AgentKey | string | yes | The business workspace key. If this parameter is not specified, the default business workspace is accessed. You can obtain the key value… |

### Queries the list of similar questions for a knowledge entry
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/list-sim-question` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| AgentKey | string | no | The workspace key. If not specified, the default workspace is accessed. You can obtain the key value on the business management page of… |
| KnowledgeId | integer | yes | The knowledge ID |

### Queries the list of answers for a knowledge item
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/list-solution` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| KnowledgeId | integer | yes | The knowledge ID |
| AgentKey | string | no | The key of the business space. If not specified, the default business space is accessed. Obtain the key value from the business management… |

### Queries tags
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/list-tag` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| ClientToken | string | no | The client token |
| TagName | string | no | The tag name |
| PageNumber | integer | no | The page number |
| PageSize | integer | no | The number of entries per page. Default value: 10 |
| AgentKey | string | no | AgentKey |
| GroupId | integer | no | The ID of the tag group |

### Queries tag groups
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/list-tag-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| ClientToken | string | no | The client token for idempotency |
| GroupName | string | no | The name of the tag group |
| PageNumber | integer | no | The page number |
| PageSize | integer | no | The number of entries per page. Default value: 10 |
| AgentKey | string | no | AgentKey |

### Retrieves the session history details
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/list-tongyi-chat-historys` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| StartTime | string | yes | The start time of the query. The time is in the yyyy-MM-dd HH:mm:ss format, such as 2024-04-01 00:00:00 |
| EndTime | string | yes | The end time of the query. The time is in the yyyy-MM-dd HH:mm:ss format, such as 2024-04-01 08:00:00 |
| RobotInstanceId | string | yes | The ID of the robot instance |
| Limit | integer | no | The number of data entries. Default value: 30. Maximum value: 500 |
| AgentKey | string | no | The key of the business space. If this parameter is not specified, the default business space is accessed. You can obtain the key value on… |

### Queries the conversation records of a single session for Chatbot Tongyi Edition
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/list-tongyi-conversation-logs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| RobotInstanceId | string | yes | The robot instance ID |
| SessionId | string | yes | The session ID |
| AgentKey | string | no | The business space key. If not specified, the default business space is accessed. You can obtain the key value from the business… |

### Queries the utterance content and associated slot information of a specified intent. Supports filtering…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/list-user-say` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| AgentKey | string | no | The business space key. If not specified, the default business space is accessed. You can obtain the key value from the business… |
| InstanceId | string | yes | The chatbot ID |
| IntentId | integer | yes | The intent ID |
| Content | string | no | The keyword used to filter user utterances |
| PageNumber | integer | no | The page number. Default value: 1 |
| PageSize | integer | no | The number of entries per page. Default value: 10. Maximum value: 1000 |

### Returns the natural language understanding (NLU) result of a chatbot for a user query. Currently, only NLU…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/nlu` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | no | The unique identifier of the chatbot |
| Utterance | string | no | The user utterance |
| AgentKey | string | no | The business space key. If not specified, the default business space is accessed. You can obtain the key on the business management page… |

### Queries the list of perspectives
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/query-perspectives` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| AgentKey | string | no | The business space key. If not specified, the default business space is accessed. You can obtain the key value from the business… |

### Retries document processing
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/retry-doc` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| AgentKey | string | no | The key of the workspace. If this parameter is not specified, the default workspace is accessed. You can obtain the key on the business… |
| KnowledgeId | integer | yes | The knowledge ID |

### Searches for documents
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/search-doc` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| AgentKey | string | no | The business space key. If not specified, the default business space is accessed. You can obtain the key value from the business… |
| Keyword | string | no | The keyword |
| CategoryIds | string | no | The list of category IDs (JSON-encoded) |
| ProcessStatus | integer | no | The task status. Valid values: -1: queued 0: succeeded 1: parsing 2: processing 3: processing failed |
| Status | integer | no | The editing status. Valid values: 1: unpublished 2: published 3: updated but not published |
| SearchScope | integer | no | The search scope. Valid values: 1: search by title 2: search by content |
| CreateUserName | string | no | The name of the creator |
| ModifyUserName | string | no | The name of the modifier |
| CreateTimeBegin | string | no | The start of the creation time range |
| CreateTimeEnd | string | no | The end of the creation time range |
| ModifyTimeBegin | string | no | The start of the modification time range |
| ModifyTimeEnd | string | no | The end of the modification time range |
| StartTimeBegin | string | no | The start of the effective time range |
| StartTimeEnd | string | no | The end of the effective time range |
| EndTimeBegin | string | no | The start of the expiration time range |
| EndTimeEnd | string | no | The end of the expiration time range |
| PageNumber | integer | no | The page number |
| PageSize | integer | no | The number of entries per page |
| TagIds | string | no | The list of label IDs. When multiple labels are specified, the union logic is used for filtering (JSON-encoded) |

### Searches for knowledge
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/search-faq` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| AgentKey | string | no | The business space key. If not specified, the default business space is accessed. Obtain the key value from the business management page… |
| Keyword | string | no | The keyword |
| CategoryIds | string | no | The unique identifier of the category (JSON-encoded) |
| Status | integer | no | The knowledge status. Valid values: -1: deleted and unpublished. 1: unpublished. 2: published. 3: updated and unpublished |
| SearchScope | integer | no | The search scope. Valid values: 1: Search titles and similar questions. 2: Search answers. 3: Search all |
| CreateUserName | string | no | The name of the creator |
| ModifyUserName | string | no | The name of the modifier |
| CreateTimeBegin | string | no | The start of the creation time range |
| CreateTimeEnd | string | no | The end of the creation time range |
| ModifyTimeBegin | string | no | The start of the modification time range |
| ModifyTimeEnd | string | no | The end of the modification time range |
| StartTimeBegin | string | no | The start of the effective time range |
| StartTimeEnd | string | no | The end of the effective time range |
| EndTimeBegin | string | no | The start of the expiration time range |
| EndTimeEnd | string | no | The end of the expiration time range |
| PageNumber | integer | no | The page number. Default value: 1 |
| PageSize | integer | no | The number of entries per page. Default value: 10. Maximum value: 100 |

### Retrieves the debugging information for large language model Q&A
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/tongyi-chat-debug-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| AgentKey | string | no | The key of the workspace. If you do not specify this parameter, the default workspace is accessed. You can obtain the key value from the… |
| InstanceId | string | yes | The ID of the chatbot |
| MessageId | string | yes | The ID of the response message for the current session |

### Updates a category
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/update-category` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| CategoryId | integer | yes | The category ID |
| BizCode | string | no | The business code |
| Name | string | yes | The category name |
| AgentKey | string | no | The business space key. If this parameter is not specified, the default business space is accessed. Obtain the key value from the business… |

### Updates an association
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/update-conn-question` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| ConnQuestionId | integer | yes | The ID of the associated knowledge |
| OutlineId | integer | yes | The ID of the association |
| AgentKey | string | no | The key of the workspace. If this parameter is not specified, the default workspace is accessed. You can obtain the key on the business… |

### Modifies the meta information of an entity. Only the entity name can be modified. The entity type cannot be…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/update-dsentity` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| AgentKey | string | no | The business space key. If this parameter is not set, the default business space is accessed. You can obtain the key value from the… |
| InstanceId | string | yes | The chatbot ID |
| EntityId | integer | yes | The entity ID |
| EntityName | string | yes | The entity name. Only Chinese characters, uppercase and lowercase letters, digits, and underscores are supported |
| EntityType | string | no | The entity type. Valid values: synonyms (synonym) and regex (regular expression) |

### Modifies a member of a specified entity. Two types of data can be modified: entity values with synonyms, and…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/update-dsentity-value` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| AgentKey | string | no | The business space key. If this parameter is not set, the default business space is accessed. Obtain the key value from the business… |
| InstanceId | string | yes | The chatbot ID |
| EntityId | integer | yes | The entity ID. This parameter can be left empty when you modify an entity member |
| EntityValueId | integer | yes | The entity member ID. This parameter is left empty when you create an entity member |
| Content | string | yes | When the entity type is synonyms, this parameter specifies the normalized value of the entity. When the entity type is regex, this… |
| Synonyms | string | no | The list of synonyms (JSON-encoded) |

### Updates a document
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/update-doc` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| AgentKey | string | no | The business space key. If this parameter is not specified, the default business space is accessed. You can obtain the key value on the… |
| KnowledgeId | integer | yes | The document ID |
| CategoryId | integer | no | The document category ID |
| DocName | string | no | The document name |
| Title | string | no | The document title |
| Content | string | no | The document content |
| Config | string | no | The document parsing/chunking configuration. Configuration item: Splitter KEY: Splitter Valid values: paragraphSplitter - hierarchy… |
| Meta | string | no | The document metadata |
| StartDate | string | no | The start of the effective period |
| EndDate | string | no | The end of the effective period |
| TagIds | string | no | The list of tag IDs. If this parameter is left empty, the tag bindings are removed (JSON-encoded) |
| DocMetadata | string | no | The DocMetadata (JSON-encoded) |

### Edits a knowledge entry
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/update-faq` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| AgentKey | string | no | The workspace key. If not specified, the default workspace is accessed. You can obtain the key value from the business management page of… |
| KnowledgeId | integer | yes | The knowledge ID |
| CategoryId | integer | yes | The category ID of the knowledge entry |
| Title | string | yes | The title of the knowledge entry |
| StartDate | string | no | The effective period |
| EndDate | string | no | The expiration time |
| TagIdList | string | no | The list of tag IDs (JSON-encoded) |

### Updates the name and description of a chatbot
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/update-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | no | The unique identifier of the chatbot |
| Name | string | no | The name of the chatbot to update. The name can be up to 50 characters in length |
| Introduction | string | no | The remarks of the chatbot to update |
| AgentKey | string | no | The business space key. If this parameter is not specified, the default business space is accessed. You can obtain the key value from the… |

### Modifies an intent, including the meta information of the intent, such as the intent name, intent alias, and…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/update-intent` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| AgentKey | string | no | The business space key. If this parameter is not specified, the default business space is accessed. You can obtain the key value on the… |
| InstanceId | string | yes | The chatbot ID |
| IntentId | integer | yes | The intent ID |
| IntentDefinition | string | no | The intent definition struct (JSON-encoded) |

### Creates an advanced semantic configuration (LGF) for a specified intent
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/update-lgf` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| AgentKey | string | no | The business space key. If not specified, the default business space is accessed. You can obtain the key value from the business… |
| InstanceId | string | yes | The chatbot ID |
| LgfId | integer | yes | LGF ID |
| LgfDefinition | string | yes | The LGF information (JSON-encoded) |

### Updates the name and description of a perspective
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/update-perspective` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| PerspectiveId | string | no | The perspective ID |
| Name | string | no | The perspective name. The name can be up to 50 characters in length |
| AgentKey | string | no | The business space key. If not specified, the default business space is accessed. Obtain the key value from the business management page… |

### Updates a similar question
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/update-sim-question` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| AgentKey | string | no | The key of the business space. If this parameter is not specified, the default business space is accessed. You can obtain the key on the… |
| Title | string | yes | The title of the similar question. The maximum length is 120 characters |
| SimQuestionId | integer | yes | The ID of the similar question |

### Updates an answer
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/update-solution` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| SolutionId | integer | yes | The answer ID |
| Content | string | yes | The answer content |
| ContentType | integer | no | The answer type. Valid values: 0: plain text 1: rich text |
| PerspectiveCodes | string | yes | The list of perspective codes (JSON-encoded) |
| TagIdList | string | no | The list of tag IDs (JSON-encoded) |
| AgentKey | string | no | The workspace key. If this parameter is not specified, the default workspace is accessed. You can obtain the key from the business… |

### Updates a tag
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/update-tag` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| ClientToken | string | no | The idempotence parameter |
| TagName | string | yes | The tag name |
| Id | integer | yes | The tag ID |
| GroupId | integer | yes | The tag group ID |
| AgentKey | string | no | AgentKey |

### Updates a label group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/update-tag-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| ClientToken | string | no | The idempotence parameter |
| GroupName | string | yes | The name of the label group |
| Id | integer | yes | The ID of the label group |
| AgentKey | string | no | AgentKey |

### Modifies the utterance information of an intent
`POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/update-user-say` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://chatbot.cn-shanghai.aliyuncs.com |
| AgentKey | string | no | The business space key. If this parameter is not specified, the default business space is accessed. You can obtain the key value from the… |
| InstanceId | string | yes | The robot ID |
| UserSayId | integer | yes | The user utterance ID |
| UserSayDefinition | string | no | The definition of the user utterance (JSON-encoded) |

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

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

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/apply-for-stream-access-token" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud Beebot API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:aliyun-chatbot/apply-for-stream-access-token with the header x-api-key. Every endpoint returns { project, data, timestamp }.

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

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

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