# Alibaba Cloud QuanMiaoLightApp API

> Alibaba Cloud QuanMiaoLightApp API on Apizie: 45 endpoints (Cancels multiple tasks, Queries the statuses of multiple tasks, Cancels an asynchronous task, Exports mining task details, …) 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-quanmiaolightapp/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

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

Alibaba Cloud OpenAPI for QuanMiaoLightApp (quanmiaolightapp, version 2024-08-01). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Cancels multiple tasks
`POST https://zieapi.vercel.app/v1/cloud:aliyun-quanmiaolightapp/batch-cancel-tasks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://quanmiaolightapp.cn-beijing.aliyuncs.com |
| workspaceId | string | yes | The unique identifier for the Model Studio workspace. For more information, see https://help.aliyun.com/document_detail/2782167.html |
| taskCode | string | yes | The identifier for the task type |
| taskIds | string | no | A list of task IDs. You can specify up to 10,000 IDs (JSON-encoded) |

### Queries the statuses of multiple tasks
`POST https://zieapi.vercel.app/v1/cloud:aliyun-quanmiaolightapp/batch-query-task-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://quanmiaolightapp.cn-beijing.aliyuncs.com |
| workspaceId | string | yes | The ID of the Model Studio workspace. For more information, see https://help.aliyun.com/document_detail/2782167.html |
| taskCode | string | yes | The identifier for the task type |
| taskIds | string | no | A list of task IDs. You can specify a maximum of 100 IDs (JSON-encoded) |

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

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

### Exports mining task details
`POST https://zieapi.vercel.app/v1/cloud:aliyun-quanmiaolightapp/export-analysis-tag-detail-by-task-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://quanmiaolightapp.cn-beijing.aliyuncs.com |
| workspaceId | string | yes | https://help.aliyun.com/document_detail/2782167.html |
| taskId | string | yes | Task ID |
| category | string | no | Classification filter |
| categories | string | no | Multiclass classification filter (JSON-encoded) |

### Alibaba Cloud Model Studio lightweight app — Enables in-vehicle systems and content platforms to interact…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-quanmiaolightapp/generate-broadcast-news` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://quanmiaolightapp.cn-beijing.aliyuncs.com |
| workspaceId | string | yes | https://help.aliyun.com/document_detail/2782167.html |
| prompt | string | yes | User intent |

### Generates a sample output format for Tag Mining in LightApp
`POST https://zieapi.vercel.app/v1/cloud:aliyun-quanmiaolightapp/generate-output-format` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://quanmiaolightapp.cn-beijing.aliyuncs.com |
| workspaceId | string | yes | Unique identifier of the workspace |
| businessType | string | no | Business type |
| taskDescription | string | no | Task description |
| content | string | no | Text to be analyzed |
| tags | string | yes | Tag System List (JSON-encoded) |
| extraInfo | string | no | Extra information |

### Retrieves the task result of an enterprise VOC analysis node
`GET https://zieapi.vercel.app/v1/cloud:aliyun-quanmiaolightapp/get-enterprise-voc-analysis-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://quanmiaolightapp.cn-beijing.aliyuncs.com |
| workspaceId | string | yes | The unique identifier of the Bailian business workspace. For more information, see https://help.aliyun.com/document_detail/2782167.html |
| taskId | string | no | The task ID |

### Getting essay grading results
`GET https://zieapi.vercel.app/v1/cloud:aliyun-quanmiaolightapp/get-essay-correction-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://quanmiaolightapp.cn-beijing.aliyuncs.com |
| workspaceId | string | yes | https://help.aliyun.com/document_detail/2782167.html |
| taskId | string | no | The unique identifier for the task |

### Retrieve the content of a file
`POST https://zieapi.vercel.app/v1/cloud:aliyun-quanmiaolightapp/get-file-content` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://quanmiaolightapp.cn-beijing.aliyuncs.com |
| fileKey | string | no | FileKey (unique identifier for Miaobi service files) |
| workspaceId | string | yes | Alibaba Cloud Model Studio https://help.aliyun.com/document_detail/2782167.html |

### Retrieve the result of a tag mining analysis task
`GET https://zieapi.vercel.app/v1/cloud:aliyun-quanmiaolightapp/get-tag-mining-analysis-task` (byok)

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

### Retrieves statistics on task execution
`GET https://zieapi.vercel.app/v1/cloud:aliyun-quanmiaolightapp/get-task-execution-statistics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://quanmiaolightapp.cn-beijing.aliyuncs.com |
| workspaceId | string | yes | The unique identifier of the Model Studio workspace. To obtain the workspace ID, see https://help.aliyun.com/document_detail/2782167.html |
| taskCode | string | yes | The identifier of the task type |

### Video Comprehension: Obtain basic configuration
`GET https://zieapi.vercel.app/v1/cloud:aliyun-quanmiaolightapp/get-video-analysis-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://quanmiaolightapp.cn-beijing.aliyuncs.com |
| workspaceId | string | yes | UUID of the Alibaba Cloud Model Studio workspace: https://help.aliyun.com/document_detail/2587495.html |

### Retrieves the node result of a video understanding asynchronous node in a lightweight application
`GET https://zieapi.vercel.app/v1/cloud:aliyun-quanmiaolightapp/get-video-analysis-task` (byok)

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

### Smart video segmentation: Retrieves configuration
`GET https://zieapi.vercel.app/v1/cloud:aliyun-quanmiaolightapp/get-video-detect-shot-config` (byok)

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

### Light App — Retrieve the result of an asynchronous video splitting task
`GET https://zieapi.vercel.app/v1/cloud:aliyun-quanmiaolightapp/get-video-detect-shot-task` (byok)

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

### Hot News Recommendation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-quanmiaolightapp/hot-news-recommend` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://quanmiaolightapp.cn-beijing.aliyuncs.com |
| prompt | string | no | Prompt for recommended news |
| workspaceId | string | yes | Workspace ID |

### Retrieves a detailed list of data mining analysis results
`GET https://zieapi.vercel.app/v1/cloud:aliyun-quanmiaolightapp/list-analysis-tag-detail-by-task-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://quanmiaolightapp.cn-beijing.aliyuncs.com |
| nextToken | string | no | Mark the current read position. An empty value means start from the beginning |
| maxResults | integer | no | The maximum number of data records to read in this request |
| workspaceId | string | yes | https://help.aliyun.com/document_detail/2782167.html |
| taskId | string | yes | The ID of the data mining task |

### This API retrieves the complete broadcast list (hot list) for the Alibaba Cloud Model Studio Light…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-quanmiaolightapp/list-hot-topic-summaries` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://quanmiaolightapp.cn-beijing.aliyuncs.com |
| workspaceId | string | yes | Unique identifier for the Model Studio workspace. Find it in the top-left corner of the Model Studio home page |
| category | string | no | Categorization |
| hotTopic | string | no | Hot topic |
| hotTopicVersion | string | no | Hot topic version |
| nextToken | string | no | Token for the next page |
| maxResults | integer | no | Maximum number of results returned per page. Default is 100. Maximum is 1000 |

### Analyzes the voice of the customer (VOC) for an enterprise
`POST https://zieapi.vercel.app/v1/cloud:aliyun-quanmiaolightapp/run-enterprise-voc-analysis` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://quanmiaolightapp.cn-beijing.aliyuncs.com |
| workspaceId | string | yes | The unique identifier of the Alibaba Cloud Model Studio workspace. For more information, see… |
| taskDescription | string | no | The description of the task |
| modelId | string | no | The model ID |
| extraInfo | string | no | Additional information, such as supplementary business information |
| outputFormat | string | no | The output format |
| content | string | no | The content |
| tags | string | no | The business tag system (JSON-encoded) |
| filterTags | string | no | The filter tags (JSON-encoded) |
| apiKey | string | no | The API key for Alibaba Cloud Model Studio |
| akProxy | string | no | none |
| sourceTrace | string | no | Specifies whether to enable traceability. If you enable traceability, you cannot customize the outputFormat |
| positiveFilter | string | no | 是否正向筛选（true-正向筛选，默认；false-反向筛选） |

### Assignment Grading
`POST https://zieapi.vercel.app/v1/cloud:aliyun-quanmiaolightapp/run-essay-correction` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://quanmiaolightapp.cn-beijing.aliyuncs.com |
| workspaceId | string | yes | The https://help.aliyun.com/document_detail/2782167.html ID |
| grade | string | no | The grade level |
| subject | string | no | The academic subject |
| totalScore | integer | no | The total score for the essay |
| question | string | no | The question or prompt for the essay. This parameter cannot be empty |
| answer | string | no | The student's answer or essay |
| otherReviewPoints | string | no | Additional instructions for the review |
| modelId | string | no | The ID of the model to use. If omitted, the system defaults to the Qwen 3 Homework-Enhanced model (`qwen3-32b-offline-202506171456-fb65`).… |
| dimensions | string | no | A list of custom scoring dimensions. This is only supported by the `qwen-custom-correction-v1` model (JSON-encoded) |

### Alibaba Cloud Model Studio lightweight application — Enables in-vehicle systems and content platforms to…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-quanmiaolightapp/run-hot-topic-chat` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://quanmiaolightapp.cn-beijing.aliyuncs.com |
| workspaceId | string | yes | Unique identifier of your Alibaba Cloud Model Studio workspace: https://help.aliyun.com/document_detail/2782167.html |
| modelId | string | no | Data model ID. Default: qwen-max-latest |
| modelCustomPromptTemplate | string | no | Prompt template |
| generateOptions | string | no | List of generation modes. Default: textChatGenerate (JSON-encoded) |
| taskId | string | no | Unique identifier for the conversation task. Keep this value unchanged across multiple turns |
| originalSessionId | string | no | Unique identifier for the original session. Used for retries |
| prompt | string | no | User question |
| hotTopicVersion | string | no | Hot topic version |
| category | string | no | Hot topic channel |
| hotTopics | string | no | List of hot topic names (JSON-encoded) |
| imageCount | integer | no | Number of images. Not all responses include images. Valid values: 1–3 |
| stepForBroadcastContentConfig | string | no | News broadcast content configuration. For SaaS only. PaaS users should use hotTopicVersion instead (JSON-encoded) |
| messages | string | no | Context (JSON-encoded) |

### Alibaba Cloud Model Studio lightweight application – In-vehicle/content platform news hot spot interaction –…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-quanmiaolightapp/run-hot-topic-summary` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://quanmiaolightapp.cn-beijing.aliyuncs.com |
| workspaceId | string | yes | Path parameter, workspace ID |
| hotTopicVersion | string | yes | Hot spot broadcast list version number |
| topicIds | string | yes | List of hot spot topic IDs to summarize (JSON-encoded) |
| stepForCustomSummaryStyleConfig | string | yes | Custom output style configuration (JSON-encoded) |

### Extract e-commerce retail content entities
`POST https://zieapi.vercel.app/v1/cloud:aliyun-quanmiaolightapp/run-marketing-information-extract` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://quanmiaolightapp.cn-beijing.aliyuncs.com |
| workspaceId | string | yes | Path parameter. https://help.aliyun.com/document_detail/2782167.html |
| modelId | string | no | Large Language Model (LLM) ID |
| extractType | string | no | Extraction type |
| customPrompt | string | no | Custom extraction instruction |
| sourceMaterials | string | no | The content to extract (JSON-encoded) |

### Writes promotional copy for e-commerce and retail
`POST https://zieapi.vercel.app/v1/cloud:aliyun-quanmiaolightapp/run-marketing-information-writing` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://quanmiaolightapp.cn-beijing.aliyuncs.com |
| workspaceId | string | yes | The path parameter. For more information, see https://help.aliyun.com/document_detail/2782167.html |
| modelId | string | no | The ID of the Large Language Model (LLM) |
| writingType | string | no | The writing type: generateProductTitle: Generates a product title. productTitleTranslation: Translates a product title.… |
| customPrompt | string | no | Custom writing requirements |
| sourceMaterial | string | no | Reference content for writing |
| customLimitation | string | no | Custom writing limitations |
| inputExample | string | no | A sample of custom input material for writing |
| outputExample | string | no | A sample of the custom output format for writing |
| language | string | no | The target language. This parameter is used for product title translation |
| keywords | string | no | Keywords. This parameter is used to generate product titles and summaries |
| generateCount | string | no | The number of items to generate. This parameter is used to generate product titles and summaries. Valid values: 1 to 15 |
| wordCountRange | string | no | The word count range. This parameter is used for product title translation. Format: Minimum word count-Maximum word count |
| otherRequirements | string | no | Other requirements. This parameter is used for the following three writing types: generateProductTitle, generateProductSummary, and… |
| prompt | string | no | A custom prompt. This parameter is used for controllable generation models and applies to the following writing types:… |
| extParameters | string | no | Extension parameters. This is a map structure where all parameter values are of the string type: enableThinking: Specifies whether to… |
| apiKey | string | no | The API key for integration access. For more information, see Get an API key… |

### A lightweight application for network content moderation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-quanmiaolightapp/run-network-content-audit` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://quanmiaolightapp.cn-beijing.aliyuncs.com |
| workspaceId | string | yes | The unique identifier of the Alibaba Cloud Model Studio workspace. For more information, see… |
| modelId | string | no | The model ID |
| businessType | string | no | The business type |
| taskDescription | string | no | The task description |
| content | string | yes | The text to be analyzed |
| tags | string | no | The list of tag systems (JSON-encoded) |
| extraInfo | string | no | Additional information |
| outputFormat | string | no | The output format |
| apiKey | string | no | The API key for integration. For more information, see Obtain an API key… |

### Parses essay images using OCR
`POST https://zieapi.vercel.app/v1/cloud:aliyun-quanmiaolightapp/run-ocr-parse` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://quanmiaolightapp.cn-beijing.aliyuncs.com |
| workspaceId | string | yes | https://help.aliyun.com/document_detail/2782167.html |
| url | string | no | Image URL (specify either url or fileKey) |
| fileKey | string | no | Image URL (specify either url or fileKey) |
| modelId | string | no | Model ID |

### Create long-form scripts
`POST https://zieapi.vercel.app/v1/cloud:aliyun-quanmiaolightapp/run-script-chat` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://quanmiaolightapp.cn-beijing.aliyuncs.com |
| workspaceId | string | yes | Unique identifier of your Alibaba Cloud Model Studio workspace. To get this ID, see https://help.aliyun.com/document_detail/2782167.html |
| prompt | string | yes | Script instruction from the user |
| taskId | string | no | Unique identifier for the task. Leave this field empty to let the system generate a taskId automatically. If you use the same taskId in… |

### Generates script continuations for film, television, and interactive entertainment
`POST https://zieapi.vercel.app/v1/cloud:aliyun-quanmiaolightapp/run-script-continue` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://quanmiaolightapp.cn-beijing.aliyuncs.com |
| workspaceId | string | yes | https://help.aliyun.com/document_detail/2782167.html |
| scriptTypeKeyword | string | no | Script type keywords. Provide qualitative descriptions for the script type, such as historical fantasy, sci-fi, romance, or Xuanhuan |
| scriptSummary | string | no | Script summary. Provide a brief story description for the script |
| userProvidedContent | string | yes | Preceding text description. Continue a section of novel content. Provide the preceding text |

### Scriptwriting for film, television, and interactive entertainment, including script development
`POST https://zieapi.vercel.app/v1/cloud:aliyun-quanmiaolightapp/run-script-planning` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://quanmiaolightapp.cn-beijing.aliyuncs.com |
| workspaceId | string | yes | Unique identifier for Alibaba Cloud Model Studio workspace. Get the https://help.aliyun.com/document_detail/2782167.html |
| scriptName | string | no | Natural language input for the script name |
| scriptTypeKeyword | string | no | Script type keywords. Users provide qualitative descriptions for the script type, such as alternate history, sci-fi, romance, or fantasy |
| scriptSummary | string | yes | Script synopsis. Users provide a brief story description for the script |
| scriptShotCount | integer | no | Number of script shots. Users can define the number of shot descriptions to generate within a single script, with a value range of 1 to 10 |
| dialogueInScene | string | no | Whether specific shot dialogues are needed. Default is false |
| plotConflict | string | no | Users can check whether to add plot conflicts and inversion elements to the planning content. If checked, these are automatically… |
| additionalNote | string | no | Additional notes. Users can make open-ended adjustments by describing them in natural language within the text input box, such as adding… |

### Refines the content of a playbook conversation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-quanmiaolightapp/run-script-refine` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://quanmiaolightapp.cn-beijing.aliyuncs.com |
| workspaceId | string | yes | The unique identifier of the Alibaba Cloud Model Studio workspace. For more information, see… |
| taskId | string | no | The unique identifier of the task. Specifying taskId is optional. The system generates one automatically. Tasks with the same taskId are… |

### Learns the style and format of media or retail articles
`POST https://zieapi.vercel.app/v1/cloud:aliyun-quanmiaolightapp/run-style-writing` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://quanmiaolightapp.cn-beijing.aliyuncs.com |
| workspaceId | string | yes | The https://help.aliyun.com/document_detail/2782167.html |
| learningSamples | string | no | The collection of articles to use as learning samples (JSON-encoded) |
| writingTheme | string | no | The writing theme entered by the user. You can customize the theme to adjust the output |
| styleFeature | string | no | The style feature identifier. If this parameter is specified, the operation writes content based on the specified style features |
| referenceMaterials | string | no | The collection of content material models for the large language model generation feature (JSON-encoded) |
| processStage | string | no | The processing stage. Valid values: full: Generates both feature analysis and creative content. analysisStage: Generates only feature… |
| useSearch | string | no | Specifies whether to automatically search the Internet for supplementary materials |

### Light application — tag mining
`POST https://zieapi.vercel.app/v1/cloud:aliyun-quanmiaolightapp/run-tag-mining-analysis` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://quanmiaolightapp.cn-beijing.aliyuncs.com |
| workspaceId | string | yes | https://help.aliyun.com/document_detail/2782167.html |
| modelId | string | no | Model ID |
| businessType | string | no | Business type |
| taskDescription | string | no | Task description |
| content | string | yes | Text to analyze |
| tags | string | no | Tag system list (JSON-encoded) |
| extraInfo | string | no | Additional information |
| outputFormat | string | no | Output format |
| apiKey | string | no | API key for integration. Get your API key… |

### Alibaba Cloud Model Studio Light App – Video Understanding for Film and Media
`POST https://zieapi.vercel.app/v1/cloud:aliyun-quanmiaolightapp/run-video-analysis` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://quanmiaolightapp.cn-beijing.aliyuncs.com |
| workspaceId | string | yes | Unique identifier for your Alibaba Cloud Model Studio workspace: Get your https://help.aliyun.com/document_detail/2587495.html |
| videoUrl | string | no | Video URL The videoUrl field is required unless you provide originalSessionId. Local video uploads are not supported. Provide a publicly… |
| videoModelId | string | no | Unique identifier for the video VL task model. Supported models: quanmiao-vl-turbo quanmiao-vl-plus quanmiao-vl-max-thinking… |
| videoModelCustomPromptTemplate | string | no | Video VL task prompt template: Must include the {videoAsrText} variable, which contains the video’s ASR text. Defaults to the template… |
| modelId | string | no | Unique identifier for the LLM used in video summarization. Supported models: If you want to run multiple text-processing tasks, use the… |
| modelCustomPromptTemplateId | string | no | Unique identifier for the LLM prompt template used in video summarization: PlotDetail: Detailed plot analysis (default) Summary: Content… |
| modelCustomPromptTemplate | string | no | LLM prompt template for video summarization: Must include both {videoAsrText} and {videoAnalysisText} variables. {videoAsrText} is the ASR… |
| generateOptions | string | no | Video understanding generation task options (JSON-encoded) |
| taskId | string | no | Unique task identifier. If not provided, one is generated automatically |
| originalSessionId | string | no | Source task identifier. To rerun a specific subtask (defined in generateOptions) based on a previous task, provide the original taskId and… |
| videoExtraInfo | string | no | Supplementary text related to the video. You can extend the input material and reference it in generation by adding the {videoExtraInfo}… |
| snapshotInterval | number | no | Frame sampling interval: One frame every X seconds. Range: [1, 10]. Larger intervals reduce extracted information, increase processing… |
| splitInterval | integer | no | Minimum shot segmentation interval in seconds. Range: [1, 150]. Default values are recommended based on video length |
| language | string | no | Speech recognition language: chinese: Chinese (default) french: French english: English japanese: Japanese chineseEnglishFreely: Chinese… |
| frameSampleMethod | string | no | Frame sampling method selection (JSON-encoded) |
| videoRoles | string | no | Characters (JSON-encoded) |
| textProcessTasks | string | no | List of video summarization (text processing) tasks. Maximum: 3 tasks (JSON-encoded) |
| faceIdentitySimilarityMinScore | number | no | Character recognition similarity threshold: Range (0–1) |
| videoShotFaceIdentityCount | integer | no | Number of sampled frames (images) per shot (segment) used for character matching: Range [1–5] |
| excludeGenerateOptions | string | no | Excluded generation steps: videoCaption: Video speech recognition (JSON-encoded) |
| videoCaptionInfo | string | no | Caption (ASR) information (JSON-encoded) |
| autoRoleRecognitionVideoUrl | string | no | Separate video URL for automatic recognition |
| splitType | string | no | Shot segmentation type: minDuration (enforces minimum shot length), fixDuration (segments by fixed duration). Default: minDuration |
| videoUrls | string | no | Multiple video URLs (JSON-encoded) |
| addDocumentParam | string | no | When a dataset is specified, video understanding results are uploaded to Miaosou along with the video as metadata (JSON-encoded) |

### Lightweight Application - Video Splitting\ \ To use video splitting, you must first activate the Media and…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-quanmiaolightapp/run-video-detect-shot` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://quanmiaolightapp.cn-beijing.aliyuncs.com |
| workspaceId | string | yes | Unique identifier of your Alibaba Cloud Model Studio workspace |
| videoUrl | string | yes | URL of the video file |
| modelId | string | no | Valid values: deepseek-r1 quanmiao-llm-max quanmiao-llm-max-thinking quanmiao-llm-plus quanmiao-llm-turbo |
| options | string | yes | Method used for scene detection. Valid value: ASR (JSON-encoded) |
| taskId | string | no | Unique identifier of the task |
| originalSessionId | string | no | Unique identifier of the original task. To rerun a subtask based on a previous task, pass in the previous task ID and originalSessionId.… |
| prompt | string | no | Custom prompt for the large language model |
| modelCustomPromptTemplateId | string | no | ID of the prompt template used by the large language model to generate video-splitting results |
| modelVlCustomPromptTemplateId | string | no | ID of the prompt template used for visual-language recognition |
| recognitionOptions | string | yes | Methods used to recognize content in each scene. Valid values: ASR, OCR, VL. You can select multiple options (JSON-encoded) |
| intelliSimpPromptTemplateId | string | no | ID of the prompt template used to simplify input for the large language model |
| preModelId | string | no | Valid values: deepseek-r1 quanmiao-llm-max quanmiao-llm-max-thinking quanmiao-llm-plus quanmiao-llm-turbo |
| intelliSimpPrompt | string | no | Custom prompt used to simplify input for the large language model |
| vlPrompt | string | no | Custom prompt for visual-language recognition |
| language | string | no | Speech recognition language: chinese: Chinese (default) french: French english: English japanese: Japanese chineseEnglishFreely: Chinese… |

### Submits an asynchronous analysis task for enterprise Voice of the Customer (VOC)
`POST https://zieapi.vercel.app/v1/cloud:aliyun-quanmiaolightapp/submit-enterprise-voc-analysis-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://quanmiaolightapp.cn-beijing.aliyuncs.com |
| workspaceId | string | yes | The https://help.aliyun.com/document_detail/2782167.html |
| taskDescription | string | no | The task description |
| extraInfo | string | no | Additional business information |
| outputFormat | string | no | The prompt that describes the output format. If this parameter is not specified, the output is generated in JSON format based on the task… |
| modelId | string | no | The model ID |
| tags | string | no | The content tags (JSON-encoded) |
| filterTags | string | no | The filter tags (JSON-encoded) |
| contents | string | no | The list of content to analyze. Specify one of \`url\`, \`fileKey\`, or \`contents\`. The array can contain a maximum of 200 items. To… |
| url | string | no | The URL of the content file to analyze. Specify one of \`url\`, \`fileKey\`, or \`contents\`. The file size cannot exceed 100 MB. The… |
| fileKey | string | no | The file key of the content file to analyze. Specify one of \`url\`, \`fileKey\`, or \`contents\`. The file key is a unique key that you… |
| apiKey | string | no | The Alibaba Cloud Model Studio API key |
| sourceTrace | string | no | Specifies whether to enable traceability. If you enable traceability, you cannot customize the output format |
| batchTask | string | no | Specifies whether to use the model's BATCH API. This reduces the cost by half and processes the task within 24 hours. (The BATCH API is… |
| positiveFilter | string | no | Specifies whether to perform positive filtering. \`true\`: positive filtering (default). \`false\`: negative filtering |

### Submit an essay for correction
`POST https://zieapi.vercel.app/v1/cloud:aliyun-quanmiaolightapp/submit-essay-correction-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://quanmiaolightapp.cn-beijing.aliyuncs.com |
| workspaceId | string | yes | https://help.aliyun.com/document_detail/2782167.html |
| tasks | string | no | A list of correction tasks (JSON-encoded) |
| grade | string | no | A default grade to apply to all tasks. If a `grade` is also specified within an individual task, the task-level value takes precedence |
| subject | string | no | A default subject to apply to all tasks. If a `subject` is also specified within an individual task, the task-level value takes precedence |
| totalScore | integer | no | A default total score to apply to all tasks. If a `totalScore` is also specified within an individual task, the task-level value takes… |
| question | string | no | A default essay topic to apply to all tasks. If a `question` is also specified within an individual task, the task-level value takes… |
| otherReviewPoints | string | no | Default additional review criteria to apply to all tasks. If `otherReviewPoints` is also specified within an individual task, the… |
| modelId | string | no | The ID of the model to use for correction. The following models are available: ```json [ { "ModelName": "Custom Correction Model",… |
| dimensions | string | no | A list of custom scoring dimensions. This parameter is supported only by the `qwen-custom-correction-v1` model (JSON-encoded) |

### Submits a tag mining analysis task for the lightweight application
`POST https://zieapi.vercel.app/v1/cloud:aliyun-quanmiaolightapp/submit-tag-mining-analysis-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://quanmiaolightapp.cn-beijing.aliyuncs.com |
| workspaceId | string | yes | The unique identifier of the Alibaba Cloud Bailian business workspace. For more information, see… |
| modelId | string | no | The model ID |
| businessType | string | no | The business type |
| taskDescription | string | no | The task description |
| tags | string | no | The list of tag systems (JSON-encoded) |
| extraInfo | string | no | The extra information |
| outputFormat | string | no | The output format |
| url | string | no | The URL of the content file to be analyzed. Each content entry is separated by a line break. Specify either contents or url |
| contents | string | no | The list of content to be analyzed. Specify either contents or url (JSON-encoded) |
| apiKey | string | no | The Alibaba Cloud Bailian API key |
| batchTask | string | no | Specifies whether to use the model's Batch API. Costs are reduced by half, and results are returned within 24 hours. Models that support… |

### Alibaba Cloud Model Studio mini app: Submit an offline asynchronous task for video understanding
`POST https://zieapi.vercel.app/v1/cloud:aliyun-quanmiaolightapp/submit-video-analysis-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://quanmiaolightapp.cn-beijing.aliyuncs.com |
| workspaceId | string | yes | The workspace ID in Alibaba Cloud Model Studio. https://help.aliyun.com/document_detail/2782167.html |
| videoUrl | string | no | The video URL |
| videoModelId | string | no | The unique identifier for the model used in the video vision-language (VL) task. Supported models: `quanmiao-vl-turbo` `quanmiao-vl-plus`… |
| videoModelCustomPromptTemplate | string | no | The prompt template for the video vision-language (VL) task. This template must include the `{videoAsrText}` variable, which represents… |
| modelId | string | no | The unique identifier for the large model used for video summarization (text processing). To run multiple text processing tasks, use the… |
| modelCustomPromptTemplateId | string | no | The ID of the prompt template for video summarization. Valid values: `PlotDetail`: Detailed plot analysis (default). `Summary`: Content… |
| modelCustomPromptTemplate | string | no | A custom prompt template for the large model used for video summarization. The template must include both the `{videoAsrText}` and… |
| generateOptions | string | no | The video understanding tasks to perform (JSON-encoded) |
| videoExtraInfo | string | no | Supplementary text about the video, such as a summary, description, or ASR transcript. To use this text, you must include the… |
| snapshotInterval | number | no | The frame sampling interval, in seconds. The value must be between 1 and 10, inclusive. A larger interval means fewer frames are… |
| splitInterval | integer | no | The minimum shot split interval, in seconds. The value must be an integer between 1 and 150, inclusive. If not specified, the system… |
| language | string | no | The language of the video. Valid values: `chinese`: Chinese (default) `french`: French `english`: English `japanese`: Japanese… |
| frameSampleMethod | string | no | The frame sampling method (JSON-encoded) |
| videoRoles | string | no | A list of characters to recognize in the video (JSON-encoded) |
| textProcessTasks | string | no | A list of video summarization (text processing) tasks. You can specify up to three tasks (JSON-encoded) |
| faceIdentitySimilarityMinScore | number | no | The similarity threshold for character recognition. The value must be between 0 and 1, inclusive |
| videoShotFaceIdentityCount | integer | no | The number of frames (images) per shot to be used for character matching. The value must be an integer between 1 and 5, inclusive |
| deduplicationId | string | no | A custom unique identifier for request deduplication. The system rejects requests that have the same `deduplicationId` as a request… |
| excludeGenerateOptions | string | no | Steps to exclude from the generation process. `videoCaption`: Video speech recognition (ASR) (JSON-encoded) |
| videoCaptionInfo | string | no | Information about the captions (ASR) (JSON-encoded) |
| autoRoleRecognitionVideoUrl | string | no | A separate video URL to use for automatic character recognition |
| splitType | string | no | The shot split method. Valid values are `minDuration` (ensures each shot meets a minimum duration) and `fixDuration` (splits the video… |
| addDocumentParam | string | no | Parameters for uploading the video and its analysis results as metadata to a Miaosou dataset (JSON-encoded) |
| videoUrls | string | no | A list of video URLs. The videos are concatenated and processed as a single video. This feature is suitable for short video clips… |

### Lightweight Application: Asynchronous Video Splitting Task\ To use the free video splitting feature, you…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-quanmiaolightapp/submit-video-detect-shot-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://quanmiaolightapp.cn-beijing.aliyuncs.com |
| workspaceId | string | yes | Unique identifier for the Model Studio workspace. https://help.aliyun.com/document_detail/2782167.html |
| videoUrl | string | yes | URL of the video |
| modelId | string | no | Large language model (LLM). We recommend deepseek-r1. Options: deepseek-r1 quanmiao-llm-max quanmiao-llm-max-thinking quanmiao-llm-plus… |
| options | string | no | Select how to perform shot detection. Options: ASR (JSON-encoded) |
| deduplicationId | string | no | Deduplication field. Define your unique business identifier as needed. For values that repeat in this field, the system prevents duplicate… |
| prompt | string | no | User-defined prompt for the LLM |
| taskId | string | no | Unique task identifier |
| originalSessionId | string | no | Unique identifier for the source task. To rerun a subtask (defined by the generateOptions field) based on a previous task, pass the… |
| modelCustomPromptTemplateId | string | no | ID of the prompt used by the LLM to generate video splitting results |
| modelVlCustomPromptTemplateId | string | no | ID of the prompt used for VL detection |
| recognitionOptions | string | no | Select how to detect content for each shot. Options: ASR, OCR, VL. You can select multiple (JSON-encoded) |
| intelliSimpPromptTemplateId | string | no | Prompt ID used to pre-simplify input for the large language model (LLM) |
| preModelId | string | no | Model to run intelliSimpPrompt. We recommend quanmiao-llm-max. Options: deepseek-r1 quanmiao-llm-max quanmiao-llm-max-thinking… |
| intelliSimpPrompt | string | no | User-defined prompt to simplify input data for the LLM |
| vlPrompt | string | no | User-defined prompt for the VL model |
| language | string | no | Speech recognition language: chinese: Chinese (default) french: French english: English japanese: Japanese chineseEnglishFreely: Chinese… |

### Video Comprehension - Update Configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-quanmiaolightapp/update-video-analysis-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://quanmiaolightapp.cn-beijing.aliyuncs.com |
| workspaceId | string | yes | UUID of the Alibaba Cloud Model Studio workspace: https://help.aliyun.com/document_detail/2587495.html |
| asyncConcurrency | integer | yes | Video Comprehension - Offline job concurrency, with a valid range of [2, 30] |

### Video Understanding - Modify Job Status: Currently, only job cancellation is supported
`POST https://zieapi.vercel.app/v1/cloud:aliyun-quanmiaolightapp/update-video-analysis-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://quanmiaolightapp.cn-beijing.aliyuncs.com |
| workspaceId | string | yes | The UUID of the Model Studio workspace: https://help.aliyun.com/document_detail/2587495.html |
| taskId | string | yes | UUID of the job |
| taskStatus | string | yes | Task Status: CANCELED: Cancel the job |

### Video Understanding – Batch Cancel Tasks
`POST https://zieapi.vercel.app/v1/cloud:aliyun-quanmiaolightapp/update-video-analysis-tasks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://quanmiaolightapp.cn-beijing.aliyuncs.com |
| workspaceId | string | yes | Unique identifier for the Model Studio workspace: For more information, see https://help.aliyun.com/document_detail/2782167.html |
| taskIds | string | yes | List of task IDs (JSON-encoded) |
| taskStatus | string | yes | Task status: CANCELED: Cancel task |

### Update the configuration for smart video segmentation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-quanmiaolightapp/update-video-detect-shot-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://quanmiaolightapp.cn-beijing.aliyuncs.com |
| workspaceId | string | yes | Unique identifier of your Alibaba Cloud Model Studio workspace: https://help.aliyun.com/document_detail/2782167.html |
| asyncConcurrency | integer | yes | Maximum number of concurrent offline tasks for video understanding. Valid values: 2 to 10 |

### Updates the status of an asynchronous task for smart video segmentation. The only supported update is to…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-quanmiaolightapp/update-video-detect-shot-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://quanmiaolightapp.cn-beijing.aliyuncs.com |
| workspaceId | string | yes | Alibaba Cloud Model Studio workspace ID. https://help.aliyun.com/document_detail/2782167.html |
| taskId | string | yes | Task ID |
| taskStatus | string | yes | Task status: CANCELED: Cancel the task |

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

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

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:aliyun-quanmiaolightapp/batch-cancel-tasks" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

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

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

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

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