# Alibaba Cloud Intelligent Media Management API

> Alibaba Cloud Intelligent Media Management API on Apizie: 105 endpoints (Adds mosaics, Gaussian blurs, or solid color shapes to blur one or more areas of an image for privacy…, Adds objects to a story, Binds an Object Storage Service (OSS) bucket to the specified project. The binding enables you to use IMM…, Deletes the metadata of multiple files from a dataset, …) 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://apizie.tech/v1/cloud:aliyun-imm/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-imm`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/imm
- Page: https://apizie.tech/api/cloud/aliyun-imm
- OpenAPI: https://apizie.tech/api/cloud/aliyun-imm/openapi.json

Alibaba Cloud OpenAPI for Intelligent Media Management (imm, version 2020-09-30). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Adds mosaics, Gaussian blurs, or solid color shapes to blur one or more areas of an image for privacy…
`POST https://apizie.tech/v1/cloud:aliyun-imm/add-image-mosaic` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The name of the project.[](~~478153~~) |
| SourceURI | string | yes | The OSS URI of the input image. Specify the OSS URI in the oss://${Bucket}/${Object} format, where `${Bucket}` is the name of the bucket… |
| TargetURI | string | yes | The OSS URI of the output image. Specify the OSS URI in the oss://${Bucket}/${Object} format, where `${Bucket}` is the name of the bucket… |
| ImageFormat | string | no | The encoding of the output image. By default, the output image uses the same encoding as the input image. Valid values: jpg, png, and webp |
| Quality | integer | no | The quality of the output image. This parameter applies only to JPG and WebP images. Valid values: 0 to 100. Default value: 80 |
| Targets | string | yes | The bounding boxes and processing parameters (JSON-encoded) |
| CredentialConfig | string | no | If you do not have special requirements, leave this parameter empty. The authorization chain settings. For more information, see… |

### Adds objects to a story
`POST https://apizie.tech/v1/cloud:aliyun-imm/add-story-files` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The name of the project |
| DatasetName | string | yes | The name of the dataset |
| ObjectId | string | yes | The ID of the story |
| Files | string | yes | The objects that you want to add (JSON-encoded) |

### Binds an Object Storage Service (OSS) bucket to the specified project. The binding enables you to use IMM…
`POST https://apizie.tech/v1/cloud:aliyun-imm/attach-ossbucket` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The name of the project. For information about how to create a project, see https://help.aliyun.com/document_detail/478153.html |
| OSSBucket | string | yes | The name of the OSS bucket in the same region as the project |
| Description | string | no | The description of the binding. The description must be 1 to 128 characters in length. By default, no description is applied |

### Deletes the metadata of multiple files from a dataset
`POST https://apizie.tech/v1/cloud:aliyun-imm/batch-delete-file-meta` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The name of the project. You can obtain the name of the project from the response of the… |
| DatasetName | string | yes | The name of the dataset. You can obtain the name of the dataset from the response of the… |
| URIs | string | yes | The URIs of the OSS buckets in which the files whose metadata you want to delete are stored. You can specify up to 100 URIs (JSON-encoded) |

### Retrieves person clusters and their information in batches
`POST https://apizie.tech/v1/cloud:aliyun-imm/batch-get-figure-cluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The name of the project |
| DatasetName | string | yes | The name of the dataset |
| ObjectIds | string | yes | The array of group object IDs (JSON-encoded) |

### Retrieves the metadata of multiple indexed files in a dataset
`POST https://apizie.tech/v1/cloud:aliyun-imm/batch-get-file-meta` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The name of the project. For more information about how to obtain the project name, refer to… |
| DatasetName | string | yes | The name of the dataset. For more information about how to obtain the dataset name, refer to… |
| URIs | string | yes | The list of file URIs. A maximum of 100 URIs are supported (JSON-encoded) |
| WithFields | string | no | The list of fields to be returned. If you specify this parameter, only the values of the specified fields are returned, instead of all… |

### This operation performs a batch index of object metadata by processing input files for tasks such as label…
`POST https://apizie.tech/v1/cloud:aliyun-imm/batch-index-file-meta` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The project name. For more information about how to obtain the project name, see https://help.aliyun.com/document_detail/478153.html |
| DatasetName | string | yes | The dataset name. For more information about how to obtain the dataset name, see https://help.aliyun.com/document_detail/478160.html |
| Files | string | yes | A list of OSS files. This is an array in JSON format that can contain up to 100 files (JSON-encoded) |
| UserData | string | no | Custom user data. This parameter takes effect only when you specify an MNS configuration for the Notification parameter. The data is… |
| Notification | string | no | The notification configuration. For more information, click Notification. For the format of asynchronous notification messages, see the… |

### Updates some metadata items of files indexed into a dataset
`POST https://apizie.tech/v1/cloud:aliyun-imm/batch-update-file-meta` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The name of the project.[](~~478153~~) |
| DatasetName | string | yes | The name of the dataset.[](~~478160~~) |
| Files | string | yes | The files whose metadata you want to update (JSON-encoded) |

### Compares the similarity of the largest faces in two images. The largest face refers to the largest face…
`POST https://apizie.tech/v1/cloud:aliyun-imm/compare-image-faces` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The name of the project. For more information, see https://help.aliyun.com/document_detail/478153.html |
| CredentialConfig | string | no | If you have no special requirements, leave this parameter empty. The authorization chain settings. For more information, see… |
| Source | string | no | The URLs of the two images for compression (JSON-encoded) |

### Phase II of AI Assistant, Q\&A API
`POST https://apizie.tech/v1/cloud:aliyun-imm/contextual-answer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | Project name. For how to obtain it, see Creating a Project… |
| Messages | string | yes | Yes, the history of conversations and tool invocations. The latest message is at the end (index n-1), and the oldest message is at the… |
| Files | string | no | The content of the files involved in the current Q&A. It is recommended to use the return value of the ContextualRetrieval interface as… |

### Retrieves semantically similar documents for multi-turn conversation scenarios by processing message inputs…
`POST https://apizie.tech/v1/cloud:aliyun-imm/contextual-retrieval` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The name of the project. For more information about how to obtain the project name, see Create a project… |
| DatasetName | string | yes | The dataset used for retrieval |
| Messages | string | yes | The conversation history and tool calling history. The latest message is at the end (index n-1), and the oldest message is at the… |
| RecallOnly | string | no | Specifies whether to enable only the recall process (embedding search). If this parameter is set to true, the returned data is not… |
| SmartClusterIds | string | no | The list of smart cluster IDs, which are used to retrieve files within specific smart clusters (JSON-encoded) |

### Creates a task to inspect a compressed file and retrieve a list of its contents without decompressing the file
`POST https://apizie.tech/v1/cloud:aliyun-imm/create-archive-file-inspection-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The project name. For more information, see https://help.aliyun.com/document_detail/478153.html |
| CredentialConfig | string | no | Leave this parameter empty if you do not have special requirements. The configuration for chained authorization. This parameter is not… |
| Password | string | no | The password of the compressed file. If the file is encrypted, provide the password to inspect its contents |
| UserData | string | no | Custom information that is returned in the asynchronous notification message. You can use this information to associate the notification… |
| SourceURI | string | no | The location of the compressed file. The Object Storage Service (OSS) URI must be in the oss\://${Bucket}/${Object} format. In this… |
| Notification | string | no | The notification configuration. For more information, see Notification. For the format of asynchronous notification messages, see… |

### Creates a batch processing task that performs specified operations, such as transcoding and format…
`POST https://apizie.tech/v1/cloud:aliyun-imm/create-batch` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The project name. For more information, see https://help.aliyun.com/document_detail/478153.html |
| Input | string | yes | The input data source configuration (JSON-encoded) |
| Actions | string | yes | A list of processing templates (JSON-encoded) |
| Notification | string | no | The notification recipient. Multiple middleware services are supported. For details about the message format, see Asynchronous… |
| Tags | string | no | Custom tags used to search and filter asynchronous tasks (JSON-encoded) |
| ServiceRole | string | yes | The service role that grants IMM the permissions to access other cloud resources, such as OSS. The default value is… |

### Attaches a dataset to an Object Storage Service (OSS) bucket for automatic synchronization and indexing of…
`POST https://apizie.tech/v1/cloud:aliyun-imm/create-binding` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The name of the project. For more information about how to obtain the project name, see https://help.aliyun.com/document_detail/478153.html |
| DatasetName | string | no | The name of the dataset. For more information about how to obtain the dataset name, see https://help.aliyun.com/document_detail/478160.html |
| URI | string | yes | The URI of the OSS bucket bound to the dataset. The URI of the OSS bucket is in the format of oss://${Bucket}, where `${Bucket}` is the… |

### Compresses point cloud data stored in Object Storage Service (OSS) to reduce network data transmission
`POST https://apizie.tech/v1/cloud:aliyun-imm/create-compress-point-cloud-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The project name. For information about how to obtain the project name, see https://help.aliyun.com/document_detail/478153.html |
| SourceURI | string | yes | The OSS URI of the point cloud file. The OSS URI follows the format oss://${Bucket}/${Object}, where `${Bucket}` is the name of an OSS… |
| TargetURI | string | yes | The OSS URI of the compressed output file. The OSS URI follows the format oss://${Bucket}/${Object}, where `${Bucket}` is the name of an… |
| PointCloudFileFormat | string | no | The point cloud file format. Only PCD format is supported. Default value: pcd |
| CompressMethod | string | yes | The compression algorithm. Valid values: octree: octree kdtree: K-d tree |
| PointCloudFields | string | yes | The PCD attribute fields that participate in compression and the compression order. After compression, data is decompressed in this order.… |
| KdtreeOption | string | no | The K-d tree compression parameters (JSON-encoded) |
| OctreeOption | string | no | The octree compression parameters (JSON-encoded) |
| UserData | string | no | The custom information, which is returned in asynchronous message notifications to help you associate message notifications within your… |
| Tags | string | no | The custom tags that are used to search for and filter asynchronous tasks (JSON-encoded) |
| CredentialConfig | string | no | Leave this parameter empty unless you have special requirements. The China authorization configuration. This parameter is optional. For… |
| Notification | string | no | The message notification configuration. For more information, click Notification. For information about the format of asynchronous… |

### Creates a story based on the specified images and videos
`POST https://apizie.tech/v1/cloud:aliyun-imm/create-customized-story` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The name of the project.[](~~478153~~) |
| DatasetName | string | yes | The name of the dataset.[](~~478160~~) |
| StoryType | string | yes | The type of the story. For information about valid types, see https://help.aliyun.com/document_detail/2743998.html |
| StorySubType | string | yes | The subtype of the story. For information about valid subtypes, see https://help.aliyun.com/document_detail/2743998.html |
| StoryName | string | yes | The name of the story |
| Cover | string | yes | The cover image of the story. You can specify an image as the cover image of the custom story (JSON-encoded) |
| Files | string | yes | The files of the story. You can specify up to 100 files in a custom story (JSON-encoded) |
| CustomLabels | string | no | The custom labels. You can specify labels to help you identify and retrieve the story (JSON-encoded) |

### Creates a dataset
`POST https://apizie.tech/v1/cloud:aliyun-imm/create-dataset` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The name of the project. For more information about how to obtain the project name, see https://help.aliyun.com/document_detail/478153.html |
| DatasetName | string | yes | The name of the dataset. The name must be unique within a project. The name must meet the following requirements: The name must be 1 to… |
| Description | string | no | The description of the dataset. The description must be 1 to 256 characters in length. Default value: empty |
| TemplateId | string | no | The ID of the workflow template. For more information, see https://help.aliyun.com/document_detail/466304.html. Default value: empty |
| DatasetMaxBindCount | integer | no | The maximum number of bindings per dataset. Valid values: 1 to 10. Default value: 10 |
| DatasetMaxFileCount | integer | no | The maximum number of files per dataset. Valid values: 1 to 100000000. Default value: 100000000 |
| DatasetMaxEntityCount | integer | no | The maximum number of metadata entities per dataset. Default value: 10000000000 |
| DatasetMaxRelationCount | integer | no | The maximum number of metadata relations per dataset. Default value: 100000000000 |
| DatasetMaxTotalFileSize | integer | no | The maximum total size of files per dataset. If the limit is exceeded, no more indexes can be added. Default value: 90000000000000000.… |
| WorkflowParameters | string | no | Invalid parameter (JSON-encoded) |

### Extracts a blind watermark
`POST https://apizie.tech/v1/cloud:aliyun-imm/create-decode-blind-watermark-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The project name. For information about how to obtain the project name, see https://help.aliyun.com/document_detail/478153.html. The… |
| SourceURI | string | yes | The Object Storage Service (OSS) URI of the image. The OSS URI must be in the `oss:// / ` format. ` ` is the name of the OSS bucket that… |
| StrengthLevel | string | no | The watermark extraction level, which controls the extraction precision. A higher level indicates a longer processing time and a better… |
| WatermarkType | string | no | The type of the embedded watermark. Valid value: text (Image watermarks are not supported. Therefore, this parameter can only be set to… |
| TargetURI | string | no | A parameter from the earlier DecodeBlindWatermark API. It specifies the OSS URI where the image is saved after the blind watermark is… |
| ImageQuality | integer | no | A parameter from the earlier DecodeBlindWatermark API. It specifies the quality of the output image. The default value is 90. The value… |
| Model | string | no | A parameter from the earlier DecodeBlindWatermark API. It specifies the watermark algorithm model. Valid values include FFT, FFT_FULL,… |
| OriginalImageURI | string | no | A parameter from the earlier DecodeBlindWatermark API. It specifies the OSS URI of the image before the blind watermark was added. This… |
| Notification | string | no | The notification configuration. For more information, click Notification. For the format of asynchronous notification messages, see… |

### Searches a media set for the top N images most similar to a specified image or face ID. The operation…
`POST https://apizie.tech/v1/cloud:aliyun-imm/create-faces-searching-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The name of the project. For more information, see https://help.aliyun.com/document_detail/478153.html |
| DatasetName | string | yes | The name of the dataset. For more information, see https://help.aliyun.com/document_detail/478160.html |
| UserData | string | no | Custom user information. This information is returned in the asynchronous notification message to help you associate the message with your… |
| Sources | string | no | A list of images (JSON-encoded) |
| MaxResult | integer | no | The number of most similar faces to return. Valid values: 0 to 100. Default value: 5 |
| Notification | string | no | The notification configuration. For more information about the format of asynchronous notification messages, see… |

### Creates a figure clustering task. This task uses an intelligent algorithm to group the faces of different…
`POST https://apizie.tech/v1/cloud:aliyun-imm/create-figure-clustering-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The project name. For more information, see https://help.aliyun.com/document_detail/478153.html |
| DatasetName | string | yes | The dataset name. For more information, see https://help.aliyun.com/document_detail/478160.html |
| UserData | string | no | Custom user data that is returned in the asynchronous notification message. You can use this data to associate the notification message… |
| Tags | string | no | Custom tags that you can use to search for and filter asynchronous tasks (JSON-encoded) |
| Notification | string | no | The notification configuration. For more information, see Notification. For more information about the message format, see… |

### Merges two or more figure clustering groups into a single figure clustering group
`POST https://apizie.tech/v1/cloud:aliyun-imm/create-figure-clusters-merging-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The name of the project. For more information, see https://help.aliyun.com/document_detail/478153.html |
| DatasetName | string | yes | The name of the dataset. For more information, see https://help.aliyun.com/document_detail/478160.html |
| From | string | no | The ID of the source clustering group. You must specify a value for either \`From\` or \`Froms\`. You cannot specify values for both… |
| To | string | yes | The ID of the destination clustering group |
| UserData | string | no | The custom information. This information is returned in the asynchronous notification message to help you associate the message with your… |
| Tags | string | no | The custom tags. You can use custom tags to search for and filter asynchronous tasks (JSON-encoded) |
| Froms | string | no | A list of the IDs of the source clustering groups. You must specify a value for either \`From\` or \`Froms\`. You cannot specify values… |
| Notification | string | no | The configuration of the notification message. For more information, click Notification. For more information about the format of an… |

### Package Download API
`POST https://apizie.tech/v1/cloud:aliyun-imm/create-file-compression-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The name of the project. For more information, see https://help.aliyun.com/document_detail/478153.html |
| Sources | string | no | A list of files to package and their packaging rules. Specify either this parameter or \`SourceManifestURI\`. \`Sources\` supports a… |
| CredentialConfig | string | no | If you do not have special requirements, leave this parameter empty. The chained authorization configuration. This parameter is not… |
| SourceManifestURI | string | no | The address where the file manifest is stored. The file manifest stores the \`Sources\` structure in JSON format on OSS. This is suitable… |
| TargetURI | string | yes | The OSS address of the output file. The compressed file is named after the file name in this path, such as `name.zip`. The OSS address… |
| CompressedFormat | string | no | The compression format for file packaging. Currently, only the zip format is supported |
| UserData | string | no | Custom user data. This data is returned in the asynchronous notification message, which helps you associate the notification with your… |
| Notification | string | no | The message notification configuration. For more information, see the Notification data type. For the format of asynchronous notification… |

### A file decompression task lets you decompress specific files or an entire compressed package to a specified…
`POST https://apizie.tech/v1/cloud:aliyun-imm/create-file-uncompression-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The name of the project. For more information, see https://help.aliyun.com/document_detail/478153.html |
| CredentialConfig | string | no | Leave this parameter empty unless you have specific requirements. The chained authorization configuration. This parameter is optional. For… |
| Password | string | no | The password for the encrypted compressed package |
| UserData | string | no | Custom user information. It is returned in the asynchronous notification message to help you associate the notification with your system.… |
| SelectedFiles | string | no | The list of files to decompress. If this parameter is empty, the entire compressed package is decompressed. The default value is empty… |
| SourceURI | string | yes | The Object Storage Service (OSS) address where the compressed file is stored. The OSS address must be in the… |
| Notification | string | no | The message notification configuration. For details, click Notification. For the format of asynchronous notification messages, see… |
| TargetURI | string | no | The destination OSS address for the decompressed files. The selected files or the entire compressed package are decompressed to this… |

### Creates a video highlight task. This feature is in invitational preview
`POST https://apizie.tech/v1/cloud:aliyun-imm/create-highlight-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The name of the project |
| Sources | string | yes | The list of media resources to be processed. You can specify up to 10 videos (JSON-encoded) |
| Mode | string | no | The highlight recognition mode. Valid values: Scene: scene and frame recognition Average: average clip recognition Default value: Average |
| Type | string | yes | The processing type. Valid values: Retrieval: highlight extraction Concat: video composition Compose: one-click video creation |
| Highlight | string | no | The highlight configuration (JSON-encoded) |
| Edit | string | no | The editing configuration (JSON-encoded) |
| Output | string | yes | The output configuration (JSON-encoded) |
| UserData | string | no | The custom user data, which is returned in asynchronous message notifications |
| Tags | string | no | The custom tags used to search and filter asynchronous tasks (JSON-encoded) |
| CredentialConfig | string | no | The chained authorization configuration. Leave this parameter empty unless otherwise required (JSON-encoded) |
| Notification | string | no | The message notification configuration. For more information, see Notification. For the format of asynchronous notification messages, see… |

### Detects non-compliant content in images, such as pornography, terrorism, undesirable scenes, logos, and…
`POST https://apizie.tech/v1/cloud:aliyun-imm/create-image-moderation-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The project name. For more information about how to obtain the project name, see https://help.aliyun.com/document_detail/478153.html |
| UserData | string | no | The custom information. This information is returned in the asynchronous notification message to help you associate the message with your… |
| SourceURI | string | yes | The OSS URI of the image. The URI must follow the `oss:// / ` format. ` ` is the name of the OSS bucket that is in the same region as the… |
| Tags | string | no | The custom tags. You can use tags to search for and filter asynchronous tasks (JSON-encoded) |
| CredentialConfig | string | no | The chained authorization configuration. This parameter is optional. For more information, see… |
| Scenes | string | no | The image detection scenarios (JSON-encoded) |
| Interval | integer | no | The frame capture frequency. This parameter is used for GIF and long image detection. The default value is 1 |
| MaxFrames | integer | no | The maximum number of frames to capture. This parameter is used for GIF and long image detection. The default value is 1 |
| Notification | string | no | The notification configuration. For more information about the format of asynchronous notification messages, see… |

### Stitches multiple images into a single image based on specified rules and saves the output to a specified…
`POST https://apizie.tech/v1/cloud:aliyun-imm/create-image-splicing-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The project name. For more information about how to obtain the project name, see https://help.aliyun.com/document_detail/478153.html |
| Sources | string | yes | The list of input images. The images are stitched in the order of their URIs in the list (JSON-encoded) |
| TargetURI | string | yes | The OSS URI where the output image is stored. The URI must be in the oss\://${bucketname}/${objectname} format. ${bucketname} is the name… |
| ImageFormat | string | no | The compression format of the output image. Valid values: jpg (default) png webp |
| Quality | integer | no | The compression quality of the output image. This parameter is valid only for JPG and WebP images. The value range is 0 to 100. The… |
| Direction | string | no | The image stitching method. Valid values: vertical (default): Stitches images vertically. The widths of all images must be the same.… |
| ScaleType | string | no | The scaling method used when the width or height of an image is aligned. Valid values: fit (default): Scales the image without adding… |
| Align | integer | no | The alignment value, in pixels, for the width or height of the images to be stitched. The value can range from 1 to 4096. If you set… |
| Padding | integer | no | The space, in pixels, between sub-images in the stitched image. The default value is 0 |
| Margin | integer | no | The blank margin, in pixels, of the stitched image. The default value is 0 |
| BackgroundColor | string | no | The fill color for the areas specified by `Padding` and `Margin`. The value can be in the `#FFFFFF` format or a keyword such as `red` or… |
| UserData | string | no | The custom information. This information is returned in the asynchronous notification message. Use this information to associate the… |
| CredentialConfig | string | no | The chained authorization configuration. For more information, see https://help.aliyun.com/document_detail/465340.html (JSON-encoded) |
| Tags | string | no | Custom tags used to search for and filter asynchronous tasks (JSON-encoded) |
| Notification | string | no | The message notification configuration. For information about the format of asynchronous notification messages, see… |

### Converts multiple images into a single PDF file and saves the file as a specified OSS object
`POST https://apizie.tech/v1/cloud:aliyun-imm/create-image-to-pdftask` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The name of the project. For more information, see https://help.aliyun.com/document_detail/478153.html |
| Sources | string | yes | A list of input images. The images are converted in the order of their URIs in this list (JSON-encoded) |
| TargetURI | string | yes | The OSS address where the output PDF file is stored. The address must be in the \`oss\://${bucketname}/${objectname}\` format.… |
| UserData | string | no | Custom user information that is returned in the asynchronous notification message. This helps you associate the notification message with… |
| CredentialConfig | string | no | If you have no special requirements, leave this parameter empty. The chained authorization configuration. For more information, see… |
| Tags | string | no | Custom tags used to search for and filter asynchronous tasks (JSON-encoded) |
| Notification | string | no | The message notification configuration. For more information, click Notification. For the format of asynchronous notification messages,… |

### The spatio-temporal clustering feature classifies files in a dataset based on their time and location. This…
`POST https://apizie.tech/v1/cloud:aliyun-imm/create-location-date-clustering-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The project name. For more information, see https://help.aliyun.com/document_detail/478153.html |
| DatasetName | string | yes | The dataset name. For more information, see https://help.aliyun.com/document_detail/478160.html |
| UserData | string | no | Custom information that is returned in the asynchronous notification message. This helps you associate the notification message with your… |
| Tags | string | no | Custom tags used to search for and filter asynchronous tasks (JSON-encoded) |
| DateOptions | string | yes | The date clustering settings. Modifying this setting also affects existing spatio-temporal clusters in your `Dataset`.> (JSON-encoded) |
| LocationOptions | string | yes | The location clustering settings. Modifying this setting also affects existing spatio-temporal clusters in your `Dataset`.> (JSON-encoded) |
| Notification | string | no | The message notification configuration. For more information, see Notification. For the format of asynchronous notification messages, see… |

### Create an asynchronous media transcoding task. This task processes audio and video files for media…
`POST https://apizie.tech/v1/cloud:aliyun-imm/create-media-convert-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The name of the project. For more information about how to obtain the project name, see https://help.aliyun.com/document_detail/478153.html |
| Sources | string | yes | A list of media files. If you provide more than one file, they are concatenated in the order of their URIs (JSON-encoded) |
| Targets | string | no | A list of media processing tasks (JSON-encoded) |
| UserData | string | no | The custom user data. This data is returned in the asynchronous notification, allowing you to associate the notification with your… |
| Tags | string | no | Custom tags for searching and filtering asynchronous tasks (JSON-encoded) |
| CredentialConfig | string | no | You can leave this parameter empty if you do not have special requirements. The chained authorization configuration. For more information,… |
| Notification | string | no | The message notification settings. For more information, click Notification. For information about the format of asynchronous… |
| AlignmentIndex | integer | no | When concatenating media files, this specifies the index of the primary file in the Sources list. The default transcoding parameters (such… |
| TargetGroups | string | no | A list of media packaging tasks to convert and package the input media into HLS outputs. Each TargetGroup corresponds to one HLS master… |

### Creates a document conversion task that converts documents, such as Word, PowerPoint, Excel, and PDF files,…
`POST https://apizie.tech/v1/cloud:aliyun-imm/create-office-conversion-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The project name. For more information about how to obtain the project name, see https://help.aliyun.com/document_detail/478153.html |
| SourceURI | string | no | The storage address of the source data. The OSS address must be in the oss\://${Bucket}/${Object} format. \`${Bucket}\` is the name of the… |
| Sources | string | no | A list of input images. The images are converted in the order of their URIs in the list. (This parameter is not yet published. Do not use… |
| TargetURI | string | no | The template for the output address of the converted document. The address must be in the… |
| TargetURIPrefix | string | no | The prefix of the storage address for the output file after document conversion. The prefix must be in the `oss://${Bucket}/${Prefix}/`… |
| SourceType | string | no | The extension type of the source data. By default, the type of the source data is determined by the extension of the OSS object. If the… |
| TargetType | string | yes | The type of the output file. Valid values: png: Converts the document to PNG images. jpg: Converts the document to JPG images. pdf:… |
| UserData | string | no | The custom information. This information is returned in the asynchronous notification message to help you associate the notification with… |
| Tags | string | no | The custom tags. The value is a dictionary. You can use tags to search for tasks (JSON-encoded) |
| StartPage | integer | no | The start page for the document conversion. The default value is 1. If the source file is a spreadsheet, you must specify the worksheet… |
| EndPage | integer | no | The end page for the document conversion. The default value is -1, which indicates that all pages from the start page to the last page are… |
| Password | string | no | The password to open the document. Set this parameter if you want to convert a password-protected document |
| ScalePercentage | integer | no | The scaling ratio of the document. Valid values: 20 to 199. The default value is 100, which indicates that the document is not scaled. A… |
| Quality | integer | no | The quality of the converted file. Valid values: 0 to 100. A value of 0 indicates the lowest quality and the best performance. A value of… |
| Pages | string | no | The page numbers to convert. This parameter has a higher priority than the \`StartPage\` and \`EndPage\` parameters. The format is as… |
| MaxSheetRow | integer | no | The maximum number of rows to convert when you convert a spreadsheet document to images. By default, all rows are converted. This… |
| MaxSheetColumn | integer | no | The maximum number of columns to convert when you convert a spreadsheet document to images. By default, all columns are converted. This… |
| SheetCount | integer | no | The number of worksheets to convert to images in the spreadsheet document. By default, all worksheets are converted |
| SheetIndex | integer | no | The number of the worksheet to convert to images in the spreadsheet document. Valid values: 1 to the number of the last worksheet. The… |
| FitToWidth | string | no | When you convert a spreadsheet document to images or a PDF file, specifies whether to render all columns on a single image or PDF page.… |
| FitToHeight | string | no | When you convert a spreadsheet document to images or a PDF file, specifies whether to render all rows on a single image or PDF page. Valid… |
| FirstPage | string | no | When you convert a spreadsheet document to images, specifies whether to return only the first image of the conversion result. The number… |
| PaperSize | string | no | The paper size for converting a spreadsheet document to images. The output image is similar to a printed page. Valid values: A0 A2 A4… |
| PaperHorizontal | string | no | When you convert a spreadsheet document to images, specifies whether to place the paper horizontally. The output image is similar to a… |
| TrimPolicy | string | no | The trimming policy for spreadsheet conversion. For example, if a spreadsheet contains many empty rows and columns, a large amount of… |
| ShowComments | string | no | When you convert a word processor document to images, specifies whether to show comments. Valid values: false (default): No. Comments are… |
| LongPicture | string | no | When you convert a document to images, specifies whether to convert it into a long image. Valid values: false (default): No. The document… |
| ImageDPI | integer | no | The DPI of the output image. Valid values: 96 to 600. The default value is 96 |
| LongText | string | no | When you convert a document to text, specifies whether to convert it into a long text file. Valid values: false (default): No. Each page… |
| HoldLineFeed | string | no | When you convert a document to text, specifies whether to keep the line feeds in the document. Valid values: false (default): No. Line… |
| CredentialConfig | string | no | If you do not have special requirements, leave this parameter empty. The chained authorization configuration. This parameter is not… |
| Notification | string | no | The message notification configuration. For more information, click Notification. For more information about the format of asynchronous… |

### Creates a project
`POST https://apizie.tech/v1/cloud:aliyun-imm/create-project` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The name of the project. The naming rules are as follows: The name must be 1 to 128 characters in length. The name can contain only… |
| Description | string | no | The description of the project. The description must be 1 to 256 characters in length. Default value: empty |
| ServiceRole | string | no | The service role that is authorized to allow IMM to access other cloud resources such as Object Storage Service (OSS). Default value:… |
| TemplateId | string | no | The ID of the workflow template. Default value: empty. For more information, see https://help.aliyun.com/document_detail/466304.html |
| ProjectMaxDatasetCount | integer | no | The maximum number of datasets in the project. Valid values: 1 to 1000000000. Default value: 1000000000 |
| DatasetMaxBindCount | integer | no | The maximum number of bindings for each dataset. Valid values: 1 to 10. Default value: 10 |
| DatasetMaxFileCount | integer | no | The maximum number of files in each dataset. Valid values: 1 to 100000000. Default value: 10000000000 |
| DatasetMaxEntityCount | integer | no | The maximum number of metadata entities in each dataset. Default value: 10000000000. This parameter is reserved for future use and does… |
| DatasetMaxRelationCount | integer | no | The maximum number of metadata relations in each dataset. Default value: 100000000000. This parameter is reserved for future use and does… |
| DatasetMaxTotalFileSize | integer | no | The maximum total size of files in each dataset. If the limit is exceeded, no more indexes can be added. Unit: bytes. Default value:… |
| Tag | string | no | The list of tags (JSON-encoded) |

### The similar image clustering feature groups images that you have indexed in a dataset into clusters based on…
`POST https://apizie.tech/v1/cloud:aliyun-imm/create-similar-image-clustering-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The name of the project. For more information, see https://help.aliyun.com/document_detail/478153.html |
| DatasetName | string | yes | The name of the dataset. For more information, see https://help.aliyun.com/document_detail/478160.html |
| UserData | string | no | The custom information. This information is returned in the asynchronous notification message to help you associate the message with your… |
| Tags | string | no | The custom tags that are used to search for and filter asynchronous tasks (JSON-encoded) |
| Notification | string | no | The configuration of the notification message. For more information, click Notification. For more information about the format of… |

### Creates a story
`POST https://apizie.tech/v1/cloud:aliyun-imm/create-story` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The name of the project. For more information, see https://help.aliyun.com/document_detail/478153.html |
| DatasetName | string | yes | The name of the dataset. For more information, see https://help.aliyun.com/document_detail/478160.html |
| ObjectId | string | no | The ID for the story object. This parameter is optional. If you do not specify an ID, IMM generates one. You can use the story ID to query… |
| StoryType | string | yes | The type of the story to generate. For more information about story types and their valid values, see… |
| StorySubType | string | no | The subtype of the story to generate. For more information about story subtypes and their valid values, see… |
| StoryStartTime | string | no | The start time of the photo collection for the story. This parameter and StoryEndTime define a time range. IMM filters candidate photos… |
| StoryEndTime | string | no | The end time of the photo collection for the story. This parameter and StoryStartTime define a time range. IMM filters candidate photos… |
| StoryName | string | no | The name of the story |
| MinFileCount | integer | no | The minimum number of photos in the generated story. The actual number of photos is between the values of MinFileCount and MaxFileCount.… |
| MaxFileCount | integer | no | The maximum number of photos in the generated story. The actual number of photos is between the values of MinFileCount and MaxFileCount.… |
| NotifyTopicName | string | no | The name of the topic for asynchronous notifications |
| CustomLabels | string | no | The custom labels. These labels contain custom information about the story and can be used for retrieval (JSON-encoded) |
| CustomId | string | no | A custom identifier for the story. This ID can be different from ObjectId. You can use this ID to retrieve or sort stories |
| Address | string | no | The address information for the story. IMM filters photos whose shooting locations match the specified address to generate the story. This… |
| Tags | string | no | This parameter provides a tagging mechanism that can be used in the following scenarios: Set custom data that is returned in MNS messages.… |
| UserData | string | no | The custom information that is returned in an asynchronous notification message. You can use this information to associate the… |
| Notification | string | no | The notification configuration. For more information about the format of asynchronous notification messages, see… |

### Creates a trigger to start data processing in Intelligent Media Management (IMM). The trigger is activated…
`POST https://apizie.tech/v1/cloud:aliyun-imm/create-trigger` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The project name. For more information, see https://help.aliyun.com/document_detail/478153.html |
| Input | string | yes | The data source configuration (JSON-encoded) |
| Actions | string | yes | A list of data processing templates (JSON-encoded) |
| Notification | string | no | The notification recipient. Various message intermediaries are supported. For details about the message format, see Asynchronous… |
| Tags | string | no | Custom tags used to search and filter asynchronous tasks (JSON-encoded) |
| ServiceRole | string | yes | The service role that grants Intelligent Media Management (IMM) permissions to access other cloud resources, such as Object Storage… |

### Detects labels for scenarios, objects, and events in video content. This feature supports more than 30…
`POST https://apizie.tech/v1/cloud:aliyun-imm/create-video-label-classification-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The project name. For more information about how to obtain the project name, see https://help.aliyun.com/document_detail/478153.html |
| SourceURI | string | yes | The Object Storage Service (OSS) URI of the video. The OSS URI must follow the format oss\://${Bucket}/${Object}. ${Bucket} is the name of… |
| UserData | string | no | Custom information. This information is returned in the asynchronous notification message. You can use this information to associate the… |
| Tags | string | no | Custom tags that you can use to search for and filter asynchronous tasks (JSON-encoded) |
| CredentialConfig | string | no | If you do not have special requirements, leave this parameter empty. The chained authorization configuration. This parameter is not… |
| Notification | string | no | The message notification configuration. For more information, click Notification. For more information about the format of asynchronous… |

### Detects threats or non-compliant content in videos. This operation can be used in scenarios such as…
`POST https://apizie.tech/v1/cloud:aliyun-imm/create-video-moderation-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The name of the project. For more information about how to get the project name, see https://help.aliyun.com/document_detail/478153.html |
| UserData | string | no | Custom information that is returned in the asynchronous notification message. Use this information to associate the notification message… |
| SourceURI | string | yes | The OSS URI of the video. The OSS URI must follow the format oss\://${Bucket}/${Object}. `${Bucket}` is the name of the OSS bucket in the… |
| Tags | string | no | Custom tags used to search for tasks (JSON-encoded) |
| CredentialConfig | string | no | The chained authorization configuration. This parameter is optional. For more information, see… |
| Scenes | string | no | The video detection scenarios (JSON-encoded) |
| Interval | integer | no | The interval for video snapshots, in seconds. The value can be an integer from 1 to 600. The default value is 1 |
| MaxFrames | integer | no | The maximum number of frames that can be captured for this detection task. The value can be an integer from 5 to 3,600. The default value… |
| Notification | string | no | The notification configuration. For the format of asynchronous notification messages, see the metadata index section in… |

### Deletes a batch processing task
`POST https://apizie.tech/v1/cloud:aliyun-imm/delete-batch` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The name of the project. You can obtain the name of the project from the response of the… |
| Id | string | yes | The ID of the batch processing task |

### Deletes the binding between a dataset and an Object Storage Service (OSS) bucket
`POST https://apizie.tech/v1/cloud:aliyun-imm/delete-binding` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The name of the project. For more information, see https://help.aliyun.com/document_detail/478153.html |
| DatasetName | string | no | The name of the dataset. For more information, see https://help.aliyun.com/document_detail/478160.html |
| URI | string | no | The URI of the OSS bucket to which the dataset is bound. Specify the value in the oss\://${Bucket} format. `${Bucket}` specifies the name… |

### Deletes a dataset
`POST https://apizie.tech/v1/cloud:aliyun-imm/delete-dataset` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The name of the project. For more information, see https://help.aliyun.com/document_detail/478153.html |
| DatasetName | string | yes | The name of the dataset. For information about how to create a dataset, see https://help.aliyun.com/document_detail/478160.html |

### Removes the metadata of a file from a dataset
`POST https://apizie.tech/v1/cloud:aliyun-imm/delete-file-meta` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The name of the project. For more information, see https://help.aliyun.com/document_detail/478153.html |
| DatasetName | string | yes | The name of the dataset. For more information, see https://help.aliyun.com/document_detail/478160.html |
| URI | string | yes | The URI of the file in OSS. Specify the value in the oss://${Bucket}/${Object} format. `${Bucket}` specifies the name of the OSS bucket… |

### Deletes a spatiotemporal cluster
`POST https://apizie.tech/v1/cloud:aliyun-imm/delete-location-date-cluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The name of the project. For more information, see https://help.aliyun.com/document_detail/478153.html |
| DatasetName | string | yes | The name of the dataset. For information about how to create a dataset, see https://help.aliyun.com/document_detail/478160.html |
| ObjectId | string | yes | The ID of the group to be deleted |

### Deletes a project
`POST https://apizie.tech/v1/cloud:aliyun-imm/delete-project` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The name of the project. For more information, see https://help.aliyun.com/document_detail/478153.html |

### Deletes a story
`POST https://apizie.tech/v1/cloud:aliyun-imm/delete-story` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The name of the project.[](~~478153~~) |
| DatasetName | string | yes | The name of the dataset.[](~~478160~~) |
| ObjectId | string | yes | The ID of the story to delete |

### Deletes a trigger
`POST https://apizie.tech/v1/cloud:aliyun-imm/delete-trigger` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The name of the project. You can obtain the name of the project from the response of the… |
| Id | string | yes | The ID of the trigger. You can obtain the ID of the trigger from the response of the https://help.aliyun.com/document_detail/479912.html… |

### Unbinds an Object Storage Service (OSS) bucket from the corresponding project
`POST https://apizie.tech/v1/cloud:aliyun-imm/detach-ossbucket` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| OSSBucket | string | yes | The OSS bucket that you want to unbind |

### Detects human body information, such as the confidence level and body bounding box, in an image
`POST https://apizie.tech/v1/cloud:aliyun-imm/detect-image-bodies` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The name of the project. You can obtain the name of the project from the response of the… |
| SourceURI | string | no | The URI of the Object Storage Service (OSS) bucket in which the image file is stored. Specify the value in the oss://${Bucket}/${Object}… |
| Sensitivity | number | no | The accuracy level of detecting and recognizing specific content in the image. Valid values: 0 to 1. Default value: 0.6. A higher… |
| CredentialConfig | string | no | If you have no special requirements, leave this parameter empty. The authorization chain settings. For more information, see… |

### Detects the outline data, attributes, and license plate information of vehicles in an image. The vehicle…
`POST https://apizie.tech/v1/cloud:aliyun-imm/detect-image-cars` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The name of the project. You can obtain the name of the project from the response of the… |
| SourceURI | string | yes | The URI of the Object Storage Service (OSS) bucket in which you store the image file. Specify the value in the oss://${Bucket}/${Object}… |
| CredentialConfig | string | no | If you do not have special requirements, leave this parameter empty. The authorization chain. This parameter is optional. For more… |

### Detects barcodes and QR codes in an image
`POST https://apizie.tech/v1/cloud:aliyun-imm/detect-image-codes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The name of the project. You can obtain the name of the project from the response of the… |
| SourceURI | string | yes | The URI of the Object Storage Service (OSS) bucket in which the image file is stored. Specify the value in the oss://${Bucket}/${Object}… |
| CredentialConfig | string | no | If you have no special requirements, leave this parameter empty. The authorization chain settings. For more information, see… |

### Detects visually optimal cropping regions in an image at a specified aspect ratio by using AI model…
`POST https://apizie.tech/v1/cloud:aliyun-imm/detect-image-cropping` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The project name |
| SourceURI | string | no | The OSS URI of the image. The OSS URI follows the format oss://${Bucket}/${Object}, where `${Bucket}` is the name of an OSS bucket in the… |
| AspectRatios | string | no | The list of cropping aspect ratios. You can specify up to 5 ratios. Each ratio must meet the following requirements: The ratio must… |
| CredentialConfig | string | no | Leave this parameter empty unless otherwise required. The China authorization configuration. This parameter is optional. For more… |
| InclusionHints | string | no | The list of semantic text descriptions for objects that you want the cropping result to include. Each element is free-form text, such as… |

### Detects faces from an image, including face boundary information, attributes, and quality. The boundary…
`POST https://apizie.tech/v1/cloud:aliyun-imm/detect-image-faces` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The name of the project.[](~~478153~~) |
| SourceURI | string | no | The OSS URI of the image object. Specify the OSS URI in the oss://${Bucket}/${Object} format, where `${Bucket}` is the name of the bucket… |
| CredentialConfig | string | no | If you have no special requirements, leave this parameter empty. The authorization chain settings. For more information, see… |

### Detects scene, object, and event information in an image. Scene information includes natural landscapes,…
`POST https://apizie.tech/v1/cloud:aliyun-imm/detect-image-labels` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The name of the project. You can obtain the name of the project from the response of the… |
| SourceURI | string | yes | The URI of the Object Storage Service (OSS) bucket in which you store the image. Specify the value in the oss\://${Bucket}/${Object}… |
| Threshold | number | no | The threshold of the label confidence. Labels whose confidence is lower than the specified threshold are not returned in the response.… |
| CredentialConfig | string | no | If you have no special requirements, leave this parameter empty. The authorization chain settings. For more information, see… |

### Calculates the aesthetics quality score of an image based on metrics such as the composition, brightness,…
`POST https://apizie.tech/v1/cloud:aliyun-imm/detect-image-score` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The name of the project.[](~~477051~~) |
| SourceURI | string | no | The OSS URI of the input image. Specify the OSS URI in the oss://${Bucket}/${Object} format, where `${Bucket}` is the name of the bucket… |
| CredentialConfig | string | no | If you have no special requirements, leave this parameter empty. The authorization chain settings. For more information, see… |

### Recognizes and extracts text content from an image
`POST https://apizie.tech/v1/cloud:aliyun-imm/detect-image-texts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The name of the project. For more information, see https://help.aliyun.com/document_detail/478153.html |
| SourceURI | string | yes | The Object Storage Service (OSS) URI of the file. Specify the URI in the oss://${Bucket}/${Object} format. ${Bucket} specifies the name of… |
| CredentialConfig | string | no | If you have no special requirements, leave this parameter empty. The authorization chain settings. For more information, see… |

### Retrieves the metadata of a media file, including media format information and media stream information
`POST https://apizie.tech/v1/cloud:aliyun-imm/detect-media-meta` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | no | The project name. For information about how to obtain the project name, see https://help.aliyun.com/document_detail/478153.html |
| SourceURI | string | no | The Object Storage Service (OSS) URI of the media file. The OSS URI follows the format oss://${Bucket}/${Object}, where `${Bucket}` is the… |
| CredentialConfig | string | no | Leave this parameter empty unless you have special requirements. The chain authorization configuration. This parameter is optional. For… |

### Detects whether specified text contains anomalies, such as pornography, advertisements, excessive junk…
`POST https://apizie.tech/v1/cloud:aliyun-imm/detect-text-anomaly` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The name of the project. For more information, see https://help.aliyun.com/document_detail/478153.html |
| Content | string | yes | The text to be detected. It can contain up to 10,000 characters (including punctuation marks). Only Chinese text can be detected |

### Embeds specific textual information into an image as watermarks. These watermarks are visually imperceptible…
`POST https://apizie.tech/v1/cloud:aliyun-imm/encode-blind-watermark` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The name of the project. For more information, see https://help.aliyun.com/document_detail/478153.html |
| SourceURI | string | yes | The Object Storage Service (OSS) URI of the image. Specify the value in the oss://${Bucket}/${Object} format. `${Bucket}` specifies the… |
| TargetURI | string | yes | The URI of the output image in OSS. Specify the URI in the oss://${Bucket}/${Object} format, where `${Bucket}` is the name of the bucket… |
| Content | string | no | The text content of watermarks. It can be up to 256 characters in length |
| StrengthLevel | string | no | The watermark strength level. The higher the strength, the more resistant the watermarked image is to attacks, but the more the image is… |
| ImageQuality | integer | no | This parameter takes effect only if the input image format is JPG. The storage quality of the output image that carries the watermarks.… |

### Extract text from the document
`POST https://apizie.tech/v1/cloud:aliyun-imm/extract-document-text` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | Project name. For how to obtain it, see https://help.aliyun.com/document_detail/477051.html |
| SourceURI | string | yes | Storage address of the source data. The OSS address rule is oss://${Bucket}/${Object}, where `${Bucket}` is the name of the OSS Bucket in… |
| SourceType | string | no | Suffix type of the source data. By default, the type of the source data is determined based on the suffix of the input object. When the… |
| CredentialConfig | string | no | If there are no special requirements, leave it blank. Chain authorization configuration, optional. For more information, see… |

### Queries the extracted file metadata, including fields such as the file name, tags, path, and custom tags.…
`POST https://apizie.tech/v1/cloud:aliyun-imm/fuzzy-query` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| NextToken | string | no | The token used for pagination when the total number of files exceeds the value of MaxResults. The list of file information is returned in… |
| MaxResults | integer | no | The maximum number of files to return. Valid values: 0 to 200. If you do not set this parameter or set it to 0, the default value is 100 |
| ProjectName | string | yes | The name of the project. For more information about how to obtain the project name, see https://help.aliyun.com/document_detail/478153.html |
| DatasetName | string | yes | The name of the dataset. For more information about how to obtain the dataset name, see https://help.aliyun.com/document_detail/478160.html |
| Query | string | yes | The string used for the query. The string cannot exceed 1 MB in size |
| Sort | string | no | The list of fields by which to sort the results. For more information, see the https://help.aliyun.com/document_detail/2743991.html. You… |
| Order | string | no | The sort order of the sort fields. Valid values: asc: Ascending order. desc: Descending order. This is the default value. You can separate… |
| WithFields | string | no | Specifies the fields to return. Only the values of the specified fields are returned instead of all existing metadata fields. You can use… |

### Creates a just-in-time transcoding playlist that generates an M3U8 file from a video file, enables instant…
`POST https://apizie.tech/v1/cloud:aliyun-imm/generate-video-playlist` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The project name. For information about how to obtain the project name, see https://help.aliyun.com/document_detail/478153.html |
| UserData | string | no | The custom information that is returned in asynchronous message notifications, which helps you associate message notifications within your… |
| SourceURI | string | yes | The OSS URI of the video. The OSS URI follows the format oss://${Bucket}/${Object}, where ${Bucket} is the name of the OSS bucket in the… |
| SourceStartTime | number | no | The start time for generating the playlist. Unit: seconds. Valid values: 0 (default) or empty: starts from the beginning of the source… |
| SourceDuration | number | no | The duration for generating the playlist. Unit: seconds. Valid values: 0 (default) or empty: continues until the end of the source video.… |
| SourceSubtitles | string | no | The list of subtitles to add. Default value: empty. Maximum number of subtitles: 2 (JSON-encoded) |
| MasterURI | string | no | The OSS URI of the Master Playlist. The OSS URI follows the format oss://${Bucket}/${Object}, where ${Bucket} is the name of the OSS… |
| Targets | string | yes | The array of just-in-time transcoding playlists. Maximum array length: 6. Each Target corresponds to at most one video Media Playlist and… |
| Tags | string | no | The OSS object https://help.aliyun.com/document_detail/106678.html to add to the generated TS files. You can use tags to control the… |
| CredentialConfig | string | no | Leave this parameter empty unless you have special requirements. The China authorization configuration. This parameter is optional. For… |
| Notification | string | no | The message notification configuration. Click Notification for details. For the format of asynchronous notification messages, see… |
| OverwritePolicy | string | no | The overwrite policy when the Media Playlist already exists. Valid values: overwrite (default): Overwrites the existing Media Playlist.… |

### Retrieves the preview and editing credentials for a document
`POST https://apizie.tech/v1/cloud:aliyun-imm/generate-weboffice-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The project name. For information about how to obtain the project name, see https://help.aliyun.com/document_detail/478153.html |
| SourceURI | string | yes | The OSS URI of the document to preview or edit. The OSS URI follows the format `oss://${Bucket}/${Object}`, where `Bucket` is the name of… |
| Filename | string | no | The file name, which must include the file name extension. The default value is the last segment of the SourceURI parameter. Supported… |
| CachePreview | string | no | Specifies whether to enable cached preview. true: When enabled, the document preview no longer updates collaborative editing content. This… |
| Referer | string | no | The OSS hotlink protection referer. Intelligent Media Management (IMM) needs to retrieve the source file from OSS. If hotlink protection… |
| UserData | string | no | The custom user data. This parameter takes effect only when the Notification parameter is specified with MNS configurations. The data is… |
| PreviewPages | integer | no | The maximum number of pages that can be previewed. By default, no limit is imposed. The maximum value is 5,000 |
| Password | string | no | The password to open the document. Set this parameter if you want to preview or edit a password-protected document |
| ExternalUploaded | string | no | Specifies whether uploading a file with the same name to OSS is expected behavior. Valid values: true: Uploading a file with the same name… |
| NotifyTopicName | string | no | Sends event notifications to you as MNS messages. This parameter specifies the MNS topic for asynchronous message notifications |
| Hidecmb | string | no | Specifies whether to hide the toolbar. This parameter is supported in document preview mode. Valid values: false (default): The toolbar is… |
| Permission | string | no | The user permission information in JSON format. User permissions include the following options: Each option is of the Boolean type. The… |
| User | string | no | The user information. You can pass in user information from the business side, and the WebOffice page displays this information. The… |
| Watermark | string | no | The watermark information. The watermark is generated on the frontend and is not written to the source document. Different parameters… |
| CredentialConfig | string | no | Leave this parameter empty unless you have specific requirements. The China authorization configuration. This parameter is optional. For… |
| Notification | string | no | The notification configuration. Currently, only MNS is supported. For the format of asynchronous notification messages, see… |

### Queries the information about a batch processing task
`POST https://apizie.tech/v1/cloud:aliyun-imm/get-batch` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The name of the project. For more information, see https://help.aliyun.com/document_detail/478153.html |
| Id | string | yes | The ID of the batch processing task. For more information about how to obtain the ID, see… |

### Queries the details of the binding relationship between a specified dataset and an Object Storage Service…
`POST https://apizie.tech/v1/cloud:aliyun-imm/get-binding` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The name of the project. For more information about how to obtain the project name, see https://help.aliyun.com/document_detail/478153.html |
| DatasetName | string | no | The name of the dataset. For more information about how to obtain the dataset name, see https://help.aliyun.com/document_detail/478160.html |
| URI | string | no | The URI of the OSS bucket to which the dataset is bound. The URI of an OSS bucket is in the oss://${Bucket} format, where `${Bucket}` is… |

### Queries the information of a dataset
`POST https://apizie.tech/v1/cloud:aliyun-imm/get-dataset` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The name of the project. For more information about how to obtain the project name, see https://help.aliyun.com/document_detail/478153.html |
| DatasetName | string | yes | The name of the dataset. For more information about how to obtain the dataset name, see https://help.aliyun.com/document_detail/478160.html |
| WithStatistics | string | no | Specifies whether to collect file statistics. Valid values: true: File statistics are collected. The FileCount and TotalFileSize fields in… |

### Retrieves the result of a blind watermark extraction task for an image
`POST https://apizie.tech/v1/cloud:aliyun-imm/get-decode-blind-watermark-result` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The project name. For information about how to obtain the project name, see https://help.aliyun.com/document_detail/478153.html |
| TaskType | string | yes | The task type |
| TaskId | string | yes | The task ID. You can obtain the task ID from the response parameters of the blind watermark extraction task creation operation |

### Retrieves the basic information of a face group, including the creation time, number of photos, and group…
`POST https://apizie.tech/v1/cloud:aliyun-imm/get-figure-cluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The name of the project. For more information about how to obtain the project name, see [CreateProject](~~CreateProject~~) |
| DatasetName | string | yes | The name of the dataset. For more information about how to obtain the dataset name, see [CreateDataset](~~CreateDataset~~) |
| ObjectId | string | yes | The object ID of the clustering group. You can obtain the object ID from the face group information returned by… |

### Retrieves the metadata of indexed files in a dataset
`POST https://apizie.tech/v1/cloud:aliyun-imm/get-file-meta` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The name of the project. For more information about how to obtain the project name, refer to… |
| DatasetName | string | yes | The name of the dataset. For more information about how to obtain the dataset name, refer to… |
| URI | string | yes | The URI of the file. Make sure that the file has been indexed. The OSS URI format is oss://${Bucket}/${Object}, where `${Bucket}` is the… |
| WithFields | string | no | Specifies the specific fields to return, instead of all existing metadata fields. You can use this parameter to reduce the size of the… |

### Retrieves an image content moderation task
`POST https://apizie.tech/v1/cloud:aliyun-imm/get-image-moderation-result` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The project name |
| TaskType | string | yes | The task type |
| TaskId | string | yes | The task ID |

### Retrieves the project name of a project that is bound to a specified OSS bucket in the same region
`POST https://apizie.tech/v1/cloud:aliyun-imm/get-ossbucket-attachment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| OSSBucket | string | yes | The name of the OSS bucket |

### Queries the information about a specified project, including basic information, datasets, and file-related…
`POST https://apizie.tech/v1/cloud:aliyun-imm/get-project` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The name of the project. For more information about how to obtain the project name, see https://help.aliyun.com/document_detail/478153.html |
| WithStatistics | string | no | Specifies whether to collect file statistics. Default value: false. true: File statistics are collected. The FileCount and TotalFileSize… |

### Retrieves the information about a story
`POST https://apizie.tech/v1/cloud:aliyun-imm/get-story` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The name of the project. For more information about how to obtain the project name, see https://help.aliyun.com/document_detail/478153.html |
| DatasetName | string | yes | The name of the dataset. For more information about how to obtain the dataset name, see https://help.aliyun.com/document_detail/478160.html |
| ObjectId | string | yes | The ID of the story object whose information you want to retrieve |

### Queries the information about a specified asynchronous task. Intelligent Media Management (IMM) supports…
`POST https://apizie.tech/v1/cloud:aliyun-imm/get-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The project name. For information about how to obtain the project name, see https://help.aliyun.com/document_detail/478153.html |
| TaskType | string | yes | The type of the task. For valid values, see https://help.aliyun.com/document_detail/2743993.html |
| TaskId | string | yes | The ID of the task that you want to query. This value is returned when you create the task |
| RequestDefinition | string | no | Specifies whether to return the original request parameters used to create the task. Valid values: true false (default) This parameter… |

### Queries the information about a trigger
`POST https://apizie.tech/v1/cloud:aliyun-imm/get-trigger` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The name of the project. For more information, see https://help.aliyun.com/document_detail/478153.html |
| Id | string | yes | The ID of the trigger. You can obtain the ID from the response parameters of the https://help.aliyun.com/document_detail/479912.html… |

### Retrieves the result of a video label detection task
`POST https://apizie.tech/v1/cloud:aliyun-imm/get-video-label-classification-result` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The project name. For information about how to obtain the project name, see https://help.aliyun.com/document_detail/478153.html |
| TaskType | string | yes | The task type |
| TaskId | string | yes | The task ID. For information about how to obtain the task ID, see the response parameters of… |

### Retrieves a video content moderation task
`POST https://apizie.tech/v1/cloud:aliyun-imm/get-video-moderation-result` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The project name |
| TaskType | string | yes | The task type |
| TaskId | string | yes | The task ID |

### Performs data processing on input files for tasks such as label detection, face detection, and location…
`POST https://apizie.tech/v1/cloud:aliyun-imm/index-file-meta` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The name of the project. To get the project name, see https://help.aliyun.com/document_detail/478153.html |
| DatasetName | string | yes | The name of the dataset. To get the dataset name, see https://help.aliyun.com/document_detail/478160.html |
| File | string | yes | The file to be indexed, in JSON format. For more information, see the struct definition (JSON-encoded) |
| UserData | string | no | Custom information that is returned in the asynchronous notification message. This helps you associate the notification with your… |
| Notification | string | no | The message notification configuration. For more information, see Notification. For the format of the asynchronous notification message,… |

### List bound attachments
`POST https://apizie.tech/v1/cloud:aliyun-imm/list-attached-ossbuckets` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | Project name, for more information on how to obtain it, see https://help.aliyun.com/document_detail/478153.html |
| MaxResults | integer | no | The maximum number of tasks in the returned result list. The value range is (0, 200], with a default value of 100 |
| NextToken | string | no | Pagination token. When the total number of files exceeds the set MaxResults, this token is used for pagination. It returns the list of… |

### Queries batch processing tasks. You can query batch processing tasks based on conditions such task tags and…
`POST https://apizie.tech/v1/cloud:aliyun-imm/list-batches` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The name of the project.[](~~478153~~) |
| State | string | no | The task status. Ready: The task is newly created and ready. Running: The task is running. Failed: The task failed and cannot be… |
| Sort | string | no | The sort field. Valid values: CreateTime UpdateTime |
| Order | string | no | The sort order. Valid values: ASC: sorts the results in ascending order. This is the default sort order. DES: sorts the results in… |
| TagSelector | string | no | The custom tag. You can use this parameter to query tasks that have the specified tag |
| NextToken | string | no | The pagination token. The pagination token is used in the next request to retrieve a new page of results if the total number of results… |
| MaxResults | integer | no | The maximum number of results to return. Valid values: 0 to 100. If you do not specify this parameter or set the parameter to 0, the… |

### Queries the list of bindings between datasets and Object Storage Service (OSS) buckets
`POST https://apizie.tech/v1/cloud:aliyun-imm/list-bindings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The name of the project. For more information about how to obtain the project name, see https://help.aliyun.com/document_detail/478153.html |
| DatasetName | string | no | The name of the dataset. For more information about how to obtain the dataset name, see https://help.aliyun.com/document_detail/478160.html |
| URI | string | no | The URI of the source OSS bucket, which is used to filter the bindings associated with the bucket |
| MaxResults | integer | no | The maximum number of bindings to return. Valid values: 0 to 200. If this parameter is not specified or is set to 0, the default value is… |
| NextToken | string | no | The pagination token that is used when the total number of bindings exceeds the value of MaxResults. The list of bindings is returned in… |
| Name | string | no | The name of the binding task |

### Queries a list of datasets. You can filter the list by specifying a prefix for the dataset name
`POST https://apizie.tech/v1/cloud:aliyun-imm/list-datasets` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The name of the project. For more information about how to obtain the project name, see https://help.aliyun.com/document_detail/478153.html |
| MaxResults | integer | no | The maximum number of datasets to return. Valid values: 0 to 200. If you do not specify this parameter or set it to 0, the default value… |
| NextToken | string | no | The pagination token. If the total number of datasets exceeds the value of MaxResults, this token is used for pagination. The list of… |
| Prefix | string | no | The prefix of the dataset name |

### Queries the information about all projects, including basic information and statistics information related…
`POST https://apizie.tech/v1/cloud:aliyun-imm/list-projects` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| MaxResults | integer | no | The maximum number of projects to return. Valid values: 0 to 200. If this parameter is not set or is set to 0, the default value is 100 |
| NextToken | string | no | The query token. Set the value to the NextToken value returned from the previous API call. The list of projects is returned in… |
| Prefix | string | no | The prefix used to filter projects. The length is limited to 0 to 128 characters |
| Tag | string | no | The tag list (JSON-encoded) |

### Get the list of regions
`POST https://apizie.tech/v1/cloud:aliyun-imm/list-regions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| AcceptLanguage | string | yes | Language type. The range of values is as follows: zh-CN: Chinese en-US: English ja: Japanese |

### Lists tasks based on specific conditions, such as by time range and by tag
`POST https://apizie.tech/v1/cloud:aliyun-imm/list-tasks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The name of the project.[](~~478153~~) |
| TaskTypes | string | no | The task types (JSON-encoded) |
| NextToken | string | no | The pagination token. The pagination token is used in the next request to retrieve a new page of results if the total number of results… |
| MaxResults | integer | no | The maximum number of results to return. Valid value range: (0, 100]. Default value: 100 |
| TagSelector | string | no | The custom tags of tasks |
| Sort | string | no | The field used to sort the results by. Valid values: TaskId: sorts the results by task ID. This is the default sort field. StartTime:… |
| Order | string | no | The sort order. Valid values: asc: in ascending order. This is the default value. desc: in descending order |
| Status | string | no | The task status. Valid values: Running: The task is running. Succeeded: The task is successful. Failed: The task failed |
| StartTimeRange | string | no | The task start time range. You can specify this parameter to filter tasks that start within the specified range (JSON-encoded) |
| EndTimeRange | string | no | The task end time range. You can specify this parameter to filter tasks that end within the specified range (JSON-encoded) |
| RequestDefinition | string | no | Specifies whether to return request parameters in the initial request to create the task. Default value: False |

### Queries triggers by tag or status
`POST https://apizie.tech/v1/cloud:aliyun-imm/list-triggers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The name of the project. You can obtain the name of the project from the response of the… |
| State | string | no | The status of the trigger. Valid values: Ready: The trigger is ready. Running: The trigger is running. Failed: The trigger failed and… |
| Sort | string | no | The sort field. Valid values: CreateTime: the point in time when the trigger is created. UpdateTime: the most recent point in time when… |
| Order | string | no | The sort order. Default value: DESC. ASC (default): ascending order. DESC: descending order |
| TagSelector | string | no | The custom tag. You can specify this parameter only if you specified Tags when you called the CreateTrigger operation |
| NextToken | string | no | The pagination token that is used in the next request to retrieve a new page of results. If the total number of triggers is greater than… |
| MaxResults | integer | no | The maximum number of entries to return. Valid values: 0 to 100. Default value: 100 |

### Queries figure clustering and its information based on a conditional query
`POST https://apizie.tech/v1/cloud:aliyun-imm/query-figure-clusters` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The name of the project. For more information about how to obtain the project name, see https://help.aliyun.com/document_detail/478153.html |
| DatasetName | string | yes | The name of the dataset. For more information about how to obtain the dataset name, see https://help.aliyun.com/document_detail/478160.html |
| Sort | string | no | The field used for sorting. By default, this parameter is left empty, which indicates that the results are sorted by cluster ID |
| Order | string | no | The sort order. Default value: asc |
| CustomLabels | string | no | The query conditions for custom labels |
| MaxResults | integer | no | The maximum number of data records to return in this call. Valid values: 0 to 100. If this parameter is not specified or is set to 0, the… |
| NextToken | string | no | The pagination token. If this parameter is left empty or set to None, the query starts from the beginning |
| CreateTimeRange | string | no | The time range during which the face clusters were created (JSON-encoded) |
| UpdateTimeRange | string | no | The time range during which the face clusters were updated (JSON-encoded) |
| WithTotalCount | string | no | Specifies whether to return the total number of face clusters that meet the current query conditions. Default value: false, which… |

### Queries a list of spatiotemporal clusters based on the specified conditions
`POST https://apizie.tech/v1/cloud:aliyun-imm/query-location-date-clusters` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The name of the project. You can obtain the name of the project from the response of the… |
| DatasetName | string | yes | The name of the dataset. For information about how to create a dataset, see https://help.aliyun.com/document_detail/478160.html |
| ObjectId | string | no | The ID of the cluster that you want to query. Specify this parameter if you want to query a specific spatiotemporal cluster. Otherwise,… |
| Title | string | no | The characters that are included in the titles of spatiotemporal clusters to be queried. Matches are found by using fuzzy matching |
| Address | string | no | The address information (JSON-encoded) |
| LocationDateClusterLevels | string | no | The container for the administrative division level of the spatiotemporal clusters to be queried (JSON-encoded) |
| LocationDateClusterStartTimeRange | string | no | The time range during which the earliest photo in a cluster was taken (JSON-encoded) |
| LocationDateClusterEndTimeRange | string | no | The time range during which the latest photo in a cluster was taken (JSON-encoded) |
| CreateTimeRange | string | no | The time range during which the spatiotemporal clusters were generated (JSON-encoded) |
| UpdateTimeRange | string | no | The time range during which the spatiotemporal clusters were updated (JSON-encoded) |
| NextToken | string | no | The pagination token |
| MaxResults | integer | no | The number of entries per page. Valid values: [1,100]. Default value: 20 |
| CustomLabels | string | no | The custom labels |
| Sort | string | no | The field that you use to sort the query results. Valid values: LocationDateClusterEndTime: by the time at which the latest photo in a… |
| Order | string | no | The order that you use to sort the query results. Valid values: asc: ascending order. This is the default value. desc: descending order |

### You can call this operation to query the list of similar image clusters
`POST https://apizie.tech/v1/cloud:aliyun-imm/query-similar-image-clusters` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The name of the project. For more information, see https://help.aliyun.com/document_detail/478153.html |
| DatasetName | string | yes | The name of the dataset. For more information, see https://help.aliyun.com/document_detail/478160.html |
| NextToken | string | no | The pagination token. If the total number of clusters is greater than the value of MaxResults, you must specify this parameter. The next… |
| MaxResults | integer | no | The number of entries per page. Value range: 0 to 100. Default value: 100 |
| CustomLabels | string | no | The custom tags, which are used to filter tasks |
| Sort | string | no | The sorting field. CreateTime: the time when the clusters were created. UpdateTime: the time when the clusters were updated. This is the… |
| Order | string | no | The sorting order. Valid values: asc: ascending order. desc: descending order. This is the default value |

### Retrieves stories and their information by using a conditional query
`POST https://apizie.tech/v1/cloud:aliyun-imm/query-stories` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The name of the project. For more information about how to obtain the name, see https://help.aliyun.com/document_detail/478153.html |
| DatasetName | string | yes | The name of the dataset. For more information about how to obtain the name, see https://help.aliyun.com/document_detail/478160.html |
| ObjectId | string | no | The ID of the story object |
| StoryName | string | no | The name of the story |
| StoryType | string | no | The type of the story. For valid values, see https://help.aliyun.com/document_detail/2743998.html |
| StorySubType | string | no | The subtype of the story. For valid values, see https://help.aliyun.com/document_detail/2743998.html |
| FigureClusterIds | string | no | The IDs of the figure clusters (JSON-encoded) |
| CreateTimeRange | string | no | The creation time range of the story (JSON-encoded) |
| StoryStartTimeRange | string | no | The start time range of the photos or videos in the story (JSON-encoded) |
| StoryEndTimeRange | string | no | The end time range of the photos or videos in the story (JSON-encoded) |
| NextToken | string | no | The pagination token. If this parameter is left empty, the query starts from the beginning. To query the next page, set this parameter to… |
| MaxResults | integer | no | The maximum number of entries to return in a single call. Valid values: 1 to 100. Default value: 100 |
| CustomLabels | string | no | The custom label key-value pairs. Only stories that match the specified label pairs are returned |
| WithEmptyStories | string | no | Specifies whether to return empty stories. Valid values: true: Returns empty stories. This is the default value. false: Does not return… |
| Sort | string | no | The field used for sorting. Valid values: CreateTime: Sorts by story creation time. StoryName: Sorts by story name. StoryStartTime: Sorts… |
| Order | string | no | The sorting order. Valid values: asc: Ascending order. desc: Descending order |

### Refreshes a Weboffice access token. A Weboffice access token is valid for 30 minutes. After it expires, you…
`POST https://apizie.tech/v1/cloud:aliyun-imm/refresh-weboffice-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The project name. For information about how to obtain the project name, see https://help.aliyun.com/document_detail/478153.html |
| AccessToken | string | yes | The Weboffice access token. You can obtain the token by calling the https://help.aliyun.com/document_detail/478226.html or… |
| RefreshToken | string | yes | The Weboffice refresh token. You can obtain the token by calling the https://help.aliyun.com/document_detail/478226.html or… |
| CredentialConfig | string | no | Leave this parameter empty unless you have special requirements. The China authorization configuration. This parameter is optional. For… |

### Deletes files from a story
`POST https://apizie.tech/v1/cloud:aliyun-imm/remove-story-files` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The name of the project |
| DatasetName | string | yes | The name of the dataset |
| ObjectId | string | yes | The ID of the story |
| Files | string | yes | The files that you want to delete (JSON-encoded) |

### Resumes a batch processing task that is in the Suspended or Failed state
`POST https://apizie.tech/v1/cloud:aliyun-imm/resume-batch` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The name of the project. You can obtain the name of the project from the response of the… |
| Id | string | yes | The ID of the batch processing task. You can obtain the ID of the batch processing task from the response of the… |

### Resumes a trigger that is in the Suspended or Failed state
`POST https://apizie.tech/v1/cloud:aliyun-imm/resume-trigger` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The name of the project. You can obtain the name of the project from the response of the… |
| Id | string | yes | The ID of the trigger. You can obtain the ID from the response of the https://help.aliyun.com/document_detail/479912.html operation |

### Queries face clusters that contain a specific face in an image. Each face cluster contains information such…
`POST https://apizie.tech/v1/cloud:aliyun-imm/search-image-figure-cluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The name of the project.[](~~478153~~) |
| DatasetName | string | yes | The name of the dataset.[](~~478160~~) |
| SourceURI | string | no | The OSS URI of the image. Specify the OSS URI in the `oss://${Bucket}/${Object}` format, where `${Bucket}` is the name of the bucket in… |
| CredentialConfig | string | no | If you have no special requirements, leave this parameter empty. The authorization chain settings. For more information, see… |

### Performs semantic searches on metadata in a dataset by using natural language input
`POST https://apizie.tech/v1/cloud:aliyun-imm/semantic-query` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| NextToken | string | no | This parameter is no longer provided |
| MaxResults | integer | no | The maximum number of data records to return in this request. Value range: (0,100] |
| ProjectName | string | yes | The name of the project |
| DatasetName | string | yes | The name of the dataset |
| Query | string | no | Either this parameter or the SourceURI parameter must be specified. The content for semantic search |
| WithFields | string | no | Specifies the specific fields to return instead of all existing metadata fields. This helps reduce the size of the returned struct. If… |
| MediaTypes | string | no | The media types to search. If this parameter is left empty, the default value is: (JSON-encoded) |
| SourceURI | string | no | Either this parameter or the Query parameter must be specified. This parameter is currently valid only when the search type is specified… |

### Queries and aggregates files in a dataset, and supports logical expressions
`POST https://apizie.tech/v1/cloud:aliyun-imm/simple-query` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| NextToken | string | no | The token used for pagination when the total number of files exceeds the value of MaxResults. The list of files is returned in… |
| MaxResults | integer | no | When you perform a query for files without specifying the Aggregations parameter, this parameter specifies the maximum number of files to… |
| ProjectName | string | yes | The name of the project. For more information about how to obtain the project name, see https://help.aliyun.com/document_detail/478153.html |
| DatasetName | string | yes | The name of the dataset. For more information about how to obtain the dataset name, see https://help.aliyun.com/document_detail/478160.html |
| Query | string | no | The simple query conditions. Click the link on the left to view details (JSON-encoded) |
| Sort | string | no | The list of sort fields. For more information, see https://help.aliyun.com/document_detail/2743991.html. You can separate multiple sort… |
| Order | string | no | The sort order of the sort fields. Valid values: asc: ascending order desc: descending order (default) You can separate multiple sort… |
| Aggregations | string | no | The list of aggregation field information. When you use an aggregation query, only the aggregation results are returned, and the list of… |
| WithFields | string | no | Specifies the specific fields to return instead of all existing metadata fields. This can be used to reduce the size of the returned… |
| WithoutTotalHits | string | no | Specifies whether to return the total number of matched records. Valid values: true: The TotalHits field is not returned. false: The… |

### Suspends a batch processing task
`POST https://apizie.tech/v1/cloud:aliyun-imm/suspend-batch` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The name of the project. You can obtain the name of the project from the response of the… |
| Id | string | yes | The ID of the batch processing task. You can obtain the ID of the batch processing task from the response of the… |

### Suspends a running trigger
`POST https://apizie.tech/v1/cloud:aliyun-imm/suspend-trigger` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The name of the project.[](~~478153~~) |
| Id | string | yes | The ID of the trigger.[](~~479912~~) |

### Updates information for a batch processing task, such as the data source configuration, data processing…
`POST https://apizie.tech/v1/cloud:aliyun-imm/update-batch` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The project name. For more information, see https://help.aliyun.com/document_detail/478153.html |
| Id | string | yes | The ID of the batch processing task. For more information, see https://help.aliyun.com/document_detail/606694.html |
| Input | string | no | The data source configuration (JSON-encoded) |
| Actions | string | no | A list of data processing templates (JSON-encoded) |
| Tags | string | no | Custom tags used to search for and filter asynchronous tasks (JSON-encoded) |

### Updates the information of a dataset
`POST https://apizie.tech/v1/cloud:aliyun-imm/update-dataset` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The name of the project. For more information about how to obtain the project name, see https://help.aliyun.com/document_detail/478153.html |
| DatasetName | string | yes | The name of the dataset. For more information about how to obtain the dataset name, see https://help.aliyun.com/document_detail/478160.html |
| Description | string | no | The description of the dataset |
| TemplateId | string | no | The ID of the workflow template. For more information, see https://help.aliyun.com/document_detail/466304.html |
| DatasetMaxBindCount | integer | no | The maximum number of bindings per dataset. Valid values: 1 to 10 |
| DatasetMaxFileCount | integer | no | The maximum number of files in each dataset. Valid values: 1 to 100000000 |
| DatasetMaxEntityCount | integer | no | The maximum number of metadata entities (including data files, file relationships, and clustering groups) in each dataset. The maximum… |
| DatasetMaxRelationCount | integer | no | The maximum number of metadata relationships in each dataset. The maximum value is 2^63-1. This is a reserved parameter and no actual… |
| DatasetMaxTotalFileSize | integer | no | The maximum total size of files in each dataset. If the limit is exceeded, no more indexes can be added. The maximum value is 2^63-1.… |
| WorkflowParameters | string | no | Invalid parameter (JSON-encoded) |

### Updates information about a face cluster, such as the cluster name and labels
`POST https://apizie.tech/v1/cloud:aliyun-imm/update-figure-cluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The name of the project.[](~~478153~~) |
| DatasetName | string | yes | The name of the dataset.[](~~478160~~) |
| FigureCluster | string | yes | The information about the cluster (JSON-encoded) |

### Updates the partial metadata of the indexed files in a dataset
`POST https://apizie.tech/v1/cloud:aliyun-imm/update-file-meta` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The name of the project. You can obtain the name of the project from the response of the… |
| DatasetName | string | yes | The name of the dataset. You can obtain the name of the dataset from the response of the… |
| File | string | yes | The file and its metadata items to be updated. The value must be in the JSON format (JSON-encoded) |

### Updates a spatiotemporal cluster
`POST https://apizie.tech/v1/cloud:aliyun-imm/update-location-date-cluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The name of the project.[](~~478153~~) |
| DatasetName | string | yes | The name of the dataset.[](~~478160~~) |
| ObjectId | string | yes | The ID of the cluster that you want to update |
| Title | string | no | The name of the cluster. The name can be used to search for the cluster. The value can be up to 1,024 bytes in size |
| CustomId | string | no | The custom ID of the cluster. When the cluster is indexed into the dataset, the custom ID is stored as the data attribute. You can map the… |
| CustomLabels | string | no | The custom labels. The parameter stores custom key-value labels, which can be used to filter data. You can specify up to 100 custom labels… |

### Updates the information of an existing project
`POST https://apizie.tech/v1/cloud:aliyun-imm/update-project` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The name of the project. For more information about how to obtain the project name, see https://help.aliyun.com/document_detail/478153.html |
| ServiceRole | string | no | The service role that is authorized for Intelligent Media Management (IMM) to access other cloud resources such as Object Storage Service… |
| Description | string | no | The description of the project. The description must be 1 to 256 characters in length |
| TemplateId | string | no | The ID of the workflow template. For more information, see https://help.aliyun.com/document_detail/466304.html |
| ProjectMaxDatasetCount | integer | no | The maximum number of datasets in the project. Valid values: 1 to 1000000000 |
| DatasetMaxBindCount | integer | no | The maximum number of bindings per dataset. Valid values: 1 to 10 |
| DatasetMaxFileCount | integer | no | The maximum number of files per dataset. Valid values: 1 to 100000000 |
| DatasetMaxEntityCount | integer | no | The maximum number of metadata entities per dataset. Reserved parameter. No actual limit is imposed during use |
| DatasetMaxRelationCount | integer | no | The maximum number of metadata relations per dataset. Reserved parameter. No actual limit is imposed during use |
| DatasetMaxTotalFileSize | integer | no | The maximum total size of files in each dataset. If the limit is exceeded, no more indexes can be added. Unit: bytes |
| Tag | string | no | The list of tags (JSON-encoded) |

### Updates the information about a story, such as the story name and cover image
`POST https://apizie.tech/v1/cloud:aliyun-imm/update-story` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The name of the project |
| DatasetName | string | yes | The name of the dataset |
| ObjectId | string | yes | The ID of the story |
| StoryName | string | no | The name of the story |
| Cover | string | no | The cover image of the story (JSON-encoded) |
| CustomLabels | string | no | The custom tags. You can specify up to 100 custom tags (JSON-encoded) |
| CustomId | string | no | The custom ID |

### Updates information about a trigger, such as the input data source, data processing settings, and tags
`POST https://apizie.tech/v1/cloud:aliyun-imm/update-trigger` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The name of the project. You can obtain the name of the project from the response of the… |
| Id | string | yes | The ID of the trigger. You can obtain the ID of the trigger from the response of the https://help.aliyun.com/document_detail/479912.html… |
| Input | string | no | The data source configurations (JSON-encoded) |
| Actions | string | no | The processing templates (JSON-encoded) |
| Tags | string | no | The custom tags. You can search for or filter asynchronous tasks by custom tag (JSON-encoded) |

### version
`POST https://apizie.tech/v1/cloud:aliyun-imm/version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imm.ap-southeast-1.aliyuncs.com |

## Example
```
curl "https://apizie.tech/v1/cloud:aliyun-imm/add-image-mosaic" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud Intelligent Media Management API?
Create a free Apizie key, then send POST https://apizie.tech/v1/cloud:aliyun-imm/add-image-mosaic with the header x-api-key. Every endpoint returns { project, data, timestamp }.

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

### Can AI agents use the Alibaba Cloud Intelligent Media Management API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-imm.

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