# Alibaba Cloud Quan Miao API

> Alibaba Cloud Quan Miao API on Apizie: 220 endpoints (Add a custom term to the audit dictionary, Adds a document to a data source, Generates a video clip, Creates an intelligent clip timeline, …) 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-aimiaobi/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

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

Alibaba Cloud OpenAPI for Quan Miao (aimiaobi, version 2023-08-01). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Add a custom term to the audit dictionary
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/add-audit-terms` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| WorkspaceId | string | yes | Unique identifier of the Alibaba Cloud Model Studio workspace. To get this ID, see https://help.aliyun.com/document_detail/2782167.html |
| Keyword | string | no | Keyword |
| SuggestWord | string | no | Suggested word |
| TermsDesc | string | no | Audit basis |
| ExceptionWord | string | no | Exception phrase (JSON-encoded) |
| TermsName | string | no | Name of the dictionary. Optional. If not specified, defaults to Default |

### Adds a document to a data source
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/add-dataset-document` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| WorkspaceId | string | yes | The unique identifier of the Alibaba Cloud Bailian workspace. For more information, see https://help.aliyun.com/document_detail/2782167.html |
| DatasetId | integer | no | The unique identifier of the dataset |
| DatasetName | string | no | The name of the dataset |
| Document | string | yes | The document (JSON-encoded) |

### Generates a video clip
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/async-create-clips-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| TaskId | string | yes | The unique ID of the task |
| VoiceStyle | string | no | The type of narration voice |
| MusicUrl | string | no | The URL of the background music |
| ColorWords | string | no | The array of animated text elements (JSON-encoded) |
| WorkspaceId | string | yes | The https://help.aliyun.com/document_detail/2782167.html |
| VoiceVolume | integer | no | The volume of the narration voice |
| MusicVolume | integer | no | The volume of the background music |
| SubtitleFontSize | integer | no | The font size of the subtitles |
| Height | integer | no | The height of the video |
| Width | integer | no | The width of the video |
| CloseVoice | string | no | Specifies whether to disable the narration voice |
| CloseMusic | string | no | Specifies whether to disable the background music |
| CloseSubtitle | string | no | Specifies whether to disable the subtitles |
| CustomVoiceUrl | string | no | The URL of the custom audio track |
| CustomVoiceVolume | integer | no | The volume of the custom audio track |
| Stickers | string | no | The array of sticker structures (JSON-encoded) |
| CustomVoiceStyle | string | no | The voice tone of CosyVoice |
| CosyVoiceAppKey | string | no | The AppKey of CosyVoice |
| CosyVoiceToken | string | no | The token of CosyVoice |
| MusicStyle | string | no | The type of recommended music |
| OpeningCreditsUrl | string | no | The URL of the opening credits video |
| ClosingCreditsUrl | string | no | The URL of the closing credits video |
| HighDefSourceVideos | string | no | The list of high-definition video structures (JSON-encoded) |
| Alignment | string | no | 横幅文字定位对齐方式，默认为TopLeft， |
| AdaptMode | string | no | 适配模式，横幅文字当超出视频宽度或超出指定TextWidth时进行自动换行或缩放 |
| TextWidth | string | no | 字幕文本框宽度，当设置AdaptMode时生效 |

### Creates an intelligent clip timeline
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/async-create-clips-time-line` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| TaskId | string | yes | The unique ID of the task |
| ProcessPrompt | string | no | The prompt used for processing |
| WorkspaceId | string | yes | The https://help.aliyun.com/document_detail/2782167.html |
| CustomContent | string | no | The custom voiceover content |
| NoRefVideo | string | no | Specifies whether to enable the imitation capability |
| AdditionalContent | string | no | The supplementary information about the material, which helps generate the voiceover script |
| RecommendAudio | string | no | Specifies whether to automatically recommend audio based on the video content when generating the timeline |
| TimelineScene | integer | no | The timeline scene type. Valid values: 0: general voiceover. 1: highlight |
| HighLightConfig | string | no | The configuration for the highlight video (JSON-encoded) |

### Updates the timeline of an editing task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/async-edit-timeline` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| TaskId | string | yes | The unique identifier of the task |
| Timelines | string | yes | The array structure of the editing timelines (JSON-encoded) |
| WorkspaceId | string | yes | The https://help.aliyun.com/document_detail/2782167.html |
| AutoClips | string | no | Specifies whether to enable the automatic adjustment capability |

### Upload a tender document
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/async-upload-tender-doc` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| WorkspaceId | string | no | https://help.aliyun.com/document_detail/2782167.html |
| TenderDocName | string | no | Tender document name |
| FileKey | string | no | File OSS key |

### Uploads video clip materials
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/async-upload-video` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| SourceVideos | string | yes | The clip material structure (JSON-encoded) |
| AnlysisPrompt | string | no | The prompt for video understanding |
| WorkspaceId | string | yes | https://help.aliyun.com/document_detail/2782167.html |
| ReferenceVideo | string | no | The reference video information used for the clip task (JSON-encoded) |
| SplitInterval | integer | no | The shot time interval for video understanding |
| VideoRoles | string | no | The character face information (JSON-encoded) |
| FaceIdentitySimilarityMinScore | number | no | The similarity threshold for character recognition |
| VideoShotFaceIdentityCount | integer | no | The number of frames (images) sampled from a single shot for character matching |
| RemoveSubtitle | string | no | Specifies whether to remove subtitles from the material |
| TaskName | string | no | The task name |
| TaskType | string | no | The task type |
| AdaptiveThreshold | number | no | The shot segmentation threshold. A smaller value makes shot segmentation more sensitive. Valid values: 1 to 10. Default value: 3 |

### An API for writing bidding documents
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/async-writing-bidding-doc` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| WorkspaceId | string | no | https://help.aliyun.com/document_detail/2782167.html |
| TaskId | string | no | The unique ID of the task |
| Prompt | string | no | The prompt |
| CompanyKeyword | string | no | The name of the bidding company |

### Associates PPT artifact information
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/bind-ppt-artifact` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| WorkspaceId | string | no | The https://help.aliyun.com/document_detail/2782167.html |
| TaskId | string | yes | The node ID |
| ArtifactId | integer | yes | The artifact ID |
| ExternalUserId | string | no | The unique identifier of the user passed in from a third-party system |

### Cancels pending asynchronous tasks
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/cancel-async-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| AgentKey | string | yes | The unique identifier of the workspace. For more information, see https://help.aliyun.com/document_detail/2587494.html |
| TaskId | string | no | The unique ID of the task. The system automatically generates the TaskId. This parameter does not need to be specified. If subsequent… |

### Cancel an audit task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/cancel-audit-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| ContentAuditTaskId | string | no | Audit task ID. Specify either this parameter or ArticleId |
| ArticleId | string | no | Article ID. Specify either this parameter or ContentAuditTaskId |
| WorkspaceId | string | no | https://help.aliyun.com/document_detail/2782167.html |

### Cancels a deep writing task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/cancel-deep-write-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| WorkspaceId | string | no | https://help.aliyun.com/document_detail/2782167.html |
| TaskId | string | no | Task ID |

### Clears all intervention content
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/clear-intervenes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| AgentKey | string | yes | Unique identifier of the workspace: https://help.aliyun.com/document_detail/2587494.html |

### This interface confirms whether the parsing results from your custom rule library submission are used for…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/confirm-and-post-process-audit-note` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| WorkspaceId | string | yes | Alibaba Cloud Model Studio workspace unique identifier: Get https://help.aliyun.com/document_detail/2782167.html |
| TaskId | string | yes | The TaskId obtained from the SubmitAuditNote interface. This is the unique identifier for the custom rule library task index. Store it… |

### Batch add permissions:\ - Dataset permissions\
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/create-data-permissions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| WorkspaceId | string | yes | The unique identifier of the Alibaba Cloud Model Studio workspace. For more information, see… |
| DataType | string | yes | The permission type. Currently, only \`dataset\` is supported |
| DataId | string | yes | A unique identifier for the permission |
| PermissionUserInfos | string | yes | The users to whom you want to assign permissions (JSON-encoded) |

### Creates a data source
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/create-dataset` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| WorkspaceId | string | yes | The unique identifier of the Alibaba Cloud Bailian workspace: https://help.aliyun.com/document_detail/2782167.html |
| DatasetType | string | no | The dataset type. Valid values: CustomSemanticSearch: custom semantic index (default). Users upload documents to build the dataset.… |
| DatasetName | string | yes | The dataset name, which must be globally unique |
| DatasetDescription | string | no | The dataset description. This is the display name shown in the console. Enter a business-readable name |
| SearchDatasetEnable | integer | no | The dataset search toggle. Valid values: 0: disabled for all. 1: visible to AMS only. 2: visible to AMB only. 3: visible to both AMS and… |
| DatasetConfig | string | no | The search configuration for the dataset (JSON-encoded) |
| DocumentHandleConfig | string | no | The dataset index configuration (JSON-encoded) |
| InvokeType | string | no | The invocation method. Currently only the value portal is supported, which indicates a console invocation. If left empty: when DatasetType… |
| AccessLevel | string | no | The access type. Valid values: private shared public |

### General configurations — Create
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/create-general-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| WorkspaceId | string | yes | Unique identifier of the Model Studio workspace. https://help.aliyun.com/document_detail/2782167.html |
| ConfigKey | string | yes | Unique identifier of the configuration item. Supported keys include the following: MiaoSou text search threshold (double):… |
| ConfigValue | string | yes | Value of the configuration item |

### Saves a document created in AMB. Rich text is supported
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/create-generated-content` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| AgentKey | string | yes | The unique identifier of the workspace: https://help.aliyun.com/document_detail/2587494.html |
| Prompt | string | no | The last generated prompt |
| TaskId | string | yes | The unique identifier of the task. By default, you do not need to specify TaskId. The system automatically generates a TaskId. If… |
| Title | string | yes | The title |
| Content | string | yes | The body content in rich text format |
| ContentDomain | string | no | The domain for content generation |
| ContentText | string | no | The body content in plain text format |
| Uuid | string | no | The UUID for tracing |
| Keywords | string | no | The keywords (JSON-encoded) |

### Creates a temporary token for the online inference API
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/create-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| AgentKey | string | yes | The unique identifier of the workspace. For more information, see https://help.aliyun.com/document_detail/2587494.html |

### Deletes all custom rule libraries available for review under the user account. Deleted rule libraries cannot…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/delete-audit-note` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| WorkspaceId | string | yes | The unique identifier of the Alibaba Cloud Bailian workspace. Obtain the https://help.aliyun.com/document_detail/2782167.html |
| NoteId | string | no | The rule library ID. If not specified, the default value is Default |

### Deletes specified term records
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/delete-audit-terms` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| WorkspaceId | string | yes | Unique identifier for the Alibaba Cloud Model Studio workspace. Get the https://help.aliyun.com/document_detail/2782167.html |
| IdList | string | no | List of rule IDs for user logon audit terms to delete (JSON-encoded) |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| AgentKey | string | yes | The unique identifier of the workspace. For more information, see https://help.aliyun.com/document_detail/2587494.html |
| Id | integer | yes | The primary key ID |
| CommodityCode | string | no | The commodity code |

### Delete a custom hot spot event by topic name
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/delete-custom-topic-by-topic` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| AgentKey | string | yes | Workspace unique identifier: https://help.aliyun.com/document_detail/2587494.html |
| Topic | string | yes | Custom topic |

### Deletes a custom topic viewpoint by its ID
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/delete-custom-topic-view-point-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| AgentKey | string | yes | Unique identifier of the workspace: https://help.aliyun.com/document_detail/2587494.html |
| CustomViewPointId | string | yes | Custom viewpoint ID |

### Batch delete dataset permissions
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/delete-data-permissions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| WorkspaceId | string | yes | The unique ID of the Alibaba Cloud Model Studio workspace. For more information, see https://help.aliyun.com/document_detail/2587495.html |
| Ids | string | yes | The permission IDs (JSON-encoded) |

### Deletes a dataset from the data source
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/delete-dataset` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| WorkspaceId | string | yes | Unique identifier of Alibaba Cloud Model Studio workspace: https://help.aliyun.com/document_detail/2782167.html |
| DatasetId | integer | yes | Unique identifier of the dataset |

### Delete source documents
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/delete-dataset-document` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| WorkspaceId | string | yes | The unique identifier of the Alibaba Cloud Model Studio workspace. For more information, see… |
| DatasetId | integer | no | The unique identifier of the dataset. Choose either DatasetId or DatasetName |
| DatasetName | string | no | Dataset name |
| DocId | string | no | The user-specified unique ID of the document |
| DocUuid | string | no | The internal unique identifier of the document |

### Deletes multiple documents
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/delete-docs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| WorkspaceId | string | yes | Unique identifier for the Alibaba Cloud Model Studio workspace. Get the https://help.aliyun.com/document_detail/2782167.html |
| DocIds | string | yes | Document ID array (JSON-encoded) |

### Deletes the specified URL used for factuality audit
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/delete-fact-audit-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| WorkspaceId | string | yes | The unique identifier of the Alibaba Cloud Model Studio workspace. Get the https://help.aliyun.com/document_detail/2782167.html |
| Url | string | yes | The URL of the audit information source you want to delete. The provided URL must match the result from GetFactAuditUrl for successful… |

### Deletes general configurations
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/delete-general-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| WorkspaceId | string | yes | Unique identifier of the Model Studio workspace. For more information, see https://help.aliyun.com/document_detail/2782167.html |
| ConfigKey | string | yes | Unique identifier of the configuration |

### Deletes a document created in AMB
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/delete-generated-content` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| AgentKey | string | yes | The unique identifier of the business space: https://help.aliyun.com/document_detail/2587494.html |
| Id | integer | yes | The unique identifier of the document |
| RegionId | string | no | The region ID. Currently, only cn-beijing (China North 2, Beijing) is supported |

### Deletes an intervention rule
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/delete-intervene-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| AgentKey | string | yes | Unique identifier of the workspace: https://help.aliyun.com/document_detail/2587494.html |
| RuleId | integer | no | Rule ID |

### Deletes a material from the material library
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/delete-material-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| AgentKey | string | yes | The unique identifier of the workspace. For more information, see https://help.aliyun.com/document_detail/2587494.html |
| Id | integer | yes | The primary key ID |

### Deletes a PPT artifact
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/delete-ppt-artifact` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| WorkspaceId | string | no | The workspace ID |
| PptArtifactId | string | no | The PPT artifact ID |
| ExternalUserId | string | no | The unique identifier of the user passed in from a third-party system |

### Deletes a specified custom style
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/delete-style-learning-result` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| AgentKey | string | yes | Unique identity of the workspace: AgentKey |
| Id | integer | yes | Style learning ID |

### Extracts document content from URLs
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/document-extraction` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| AgentKey | string | yes | The unique identifier of the business space: https://help.aliyun.com/document_detail/2587494.html |
| Urls | string | yes | The list of URLs from which to extract content (JSON-encoded) |

### Downloads a structured rule library for further processing. This operation provides two functions:…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/download-audit-note` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| WorkspaceId | string | yes | The unique identifier of the Alibaba Cloud Bailian workspace. Obtain the https://help.aliyun.com/document_detail/2782167.html |
| TaskId | string | no | The task ID obtained from the SubmitAuditNote operation. This is the unique identifier of the custom rule library task index. Store it… |
| NoteId | string | no | The rule library ID. If not specified, the default value is Default |

### API for downloading bidding documents
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/download-bidding-doc` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| WorkspaceId | string | no | https://help.aliyun.com/document_detail/2782167.html |
| TaskId | string | no | Task ID |

### Modifies a custom word list record for content moderation review
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/edit-audit-terms` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| WorkspaceId | string | yes | The unique identifier of the Alibaba Cloud Bailian workspace. Retrieve the https://help.aliyun.com/document_detail/2782167.html |
| Keyword | string | no | The keyword |
| SuggestWord | string | no | The suggested word |
| TermsDesc | string | no | The basis for the review decision |
| Id | string | no | The primary key ID |
| ExceptionWord | string | no | The exception phrases (JSON-encoded) |

### Edits the content of a bidding document
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/edit-bidding-doc` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| WorkspaceId | string | no | https://help.aliyun.com/document_detail/2782167.html |
| TaskId | string | no | The task ID |
| Content | string | no | The text content |
| ContentType | string | no | The content type |
| ContentFormat | string | no | The format |

### Exports the tag details for a specified enterprise VOC analysis task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/export-analysis-tag-detail-by-task-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| WorkspaceId | string | yes | Unique identifier for Alibaba Cloud Model Studio workspace. For more information, see https://help.aliyun.com/document_detail/2782167.html |
| TaskId | string | yes | Unique task ID. By default, do not specify TaskId. The system automatically generates it. If subsequent tasks use the same TaskId, they… |
| Categories | string | no | Category filter list (JSON-encoded) |

### Exports an automated review report
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/export-audit-content-result` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| WorkspaceId | string | no | https://help.aliyun.com/document_detail/2782167.html |
| TaskId | string | no | The ID of the task |

### Exports custom data source topic perspective analysis task results
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/export-custom-source-analysis-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| WorkspaceId | string | yes | Unique identifier for the workspace: AgentKey |
| TaskId | string | yes | Unique ID for the task |
| ExportType | string | no | Export format type. Default is jsonLine. jsonline: Exports in jsonLine format. excel: Exports in Excel format |

### Exports the history of articles created in MiaoBi
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/export-generated-content` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| AgentKey | string | yes | Workspace identity: https://help.aliyun.com/document_detail/2587494.html |
| Id | integer | yes | Document identity |

### Exports topic planning documents and provides a publicly accessible URL that expires in one hour
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/export-hot-topic-planning-proposals` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| AgentKey | string | yes | Unique identifier of the workspace: https://help.aliyun.com/document_detail/2587494.html |
| ExportType | string | no | Document export format word: Export as a Word document xmind: Export as an XMind file |
| Titles | string | no | Filter topic planning documents by title (JSON-encoded) |
| ViewPointType | string | no | Topic planning type CustomViewPoints: Custom viewpoint HotViewPoints: Popular viewpoint TimedViewPoints: Time-sensitive viewpoint… |
| CustomViewPointIds | string | no | Custom viewpoint ID. Use this parameter for custom viewpoint topic planning (JSON-encoded) |
| TopicSource | string | yes | Hot list source |
| Topic | string | yes | Hot list topic |

### Exports all intervention content
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/export-intervenes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| AgentKey | string | yes | The unique identifier of the business space: https://help.aliyun.com/document_detail/2587494.html |

### Exports a PPT artifact
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/export-ppt-artifact` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| WorkspaceId | string | no | The workspace ID |
| ExternalUserId | string | no | The user ID passed in by a third party |
| PptArtifactId | integer | yes | The PPT artifact ID |
| ExportFileType | string | no | The export format |
| Edit | string | no | Specifies whether the exported artifact is editable |
| Zip | string | no | Specifies whether the exported images are compressed into a ZIP file |

### Provides feedback on the quality of the content that the model generates
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/feedback-dialogue` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| AgentKey | string | yes | The unique ID of the workspace. For more information, see https://help.aliyun.com/document_detail/2587494.html |
| TaskId | string | no | The ID of the page |
| SessionId | string | yes | The ID of a single-turn conversation |
| Rating | string | no | thumbsDown: Dislike, thumbsUp: Like |
| RatingTags | string | no | The tags (JSON-encoded) |
| ModifiedResponse | string | no | The modified generated result |
| CustomerResponse | string | no | The feedback |
| GoodText | string | no | The generated content that is considered good |

### Retrieves the results of a term library export task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/fetch-export-terms-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| WorkspaceId | string | yes | The unique identifier of your Alibaba Cloud Model Studio workspace. To get your https://help.aliyun.com/document_detail/2782167.html, see… |
| TaskId | string | yes | The task ID |

### Fetches the result of an asynchronous document export task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/fetch-export-word-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| AgentKey | string | yes | The unique identifier of the workspace |
| TaskId | string | no | The task ID |

### Retrieve the results of image generation tasks
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/fetch-image-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| AgentKey | string | yes | Unique identifier of the workspace: https://help.aliyun.com/document_detail/2587494.html |
| TaskIdList | string | yes | List of task IDs (JSON-encoded) |
| ArticleTaskId | string | yes | Article task ID |

### Retrieves the result of a term import task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/fetch-import-terms-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| WorkspaceId | string | yes | The unique identifier of the Alibaba Cloud Model Studio workspace. For more information, see… |
| TaskId | string | yes | The FileKey of the file |

### Retrieve the layout task result
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/fetch-parse-document-layout-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| WorkspaceId | string | yes | Unique identifier of the Alibaba Cloud Model Studio workspace: https://help.aliyun.com/document_detail/2782167.html |
| TaskId | string | yes | Content to be formatted |

### Start a task to export content as a Word document
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/generate-export-word-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| AgentKey | string | yes | Unique identifier of the workspace: AgentKey |
| GeneratedContentId | integer | yes | Unique identifier of the document |

### Generate a temporary public URL
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/generate-file-url-by-key` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| AgentKey | string | yes | Unique workspace identity: https://help.aliyun.com/document_detail/2587494.html |
| FileKey | string | no | File key. Format: protocol://serverInstance/bucketPath/fileKey |
| FileName | string | no | File name |

### Asynchronously generates an image from text
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/generate-image-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| AgentKey | string | yes | The unique identifier of the workspace. For more information, see https://help.aliyun.com/document_detail/2587494.html |
| ParagraphList | string | yes | The content of the paragraphs (JSON-encoded) |
| Style | string | yes | The style |
| Size | string | yes | The size of the image to generate |
| ArticleTaskId | string | yes | The task ID of the article. If you do not have one, you can assign a universally unique identifier (UUID) |

### Generates the file upload configuration. Call this operation to obtain the upload configuration. The…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/generate-upload-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| AgentKey | string | yes | The unique identifier of the business workspace. For more information, see https://help.aliyun.com/document_detail/2587494.html |
| FileName | string | no | The name of the file |
| ParentDir | string | yes | The parent directory. Valid values: materialDocument: the material library of AMB. datasetUpload: the dataset of Miaosou. intervenes:… |

### Generates viewpoints from article snippets
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/generate-view-point` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| AgentKey | string | yes | The unique identifier of the workspace |
| ReferenceData | string | no | The context data (JSON-encoded) |

### Queries the progress of a post-processing task for a rule library. Use this operation together with the…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/get-audit-note-post-processing-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| WorkspaceId | string | yes | The unique ID of the Alibaba Cloud Model Studio workspace. For more information, see https://help.aliyun.com/document_detail/2782167.html |
| TaskId | string | yes | The task ID returned by the SubmitAuditNote operation. This is the unique identifier for the task index of the custom rule library. Save… |

### Queries the processing status of a user-uploaded rule library. You can use this operation to query the…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/get-audit-note-processing-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| WorkspaceId | string | yes | The unique identifier of the Alibaba Cloud Bailian workspace. Obtain the https://help.aliyun.com/document_detail/2782167.html |
| TaskId | string | yes | The TaskId obtained from the SubmitAuditNote operation. This is the unique identifier of the custom rule library task index. Store it… |

### Retrieves the status of a video editing task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/get-auto-clips-task-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| TaskId | string | yes | The unique ID of the task |
| WorkspaceId | string | yes | The https://help.aliyun.com/document_detail/2782167.html |
| ShowResourceInfo | string | no | Specifies whether to display video material information |
| ShowAnalysisResults | string | no | Specifies whether to display video understanding results |

### Queries the audit note information that is currently available for review. Only audit notes that can be used…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/get-available-audit-notes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| WorkspaceId | string | yes | Alibaba Cloud Bailian workspace ID. For information about how to obtain the workspace ID, see… |
| NoteId | string | no | The audit note ID. If not specified, the default value is Default |

### Retrieves the generation results of a bidding document
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/get-bidding-doc-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| WorkspaceId | string | no | https://help.aliyun.com/document_detail/2782167.html |
| TaskId | string | no | Task ID |

### Retrieve the remaining limit for the bidding feature
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/get-bidding-remain-limit-num` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| WorkspaceId | string | no | https://help.aliyun.com/document_detail/2782167.html |
| ApiName | string | no | API name |

### Retrieves the classifications from a tag mining task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/get-categories-by-task-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| WorkspaceId | string | yes | The unique ID of the Alibaba Cloud Model Studio workspace. For more information, see https://help.aliyun.com/document_detail/2782167.html |
| TaskId | string | yes | The unique ID of the task. You do not need to specify this parameter. The system automatically generates a task ID. If you specify the… |

### Retrieves the built-in resources for smart clipping
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/get-clips-build-in-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| WorkspaceId | string | no | The ID of the Alibaba Cloud Model Studio workspace |
| ResourceType | integer | no | The resource type |

### Retrieves the task result of a custom news broadcast node
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/get-custom-hot-topic-broadcast-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| WorkspaceId | string | yes | The unique identifier of the Alibaba Cloud Bailian workspace. For information about how to obtain the workspace ID, see… |
| TaskId | string | yes | The unique ID of the task. You do not need to specify TaskId by default. The system automatically generates one. If subsequent tasks use… |

### Retrieves the results of a topic analysis task for a custom data source
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/get-custom-source-topic-analysis-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| WorkspaceId | string | yes | The unique identifier of the workspace. It is the AgentKey |
| TaskId | string | yes | The unique ID of the task |

### Retrieve custom text
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/get-custom-text` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| AgentKey | string | yes | Workspace unique identifier: https://help.aliyun.com/document_detail/2587494.html |
| Id | integer | yes | Primary key ID |
| CommodityCode | string | no | Product code |

### Retrieves the task result of a custom topic perspective analysis node
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/get-custom-topic-selection-perspective-analysis-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| AgentKey | string | yes | The unique identifier of the business space. For more information, see https://help.aliyun.com/document_detail/2587494.html |
| TaskId | string | yes | The unique ID of the task. You do not need to specify TaskId by default. The system automatically generates a task ID. If subsequent tasks… |

### Retrieves the configuration information of writing sources and general search sources
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/get-data-source-order-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| AgentKey | string | yes | The unique identifier of the business workspace: https://help.aliyun.com/document_detail/2587494.html |
| ProductCode | string | yes | The configuration type. Valid values: miaobi miaosou |
| GenerateTechnology | string | no | The generation technology when productCode is set to miaosou. Valid values: copilotPrecise copilotReference |

### Retrieves the details of a data source
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/get-dataset` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| WorkspaceId | string | yes | The unique identifier of the Alibaba Cloud Bailian business workspace. For information about how to obtain the workspace ID, see… |
| DatasetName | string | no | The name of the dataset. The name must be globally unique |
| DatasetId | integer | no | The ID of the dataset. You must specify either DatasetId or DatasetName |

### Retrieves a data source document
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/get-dataset-document` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| WorkspaceId | string | yes | The unique identifier of the Alibaba Cloud Bailian workspace. For more information, see https://help.aliyun.com/document_detail/2782167.html |
| DatasetId | integer | no | The unique identifier of the dataset |
| DatasetName | string | no | The name of the dataset |
| DocUuid | string | no | The internal unique identifier of the document |
| DocId | string | no | The custom unique ID of the document |
| IncludeFields | string | no | The list of fields to include (JSON-encoded) |

### Queries deep writing tasks. You can use it to check the running status of a specific task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/get-deep-write-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| WorkspaceId | string | no | https://help.aliyun.com/document_detail/2782167.html |
| TaskId | string | no | Task ID |

### Queries the result of a deep writing task. If the task is not complete, the operation returns its current…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/get-deep-write-task-result` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| WorkspaceId | string | no | https://help.aliyun.com/document_detail/2782167.html |
| TaskId | string | no | Task ID |

### Retrieves the task result of a content aggregation node
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/get-doc-cluster-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| AgentKey | string | yes | The unique identifier of the business space: https://help.aliyun.com/document_detail/2587494.html |
| TaskId | string | yes | The unique ID of the task. By default, you do not need to specify TaskId because the system automatically generates one. If subsequent… |

### Retrieves information about a document
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/get-doc-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| WorkspaceId | string | yes | The unique identifier of the workspace in Alibaba Cloud Model Studio. For instructions on how to obtain a workspace ID, see… |
| DocId | string | yes | The document ID |
| CategoryId | string | no | The category where the document is stored |

### Retrieves the result of an enterprise Voice of the Customer (VOC) analysis task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/get-enterprise-voc-analysis-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| WorkspaceId | string | yes | The unique ID of the Alibaba Cloud Model Studio workspace. For more information, see https://help.aliyun.com/document_detail/2782167.html |
| TaskId | string | yes | The unique ID of the task. You do not need to specify this parameter. The system automatically generates a TaskId. If you specify the same… |

### Retrieves the source URL that is currently used for factuality audit
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/get-fact-audit-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| WorkspaceId | string | yes | The unique identifier of the Alibaba Cloud Model Studio workspace. Get the https://help.aliyun.com/document_detail/2782167.html |

### MiaoRead calculates the word count for a document
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/get-file-content-length` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| WorkspaceId | string | yes | The unique identifier of an Alibaba Cloud Model Studio workspace. Get your https://help.aliyun.com/document_detail/2782167.html |
| DocName | string | no | Document name |
| FileUrl | string | no | File URL |

### Queries general configurations
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/get-general-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| WorkspaceId | string | yes | The unique identifier of the Model Studio workspace. For more information, see [Get workspaceId]() |
| ConfigKey | string | yes | The unique identifier of the configuration |

### Retrieves a document to query the history of articles created in AMB
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/get-generated-content` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| AgentKey | string | yes | The unique identifier of the business space. For more information, see https://help.aliyun.com/document_detail/2587494.html |
| Id | integer | yes | The unique identifier of the document |

### Queries a news broadcast list
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/get-hot-topic-broadcast` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| WorkspaceId | string | yes | The unique identifier of the Alibaba Cloud Model Studio workspace. To obtain the https://help.aliyun.com/document_detail/2782167.html |
| HotTopicVersion | string | no | The hot topic version |
| Topics | string | no | The topic filter (JSON-encoded) |
| CalcTotalToken | string | no | Specifies whether to calculate the total number of tokens |
| Category | string | no | The category filter |
| StepForNewsBroadcastContentConfig | string | no | The content configuration for the hot topic broadcast list (JSON-encoded) |
| StepForCustomSummaryStyleConfig | string | no | The custom output style configuration (JSON-encoded) |
| Size | integer | no | The number of entries per page |
| Current | integer | no | The current page number |
| Locations | string | no | The list of news locations for keyword-based filtering (JSON-encoded) |
| LocationQuery | string | no | The full-text retrieval query for hot spot regions. When this parameter is specified, the Current parameter does not take effect |
| Query | string | no | The full-text retrieval query for titles, hot spot summaries, and regions. When this parameter is specified, the Current parameter does… |

### Retrieves the intervention global reply
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/get-intervene-global-reply` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| AgentKey | string | yes | The unique identifier of the workspace: https://help.aliyun.com/document_detail/2587494.html |

### Retrieves import task information
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/get-intervene-import-task-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| AgentKey | string | yes | The unique identifier of the workspace: https://help.aliyun.com/document_detail/2587494.html |
| TaskId | string | no | The unique identifier of the task. TaskId is not required by default. The system automatically generates one. When subsequent tasks use… |

### Retrieves the details of an intervention rule
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/get-intervene-rule-detail` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| AgentKey | string | yes | The unique identifier of the business space: https://help.aliyun.com/document_detail/2587494.html |
| RuleId | integer | no | The rule ID |

### Retrieves the download URL of the intervention import template file
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/get-intervene-template-file-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| AgentKey | string | yes | The unique identifier of the business space: https://help.aliyun.com/document_detail/2587494.html |

### Retrieves the details of a material in the material library
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/get-material-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| AgentKey | string | yes | The unique identifier of the workspace. For more information, see https://help.aliyun.com/document_detail/2587494.html |
| Id | integer | yes | The primary key ID of the task |

### Queries information about a PPT artifact
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/get-ppt-artifact` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| WorkspaceId | string | no | The workspace ID |
| PptArtifactId | integer | no | The ID of the PPT artifact |
| ExternalUserId | string | no | 第三方传入的用户ID |

### Queries the result of a PPT export task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/get-ppt-artifact-export-result` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| WorkspaceId | string | no | The workspace ID |
| ExternalUserId | string | no | The unique identifier of the user passed in from a third-party system |
| ExportTaskId | string | no | The key of the export task |

### Retrieves the PPT component configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/get-ppt-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| WorkspaceId | string | no | The https://help.aliyun.com/document_detail/2782167.html |
| ExternalUserId | string | no | The unique identifier of the user passed in from a third-party system |

### Queries the PPT task information
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/get-ppt-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| WorkspaceId | string | no | The workspace ID |
| ExternalUserId | string | no | The unique identifier of the user passed in from a third-party system |
| TaskId | string | no | The ID of the PPT task |

### Retrieves the filters for PowerPoint (PPT) templates
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/get-ppt-template-selector` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| WorkspaceId | string | no | The workspace ID |

### Retrieves configuration information, such as intelligent configuration styles and inference-related metadata…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/get-properties` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| AgentKey | string | yes | Unique identifier for the workspace: https://help.aliyun.com/document_detail/2587494.html |

### Queries the result of an automated review
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/get-smart-audit-result` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| WorkspaceId | string | no | The https://help.aliyun.com/document_detail/2782167.html |
| TaskId | string | no | The task ID |

### Queries a one-click video editing task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/get-smart-clip-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| WorkspaceId | string | yes | Unique identifier of your Alibaba Cloud Model Studio workspace. To get the workspace ID, see… |
| TaskId | string | yes | Unique identifier of the task. You do not need to specify TaskId. The system generates it automatically. If you use the same TaskId for… |

### Retrieves the analysis result of a style learning task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/get-style-learning-result` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| AgentKey | string | yes | The unique identifier of the workspace |
| Id | integer | yes | The ID of the style learning task |

### Retrieves hot event information by ID
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/get-topic-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| AgentKey | string | yes | The unique identifier of the business space: https://help.aliyun.com/document_detail/2587494.html |
| Id | string | yes | The data ID |

### Retrieves the task result of a topic perspective analysis node
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/get-topic-selection-perspective-analysis-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| AgentKey | string | yes | The unique identifier of the business space. For more information, see https://help.aliyun.com/document_detail/2587494.html |
| TaskId | string | no | The unique ID of the task. By default, you do not need to specify TaskId because the system automatically generates one. If subsequent… |

### Imports an intervention file
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/import-intervene-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| AgentKey | string | yes | Unique identifier of the workspace: https://help.aliyun.com/document_detail/2587494.html |
| DocName | string | no | Name of the uploaded file |
| FileUrl | string | no | URL of the file |
| FileKey | string | no | OSS key of the file |

### Asynchronously import an intervention file
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/import-intervene-file-async` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| AgentKey | string | yes | Unique identifier of the workspace: https://help.aliyun.com/document_detail/2587494.html |
| DocName | string | no | Name of the uploaded file |
| FileUrl | string | no | File URL |
| FileKey | string | no | OSS key of the file |

### Important: This operation involves billing charges. Review the associated costs before use. This operation…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/initiate-ppt-creation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| WorkspaceId | string | no | The unique identifier of the Alibaba Cloud Model Studio workspace. For more information about how to obtain the workspace ID, see… |
| TaskId | string | yes | The task ID |
| Outline | string | no | The outline |
| ExternalUserId | string | no | The unique identifier of the user passed in from a third-party system |

### Initializes the PPT creation operation V2
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/initiate-ppt-creation-v2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| WorkspaceId | string | no | The workspace ID |
| TaskId | string | yes | The task ID |
| ProcessType | integer | no | The process type. Valid values: - 0: Generates only a signature to initialize the frontend SDK and complete the entire production process.… |
| PptTemplateType | integer | no | The PPT templatetype. Default value: 1. Valid values: 1: System template. 2: Enterprise template |
| PptTemplateId | integer | no | The PPT template ID |
| PptTitle | string | no | The PPT title |
| Outline | string | no | The PPT outline |
| ExternalUserId | string | no | The user ID passed by a third party |
| IsMobile | string | no | Specifies whether the request is from a mobile client |

### Sets the intervention global reply
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/insert-intervene-global-reply` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| AgentKey | string | yes | The unique identifier of the business space: https://help.aliyun.com/document_detail/2587494.html |
| ReplyMessagList | string | no | The list of reply content items (JSON-encoded) |

### Inserts an intervention rule
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/insert-intervene-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| AgentKey | string | yes | The unique identifier of the business space: https://help.aliyun.com/document_detail/2587494.html |
| InterveneRuleConfig | string | no | The intervention rule configuration (JSON-encoded) |

### Retrieves a paginated list of details for an enterprise Voice of the Customer (VOC) analysis task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/list-analysis-tag-detail-by-task-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| WorkspaceId | string | yes | The unique ID of the Alibaba Cloud Model Studio workspace. For more information, see https://help.aliyun.com/document_detail/2782167.html |
| TaskId | string | yes | The unique ID of the task. This parameter is optional. The system automatically generates a task ID. If you specify the same TaskId for… |
| Categories | string | no | A list of categories for filtering (JSON-encoded) |
| NextToken | string | no | The token for the next page of results |
| MaxResults | integer | no | The maximum number of entries to return on each page |
| Size | integer | no | The number of records to request |
| Current | integer | no | The current page number |

### Retrieves a list of asynchronous tasks
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/list-async-tasks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| AgentKey | string | yes | The unique identifier of the workspace: https://help.aliyun.com/document_detail/2587494.html |
| TaskName | string | no | A term query for the task name |
| TaskCode | string | no | A term query for the task code |
| TaskType | string | no | A term query for the task type |
| TaskStatus | integer | no | A term query for the task status. Valid values: 0 (Pending), 1 (Running), 2 (Succeeded), 3 (Paused), 4 (Failed and retriable), 5 (Failed… |
| TaskStatusList | string | no | A term query for a list of task statuses. Valid values: 0 (Pending), 1 (Running), 2 (Succeeded), 3 (Paused), 4 (Failed and retriable), 5… |
| TaskTypeList | string | no | A term query for a list of task types (JSON-encoded) |
| CreateTimeStart | string | no | The start of the time range to query task creation times. Format: YYYY-MM-DD HH:mm:ss |
| CreateTimeEnd | string | no | The end of the time range to query task creation times. Format: YYYY-MM-DD HH:mm:ss |
| Current | integer | no | The current page number |
| Size | integer | no | The number of entries per page. Default value: 10 |

### Retrieves a list of audit dimensions
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/list-audit-content-error-types` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| WorkspaceId | string | no | https://help.aliyun.com/document_detail/2782167.html |
| MaxResults | integer | no | Maximum number of records |
| NextToken | string | no | Token for the next page |

### Queries the list of dictionaries
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/list-audit-terms` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| WorkspaceId | string | yes | The unique identifier of the Alibaba Cloud Model Studio workspace: obtain the https://help.aliyun.com/document_detail/2782167.html |
| NextToken | string | no | The token for the next page |
| MaxResults | integer | no | The maximum number of records to return |
| TermsName | string | no | The name of the dictionary. This parameter is optional. Default value: Default |

### Lists smart video editing tasks
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/list-auto-clips-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| WorkspaceId | string | no | Model Studio workspace |
| TaskName | string | no | Task name |
| TaskType | string | no | Task type |
| TaskStatus | integer | no | Task status |
| CreateTimeStart | string | no | The start time of the task |
| CreateTimeEnd | string | no | The task end time |
| Current | integer | no | Page number |
| Size | integer | no | Number of items per page. Default is 10 |
| Skip | integer | no | Deprecated |
| MaxResults | integer | no | Deprecated |
| NextToken | string | no | Deprecated |

### Retrieves a list of bid writing tasks
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/list-bidding-doc` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| WorkspaceId | string | no | The https://help.aliyun.com/document_detail/2782167.html |
| TaskName | string | no | The task name definition |
| TaskStatus | integer | no | The task status |
| CreateTimeStart | string | no | The start creation time in timestamp format |
| CreateTimeEnd | string | no | The end creation time in timestamp format |
| Current | integer | no | The current page number |
| Size | integer | no | The number of entries per page. Default value: 10 |
| Skip | integer | no | Deprecated |
| MaxResults | integer | no | Deprecated |
| NextToken | string | no | Deprecated |

### Retrieves system custom presets used for article creation, which are the built-in options in direct…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/list-build-configs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| AgentKey | string | yes | The unique identifier of the business space: https://help.aliyun.com/document_detail/2587494.html |
| Type | string | no | The government and media category. Valid values: media: media government: government |
| RegionId | string | no | The region ID. Only cn-beijing (China North 2, Beijing) is supported |

### Retrieve a list of custom texts
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/list-custom-text` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| AgentKey | string | yes | Unique identifier of the workspace. For more information, see https://help.aliyun.com/document_detail/2587494.html |
| CommodityCode | string | no | Commodity code |

### Queries a list of custom viewpoints
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/list-custom-view-points` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| AgentKey | string | yes | The unique identifier of the business space: https://help.aliyun.com/document_detail/2587494.html |
| Topic | string | no | The trending topic |
| Attitude | string | no | The attitude to filter by |
| Attitudes | string | no | The list of attitudes to filter by (JSON-encoded) |
| CustomViewPointId | string | no | The ID of the custom viewpoint |
| CustomViewPointIds | string | no | The list of custom viewpoint IDs (JSON-encoded) |
| TopicId | string | no | The ID of the topic |
| NextToken | string | no | The token for the next page |
| MaxResults | integer | no | The maximum number of results to return |

### Lists permissions for datasets
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/list-data-permissions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| WorkspaceId | string | yes | The unique identifier of the Bailian workspace. For information about how to obtain the workspace ID, see… |
| DataType | string | no | The data type. Valid values: dataset: dataset |
| DataId | string | no | The unique identifier of the data permission data. dataset: SystemSearch.QuarkCommonNews |
| PageSize | integer | no | The number of entries per page |
| PageNumber | integer | no | The current page number. Default value: 1 |

### Queries the list of data source documents
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/list-dataset-documents` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| WorkspaceId | string | yes | The unique identifier of the Alibaba Cloud Bailian business workspace. For more information, see… |
| Query | string | no | The search condition |
| DatasetId | integer | no | The unique identifier of the dataset. You must specify either DatasetName or DatasetId |
| DatasetName | string | no | The name of the dataset |
| Status | integer | no | The document status. Valid values: 1: Creation completed. 2: Text index build completed. 3: Multimodal index build completed. 100: Full… |
| DocType | string | no | The document type. Valid values: plainText: plain text richText: rich text text: text file pdf word image video |
| DatasetDescription | string | no | Deprecated |
| IncludeFields | string | no | The fields to include (JSON-encoded) |
| ExcludeFields | string | no | The fields to exclude. Valid values: content: body text (JSON-encoded) |
| PageNumber | integer | no | The current page number |
| PageSize | integer | no | The number of entries per page. Default value: 10 |
| CategoryUuids | string | no | The unique identifier of the category (JSON-encoded) |
| Tags | string | no | The tags (JSON-encoded) |
| Extend1 | string | no | The custom extension field |
| Extend2 | string | no | The custom extension field |
| Extend3 | string | no | The custom extension field |
| CreateTimeStart | integer | no | The start time for creation, in timestamp format |
| CreateTimeEnd | integer | no | The end time for creation, in timestamp format |
| DocUuids | string | no | The unique identifier of the document (JSON-encoded) |
| DocIds | string | no | The array of document IDs (JSON-encoded) |
| StartTime | integer | no | The start time, in milliseconds |
| EndTime | integer | no | The end time, in milliseconds |
| Title | string | no | The title |
| NextToken | string | no | The unique identifier of the next page. This parameter is required when you query data beyond the 10,000th entry |

### Queries data source management information
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/list-datasets` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| WorkspaceId | string | yes | The unique identifier of the Alibaba Cloud Bailian workspace: https://help.aliyun.com/document_detail/2782167.html |
| StartTime | string | no | The start of the creation time range |
| EndTime | string | no | The end of the creation time range |
| DatasetName | string | no | The dataset name, which is globally unique |
| DatasetId | integer | no | The dataset ID |
| PageSize | string | no | The number of entries to return per page |
| PageNumber | integer | no | The current page number. Default value: 1 |
| DatasetType | string | no | The dataset type |
| SearchDatasetEnable | integer | no | Specifies whether dataset search is enabled |
| IncludeConfig | string | no | Specifies whether to return configuration and usage information. By default, this information is not returned |
| DatasetDescription | string | no | The dataset description |

### Retrieves the history records for online inference scenarios
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/list-dialogues` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| AgentKey | string | yes | The unique identifier of the business space: https://help.aliyun.com/document_detail/2587494.html |
| TaskId | string | no | The unique identifier of the task. You do not need to specify TaskId by default. The system automatically generates a TaskId. If… |
| StartTime | string | no | The start time in the format of YYYY-MM-DD HH:mm:ss |
| EndTime | string | no | The end time in the format of YYYY-MM-DD HH:mm:ss |
| DialogueType | integer | no | The generation type. Valid values: 1: creation. 2: smart search (default) |
| Current | integer | no | The current page number |
| Size | integer | no | The number of entries per page. Default value: 10 |

### Retrieves the document list from MiaoRead
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/list-docs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| WorkspaceId | string | yes | The ID of the Alibaba Cloud Bailian business workspace. For information about how to obtain the workspace ID, see… |
| DocName | string | no | The document name |
| DocType | string | no | The document type |
| Skip | integer | no | The number of records to skip. This parameter is used for paging |
| MaxResults | integer | no | The maximum number of results to return |
| NextToken | string | no | The pagination token for the next page |
| Statuses | string | no | The list of document statuses (JSON-encoded) |
| CategoryId | string | no | The folder where the document is located |

### Searches the government document library based on complex conditions
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/list-document-retrieve` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aimiaobi.cn-beijing.aliyuncs.com |
| WorkspaceId | string | yes | The unique identifier of the Bailian workspace. For more information, see https://help.aliyun.com/document_detail/2782167.html |
| MaxResults | integer | no | The maximum number of results to return |
| NextToken | string | no | The token for the next page |
| Query | string | no | The search query |
| ContentType | string | no | The content type. Valid values: 0 (null): All. This is the default value. 1: Official document. 2: Important article. 5: Policy… |
| SubContentType | string | no | The secondary content type classification. Valid values depend on the content type: When ContentType is 8 (General Secretary): 1: Updates.… |
| Region | string | no | The region. Enter a province or city name directly, such as Jilin Province or Beijing |
| Source | string | no | The source. Valid values: 0: Internal (own organization). 1: External (other organization) |
| StartDate | string | no | The start date of document issuance, in the format of yyyy-MM-dd |
| EndDate | string | no | The end date of document issuance, in the format of yyyy-MM-dd |
| Office | string | no | The issuing authority |
| WordSize | string | no | The document reference number |
| ElementScope | string | no | The search scope. Valid values: 1: Title only. 0: Full text (title and content). This is the default value |
| SubjectClassify | string | no | The following classifications are supported: / Primary category / Secondary category / / ---- / ---- / / National Defense and Exchange… |

…and 100 more. See the OpenAPI spec.

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:aliyun-aimiaobi/add-audit-terms" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

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

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

### Can AI agents use the Alibaba Cloud Quan Miao 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-aimiaobi.

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