# Alibaba Cloud Intelligent Cloud Editor API

> Alibaba Cloud Intelligent Cloud Editor API on Apizie: 400 endpoints (Activates a specified license based on the batch ID, authorization code, and device SN, Adds an ad insertion configuration, Creates a media asset category, Adds one or more materials to an editing project, …) 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-ice/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

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

Alibaba Cloud OpenAPI for Intelligent Cloud Editor (ice, version 2020-11-09). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Activates a specified license based on the batch ID, authorization code, and device SN
`POST https://apizie.tech/v1/cloud:aliyun-ice/active-ai-rtc-license` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| LicenseItemId | string | no | The batch ID |
| AuthCode | string | no | The authorization code |
| DeviceId | string | no | The device ID |

### Adds an ad insertion configuration
`POST https://apizie.tech/v1/cloud:aliyun-ice/add-ad-insertion` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| Name | string | yes | The name of the configuration. The name must be unique within the same account. It can be up to 128 characters in length and must match… |
| ClientToken | string | no | The client token that is used to ensure idempotence. The token must be unique for each request to prevent duplicate submissions. It can be… |
| ContentUrlPrefix | string | yes | The prefix of the content URL. The URL supports the HTTP and HTTPS protocols. It can be up to 512 characters in length |
| SlateAdUrl | string | no | The URL of the slate ad. The URL supports the HTTP and HTTPS protocols and only MP4 files (.mp4). It can be up to 2,048 characters in length |
| ConfigAliases | string | no | The dynamic configuration aliases. The value is a JSON string. You can add up to 20 player_params.{name} entries. The name part can be up… |
| CdnContentSegmentUrlPrefix | string | no | The CDN prefix for video content segments. The URL supports the HTTP and HTTPS protocols. It can be up to 512 characters in length |
| CdnAdSegmentUrlPrefix | string | no | The CDN prefix for ad segments. The URL supports the HTTP and HTTPS protocols. It can be up to 512 characters in length |
| AdMarkerPassthrough | string | no | Specifies whether to pass through ad markers. Default value: OFF |
| PersonalizationThreshold | integer | no | The personalization threshold. Unit: seconds. Default value: 8 |
| AdsUrl | string | yes | The URL of the ad decision server. The URL supports the HTTP and HTTPS protocols. It can be up to 2,048 characters in length |

### Creates a media asset category
`POST https://apizie.tech/v1/cloud:aliyun-ice/add-category` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| CateName | string | yes | The category name. The maximum length is 64 bytes. UTF-8 encoding |
| ParentId | integer | no | The parent category ID |
| Type | string | no | The category type. Valid values: default (default): audio, video, and image category. material: short video material category |

### Adds one or more materials to an editing project
`POST https://apizie.tech/v1/cloud:aliyun-ice/add-editing-project-materials` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| ProjectId | string | yes | The ID of the cloud editing project |
| MaterialMaps | string | yes | The material IDs. Separate multiple IDs with commas (,). A maximum of 10 material IDs are supported for each type. Valid values: "video":… |

### Adds all media assets to the favorites based on the specified media IDs
`POST https://apizie.tech/v1/cloud:aliyun-ice/add-favorite-public-media` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| MediaIds | string | no | The IDs of the IMS media assets. Separate multiple IDs with commas (,) |

### Creates an input for a MediaConnect flow instance
`POST https://apizie.tech/v1/cloud:aliyun-ice/add-media-connect-flow-input` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| FlowId | string | yes | The flow instance ID |
| InputProtocol | string | yes | The input type |
| InputName | string | yes | The name of the input |
| MaxBitrate | integer | no | The input bitrate, in bit/s |
| Cidrs | string | no | The IP address whitelist in CIDR format. Separate multiple CIDR blocks with commas (,) |
| InputFromUrl | string | no | The input URL. This parameter is required only when the input type is RTMP-PULL or SRT-Listener |
| PairFlowId | string | no | The ID of the peer flow. This parameter is required only when the input type is Flow |
| PairOutputName | string | no | The output name of the peer flow. This parameter is required only when the input type is Flow |
| SrtLatency | integer | no | The SRT latency. This parameter is required only when the input type is SRT-Listener or SRT-Caller |
| SrtPassphrase | string | no | The SRT encryption passphrase. This parameter is required only when the input type is SRT-Listener or SRT-Caller |
| SrtPbkeyLen | string | no | The SRT encryption key length. This parameter is required only when the input type is SRT-Listener or SRT-Caller |
| WithInternalVip | string | no | Specifies whether to return the internal stream pushing IP address. This parameter is valid only when you connect to the cloud through an… |

### Creates an output for a MediaConnect flow instance
`POST https://apizie.tech/v1/cloud:aliyun-ice/add-media-connect-flow-output` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| FlowId | string | yes | The flow instance ID |
| OutputProtocol | string | yes | The output protocol |
| OutputToUrl | string | no | The output URL. This parameter is required when the output type is RTMP-PUSH or SRT-Caller |
| OutputName | string | yes | The name of the output |
| Cidrs | string | no | The IP address whitelist in CIDR format. Separate multiple CIDR blocks with commas (,) |
| PlayerLimit | integer | no | The maximum number of concurrent players |
| PairInputName | string | no | The input name of the peer flow. This parameter is required when the output type is Flow |
| SrtLatency | integer | no | The SRT latency. This parameter is required only when the output type is SRT-Listener or SRT-Caller |
| SrtPbkeyLen | string | no | The SRT encryption key length. This parameter is required only when the output type is SRT-Listener or SRT-Caller |
| SrtPassphrase | string | no | The SRT encryption passphrase. This parameter is required only when the output type is SRT-Listener or SRT-Caller |
| PairFlowId | string | no | The peer flow instance ID. This parameter is required when the output type is Flow |

### Adds mark information to a media asset such as a video or audio file for subsequent retrieval, analysis, and…
`POST https://apizie.tech/v1/cloud:aliyun-ice/add-media-marks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| MediaId | string | yes | The media asset ID |
| MediaMarks | string | yes | The mark information. The string content must conform to the JSONArray format |

### Tags streaming media assets
`POST https://apizie.tech/v1/cloud:aliyun-ice/add-stream-tag-to-search-lib` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| SearchLibName | string | no | The search library |
| Namespace | string | no | The namespace |
| MediaId | string | no | The media asset ID |
| MsgBody | string | no | The message body for media asset information |

### Creates a template for intelligent media production, which supports the video clip feature based on standard…
`POST https://apizie.tech/v1/cloud:aliyun-ice/add-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| Name | string | no | The name of the template |
| Type | string | no | The templatetype. Valid values: Timeline: standard template. It is created based on the timeline of a video clip project, where multiple… |
| Config | string | no | The Config parameter for standard templates is an encapsulation based on the cloud editing timeline. Custom template configurations are… |
| CoverUrl | string | no | The URL of the template cover |
| PreviewMedia | string | no | The media asset ID of the template preview video |
| Status | string | no | The template status. Valid values: Available: Normal. Created: Created but unavailable. Uploading: Uploading. Processing: Analyzing the… |
| Source | string | no | The source from which the template is created. Valid values: OpenAPI: Created by calling an API operation. AliyunConsole: Created in the… |
| RelatedMediaids | string | no | The media assets associated with the template. This parameter is used by the standard template editor |

### Increases user credits
`POST https://apizie.tech/v1/cloud:aliyun-ice/add-yike-user-credit` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| YikeUserId | string | yes | The ID of the RAM user |
| Credit | integer | yes | The number of credits to increase. The value must be greater than 0 |

### Updates the search index information, such as the index status or index configuration
`POST https://apizie.tech/v1/cloud:aliyun-ice/alter-search-index` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| SearchLibName | string | no | The name of the search library. If you do not specify the search library name, the search index is created in the default search library… |
| IndexType | string | yes | The index type. Valid values: mm: Large model. face: Face. aiLabel: Intelligent tag |
| IndexStatus | string | no | The index status. Default value: Active. Valid values: Active: Activated. Deactive: Deactivated. You must specify either the IndexStatus… |
| IndexConfig | string | no | The index configuration. You must specify either the IndexStatus or IndexConfig parameter.> |

### Updates a search library
`POST https://apizie.tech/v1/cloud:aliyun-ice/alter-search-lib` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| SearchLibName | string | yes | The search library |
| SearchLibConfig | string | no | The search library configuration in JSON string format. It includes the following fields: faceGroupIds: the IDs of self-registered face… |

### Ingests multiple assets for VOD packaging
`POST https://apizie.tech/v1/cloud:aliyun-ice/batch-create-vod-packaging-asset` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| Assets | string | no | The assets that you want to ingest (JSON-encoded) |
| GroupName | string | no | The name of the packaging group |

### Retrieves the information of one or more media assets
`POST https://apizie.tech/v1/cloud:aliyun-ice/batch-get-media-infos` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| MediaIds | string | no | The IDs of the media assets to query, separated by commas |
| AdditionType | string | no | The additional information about the media assets to query. By default, only BasicInfo is returned. Additional file information includes:… |
| AuthTimeout | integer | no | The authentication expiration time, in seconds. Minimum value: 1. Maximum value: 86400. Default value: 3600 |

### Retrieves multiple Yike AI application generation tasks
`POST https://apizie.tech/v1/cloud:aliyun-ice/batch-get-yike-aiapp-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| JobIds | string | no | The list of task IDs. Separate multiple IDs with commas |

### Retrieves media asset information in batches
`POST https://apizie.tech/v1/cloud:aliyun-ice/batch-get-yike-asset-media-infos` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| MediaIds | string | no | The IDs of the media assets to query, separated by commas |

### Cancels a DNA job
`POST https://apizie.tech/v1/cloud:aliyun-ice/cancel-dnajob` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| JobId | string | yes | The ID of the DNA job to cancel |

### Removes all media assets from favorites based on the specified list of media IDs
`POST https://apizie.tech/v1/cloud:aliyun-ice/cancel-favorite-public-media` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| MediaIds | string | no | The IDs of the IMS media assets. Separate multiple IDs with commas |

### Cancels an intelligent production job
`POST https://apizie.tech/v1/cloud:aliyun-ice/cancel-iproduction-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| JobId | string | yes | The ID of the intelligent production job |
| ClientToken | string | no | The idempotency token |

### Purges the voiceprint corresponding to the voiceprint ID
`POST https://apizie.tech/v1/cloud:aliyun-ice/clear-aiagent-voiceprint` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| VoiceprintId | string | no | The identity identifier used to uniquely identify a voiceprint |
| RegistrationMode | string | no | The voiceprint registration mode. Default value: Explicit |

### Disables the dual-stream disaster recovery feature for a MediaConnect instance
`POST https://apizie.tech/v1/cloud:aliyun-ice/close-media-connect-flow-failover` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| FlowId | string | no | The MediaConnect instance ID |

### Disables streaming media assets and stops tagging and analysis
`POST https://apizie.tech/v1/cloud:aliyun-ice/close-stream-to-search-lib` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| SearchLibName | string | no | The search library |
| Namespace | string | no | The namespace |
| MediaId | string | no | The media asset ID |

### Submits a manual review for a media asset by calling CreateAudit
`POST https://apizie.tech/v1/cloud:aliyun-ice/create-audit` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| AuditContent | string | yes | The array of review content. A maximum of 20 videos can be reviewed at a time. Convert the array to a string before passing it as the… |

### Creates a digital human training task and configures the basic information and training material information…
`POST https://apizie.tech/v1/cloud:aliyun-ice/create-avatar-training-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| AvatarName | string | yes | The name of the digital human. The name can be up to 7 characters in length |
| AvatarDescription | string | no | The description of the digital human. The description can be up to 1000 characters in length |
| AvatarType | string | no | The type of the digital human |
| Thumbnail | string | no | The thumbnail URL. After training succeeds, the thumbnail is uploaded to this address. The URL must be a valid public OSS URL under the… |
| Portrait | string | no | The media asset ID of the avatar image. The ID is 32 characters in length. If you subsequently call SubmitAvatarTrainingJob to submit the… |
| Video | string | no | The media asset ID of the training video. The ID is 32 characters in length. Supported formats: mp4, mov, and webm. The duration of the… |
| Transparent | string | no | Specifies whether the training video supports a transparent channel. Make sure that this setting is consistent with the submitted training… |

### Creates a channel in MediaWeaver
`POST https://apizie.tech/v1/cloud:aliyun-ice/create-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| ChannelName | string | yes | The name of the channel |
| ChannelTier | string | yes | The tier of the channel. Valid values: basic and standard |
| PlaybackMode | string | yes | The playback mode. Valid values: loop and linear |
| AccessPolicy | string | no | Specifies whether to enable access control |
| AccessToken | string | no | The token for accessing the channel |
| FillerSourceLocationName | string | no | The source location of the filler slate |
| FillerSourceName | string | no | The name of the filler slate |
| OutPutConfigList | string | yes | The channel output configurations |

### Creates a custom media processing template
`POST https://apizie.tech/v1/cloud:aliyun-ice/create-custom-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| Name | string | yes | The name of the template |
| Type | integer | yes | The templatetype. Valid values: 1: transcoding template 2: snapshot template 3: animated image template 4: image watermark template 5:… |
| Subtype | integer | no | The subtype of the template. Subtypes of transcoding templates: 1: normal transcoding template (Normal) 2: audio transcoding template… |
| TemplateConfig | string | yes | The template configuration. For detailed metric description, see https://help.aliyun.com/document_detail/448291.html |

### Creates a voice cloning task to initialize the basic configuration information for the task
`POST https://apizie.tech/v1/cloud:aliyun-ice/create-customized-voice-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| VoiceId | string | yes | The custom voice ID (English name or pinyin of the voice). The ID cannot be the same as any of your other custom voice IDs. The ID cannot… |
| VoiceName | string | no | The voice name (generally a Chinese name). The name cannot exceed 32 characters |
| VoiceDesc | string | no | The voice description. The description cannot exceed 256 characters |
| Gender | string | yes | The gender. Valid values: female: female. male: male |
| Scenario | string | yes | The scenario. Valid values: story: story. interaction: interaction. navigation: navigation |

### Creates a DNA library
`POST https://apizie.tech/v1/cloud:aliyun-ice/create-dnadb` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| Name | string | yes | The name of the DNA library |
| Model | string | no | The model of the DNA library. Valid values: Video: Video. Audio: Audio. Image: [Deprecated] Image. Text: [Deprecated] Text. Supported only… |
| Description | string | no | The description of the DNA library |

### Creates a cloud editing project. You can set the title, description, timeline, and cover of the project
`POST https://apizie.tech/v1/cloud:aliyun-ice/create-editing-project` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| Title | string | yes | The title of the cloud editing project |
| Description | string | no | The description of the cloud editing project |
| Timeline | string | no | The timeline of the cloud editing project in JSON format |
| CoverURL | string | no | The cover of the cloud editing project |
| TemplateId | string | no | The template ID. You can use a template to quickly build a timeline. You must specify either Timeline or TemplateId, but not both. If… |
| ClipsParam | string | no | The material parameters for the template in JSON format. If TemplateId is specified, ClipsParam must also be specified. For more… |
| TemplateType | string | no | The templatetype. This parameter is required when you create a cloud editing project based on a template. Default value: Timeline. Valid… |
| MaterialMaps | string | no | The materials associated with the project. Separate multiple material IDs with commas (,). You can associate up to 10 material IDs of each… |
| BusinessConfig | string | no | The business configuration of the project. You can ignore this parameter for standard editing projects. If the project is a live streaming… |
| ProjectType | string | no | The type of the editing project. EditingProject: standard editing project. LiveEditingProject: live streaming editing project |

### Creates a hotword library
`POST https://apizie.tech/v1/cloud:aliyun-ice/create-hotword-library` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| Name | string | yes | The name of the hotword library. The maximum length is 100 characters |
| Description | string | no | The description of the hotword library. The maximum length is 200 characters |
| UsageScenario | string | yes | The scenarios of the hotword library. Valid values: ASR: ASR intelligent text recognition. StructuredMediaAssets: structured media assets.… |
| Hotwords | string | yes | The list of hotwords. The maximum number of hotwords is 300 (JSON-encoded) |

### Creates an IPC order to share capacity at the account level
`POST https://apizie.tech/v1/cloud:aliyun-ice/create-ipc-order` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| DeviceId | string | no | The device ID |
| Capability | string | no | The capability. Valid values: understand: Image understanding. Supports 300 image understanding tasks per day. understand-reid: Image… |
| Period | string | no | The subscription period. Valid values: month: Monthly subscription, calculated as 30 days. quarter: Quarterly subscription, calculated as… |

### Generates a real-time video stream processing channel that supports the HLS protocol and automatically…
`POST https://apizie.tech/v1/cloud:aliyun-ice/create-live-package-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| GroupName | string | yes | The channel group name. The name can contain only uppercase and lowercase letters, digits, hyphens, and underscores. The name must be 1 to… |
| SegmentCount | integer | no | The number of m3u8 segments for the input stream. Valid values: 2 to 100 |
| Description | string | no | The description. The description can be up to 1000 characters in length |
| SegmentDuration | integer | no | The segment duration of the input stream, in seconds. Valid values: 1 to 30 |
| ChannelName | string | yes | The channel name. The name can contain only uppercase and lowercase letters, digits, hyphens, and underscores. The name must be 1 to 200… |
| ClientToken | string | no | The idempotency token |
| Protocol | string | yes | The input protocol. Currently, only HLS is supported |

### Creates a channel group for the live packaging service with a custom name and description
`POST https://apizie.tech/v1/cloud:aliyun-ice/create-live-package-channel-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| GroupName | string | yes | The name of the channel group. The name must be 1 to 200 characters in length, and can contain only uppercase and lowercase letters,… |
| ClientToken | string | no | The idempotency parameter |
| Description | string | no | The description of the channel group. The description can be up to 1,000 characters in length |

### Adds the origin endpoint configuration for a live streaming channel, supporting the HLS, HLS_CMAF, and DASH…
`POST https://apizie.tech/v1/cloud:aliyun-ice/create-live-package-origin-endpoint` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| GroupName | string | yes | The name of the channel group |
| ChannelName | string | yes | The name of the channel |
| EndpointName | string | yes | The name of the origin endpoint. The name must be 1 to 200 characters in length, and can contain only letters, digits, hyphens (-), and… |
| Protocol | string | yes | The distribution protocol |
| ManifestName | string | no | The name of the manifest. Default value: manifest |
| Description | string | no | The description of the endpoint |
| TimeshiftVision | integer | no | The timeshift duration in days. Maximum value: 30. Default value: 0, which indicates that timeshift is not supported |
| AuthorizationCode | string | no | The authorization code. You must specify at least one of AuthorizationCode and IpWhitelist. The code can be up to 200 characters in… |
| IpWhitelist | string | no | The IP address whitelist. Subnet masks are supported. You cannot configure 0.0.0.0/0. Separate multiple IP addresses with commas (,). You… |
| IpBlacklist | string | no | The IP blacklist. Subnet masks are supported. You cannot configure 0.0.0.0/0. Separate multiple IP addresses with commas (,). The… |
| ClientToken | string | no | The idempotency parameter |
| LivePackagingConfig | string | no | The live packaging configuration (JSON-encoded) |

### Creates a live recording template to facilitate the submission of live recording tasks
`POST https://apizie.tech/v1/cloud:aliyun-ice/create-live-record-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| RecordFormat | string | yes | The list of recording formats (JSON-encoded) |
| Name | string | yes | The name of the template |

### Creates a live snapshot template that can be used to create snapshot tasks
`POST https://apizie.tech/v1/cloud:aliyun-ice/create-live-snapshot-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| TemplateName | string | yes | The template name. Maximum length: 128 |
| OverwriteFormat | string | no | The overwrite snapshot file format. The value cannot start with "/". Only the .jpg suffix is supported. Maximum length: 255. Supported… |
| SequenceFormat | string | no | The sequence snapshot file format. The value cannot start with "/". Only the .jpg suffix is supported. Maximum length: 255. Supported… |
| TimeInterval | integer | yes | The snapshot time interval. Unit: seconds. Valid values: 5 to 3600 |

### Creates a real-time transcoding template for submitting real-time transcoding jobs
`POST https://apizie.tech/v1/cloud:aliyun-ice/create-live-transcode-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| Type | string | yes | The template type. Valid values: normal: Normal template. narrow-band: Narrowband HD template. audio-only: Audio-only template. origin:… |
| Name | string | yes | The template name |
| TemplateConfig | string | no | The template configuration. The parameter requirements vary based on the template type (Type). If the Type parameter is set to normal, you… |

### Creates a MediaConnect flow
`POST https://apizie.tech/v1/cloud:aliyun-ice/create-media-connect-flow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| FlowName | string | yes | The flow name |
| FlowRegion | string | yes | The region in which the flow resides |

### Creates a MediaLive channel
`POST https://apizie.tech/v1/cloud:aliyun-ice/create-media-live-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| Name | string | yes | The name of the channel. Letters, digits, hyphens (-), and underscores (_) are supported. It can be up to 64 characters in length |
| InputAttachments | string | yes | The associated inputs (JSON-encoded) |
| OutputGroups | string | yes | The output groups (JSON-encoded) |
| AudioSettings | string | no | The audio settings (JSON-encoded) |
| VideoSettings | string | no | The video settings (JSON-encoded) |

### Create a live media input
`POST https://apizie.tech/v1/cloud:aliyun-ice/create-media-live-input` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| Name | string | yes | The name of the input. Letters, digits, hyphens (-), and underscores (_) are supported. It can be up to 64 characters in length |
| Type | string | yes | The input type. Valid values: RTMP_PUSH, RTMP_PULL, SRT_PUSH, SRT_PULL, and MEDIA_CONNECT |
| SecurityGroupIds | string | no | The IDs of the security groups to be associated with the input. This parameter is required for PUSH inputs (JSON-encoded) |
| InputSettings | string | yes | The input settings. An input can have up to two sources: primary and backup sources (JSON-encoded) |

### Creates a security group in MediaLive
`POST https://apizie.tech/v1/cloud:aliyun-ice/create-media-live-input-security-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| Name | string | yes | The name of the security group. Letters, digits, hyphens (-), and underscores (_) are supported. The maximum length is 64 characters |
| WhitelistRules | string | yes | The security group rules (JSON-encoded) |

### Creates a media processing pipeline to automate and batch process media files
`POST https://apizie.tech/v1/cloud:aliyun-ice/create-pipeline` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| Name | string | yes | The name of the pipeline |
| Speed | string | yes | The type of the pipeline. Valid values: Standard: standard pipeline Boost: accelerated transcoding pipeline NarrowBandHDV2: Narrowband HD… |
| Priority | integer | no | The priority of the pipeline. Valid values: 1 to 10. Default value: 6. A larger value indicates a higher priority |

### Creates a program in a MediaWeaver channel
`POST https://apizie.tech/v1/cloud:aliyun-ice/create-program` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| ProgramName | string | yes | The name of the program |
| ChannelName | string | yes | The name of the channel |
| SourceType | string | yes | The source type of the program |
| SourceLocationName | string | yes | The source location |
| SourceName | string | yes | The name of the source |
| Transition | string | yes | The program transition method |
| ClipRange | string | no | Extracts a clip from the source |
| AdBreaks | string | no | The information about ad breaks |

### Creates a new entity to be recognized in a specified custom recognition library. You can use this operation…
`POST https://apizie.tech/v1/cloud:aliyun-ice/create-recognition-entity` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| Algorithm | string | yes | The recognition type. Valid values: landmark: custom landmark object: custom object logo: custom logo face: custom face label: custom label |
| LibId | string | yes | The ID of the recognition library. You can call the https://help.aliyun.com/document_detail/2926699.html operation to obtain the ID |
| EntityName | string | yes | The name of the custom recognition entity. The name can be up to 64 bytes in length |
| EntityInfo | string | no | The additional information about the custom recognition entity. The value is a JSON string and can be up to 256 bytes in length |

### Creates a custom recognition library to store entity information for recognition
`POST https://apizie.tech/v1/cloud:aliyun-ice/create-recognition-lib` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| Algorithm | string | yes | The recognition type. Valid values: landmark: custom landmark object: custom object logo: custom logo face: custom face label: custom label |
| LibName | string | yes | The name of the recognition library. The name can be up to 64 bytes in length |
| LibDescription | string | no | The description of the recognition library. The description can be up to 128 bytes in length |

### Adds recognition sample images or text labels to a specified custom entity for subsequent recognition and…
`POST https://apizie.tech/v1/cloud:aliyun-ice/create-recognition-sample` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| Algorithm | string | yes | The recognition type. Valid values: landmark: custom landmark object: custom object logo: custom logo face: custom face label: custom label |
| LibId | string | yes | The ID of the recognition library |
| EntityId | string | yes | The ID of the entity |
| ImageUrl | string | no | The URL of the sample image |
| LabelPrompt | string | no | The text prompt for the custom label |

### Creates a search index in a search library. A search library can contain multiple search indexes of…
`POST https://apizie.tech/v1/cloud:aliyun-ice/create-search-index` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| SearchLibName | string | no | The name of the search library. If you do not specify a search library name, the search index is created in the default IMS search… |
| IndexType | string | yes | The index type. Valid values: mm: large model visual state. Used to describe complex visual features and actions in videos. This type… |
| IndexStatus | string | no | The index status. Default value: Active. Valid values: Active: activated. Deactive: deactivated |
| IndexConfig | string | no | The index configuration |

### Creates a search media library. You can use the library to store media assets
`POST https://apizie.tech/v1/cloud:aliyun-ice/create-search-lib` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| SearchLibName | string | yes | The name of the search library. The name must be a combination of letters and digits. For network monitoring camera (IPC) scenarios, the… |
| SearchLibConfig | string | no | The configuration of the search library. The value is in JSON string format. Fields: faceGroupIds: the IDs of self-registered face… |

### Creates a source in MediaWeaver
`POST https://apizie.tech/v1/cloud:aliyun-ice/create-source` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| SourceLocationName | string | yes | The name of the source location |
| SourceType | string | yes | The source type. Valid values: vodSource and liveSource |
| SourceName | string | yes | The name of the source |
| HttpPackageConfigurations | string | yes | The source configurations |

### Creates a source location
`POST https://apizie.tech/v1/cloud:aliyun-ice/create-source-location` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| SourceLocationName | string | yes | The name of the source location |
| BaseUrl | string | yes | The protocol and hostname of the source location |
| EnableSegmentDelivery | string | no | Specifies whether to use an independent domain name to access the segments |
| SegmentDeliveryUrl | string | no | The domain name used to access the segments |

### Registers a live stream as a media asset
`POST https://apizie.tech/v1/cloud:aliyun-ice/create-stream-to-search-lib` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| SearchLibName | string | no | The search library |
| Namespace | string | no | The namespace |
| Input | string | no | The URL of the live stream to be ingested and analyzed |

### Retrieves the upload URL and credential for audio, video, image, and auxiliary media assets, and creates…
`POST https://apizie.tech/v1/cloud:aliyun-ice/create-upload-media` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| AppId | string | no | The application ID. Default value: app-1000000 |
| EntityId | string | no | The entity ID. You can call the CreateEntity operation to create an entity and customize the dynamic metadata structure |
| FileInfo | string | no | The file information in JSON format. This parameter contains the following fields: Type (required): the file type. Valid values: video,… |
| UserData | string | no | The custom settings. The value is a JSON string that supports settings such as message callbacks |
| UploadTargetConfig | string | no | The destination storage address. StorageType: only oss is supported. StorageLocation: only VOD storage is supported. User-owned OSS… |
| MediaMetaData | string | no | The metadata of the media asset to upload, in JSON format. Title (required): The maximum length is 128 characters. UTF-8 encoded.… |
| PostProcessConfig | string | no | Specifies the post-upload processing action when Type = video or audio. ProcessType: set to Workflow. This parameter triggers an… |

### Obtains the upload URL and credential of a media stream
`POST https://apizie.tech/v1/cloud:aliyun-ice/create-upload-stream` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| MediaId | string | no | The ID of the media asset |
| Definition | string | no | The quality of the media stream. Valid values: FD: low definition. LD: standard definition. SD: high definition. HD: ultra-high… |
| FileExtension | string | no | The file name extension of the media stream |
| HDRType | string | no | The high dynamic range (HDR) format of the transcoded stream. Valid values: HDR HDR10 HLG DolbyVision HDRVivid SDR+ The value is not… |
| UserData | string | no | The user data |

### Ingests an asset for VOD packaging
`POST https://apizie.tech/v1/cloud:aliyun-ice/create-vod-packaging-asset` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| GroupName | string | no | The name of the packaging group |
| AssetName | string | no | The name of the asset. The name must be unique and can be up to 128 characters in length. Letters, digits, underscores (_), and hyphens… |
| Description | string | no | The asset description |
| Input | string | no | The asset input configurations (JSON-encoded) |
| ContentId | string | no | The content ID in the digital rights management (DRM) system. The maximum length is 256 characters. Letters, digits, underscores (_), and… |

### Creates a VOD packaging configuration
`POST https://apizie.tech/v1/cloud:aliyun-ice/create-vod-packaging-configuration` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| GroupName | string | no | The name of the packaging group. The name can be up to 128 characters in length. Letters, digits, underscores (_), and hyphens (-) are… |
| ConfigurationName | string | no | The name of the packaging configuration. The name must be unique in an account and can be up to 128 characters in length. Letters, digits,… |
| Protocol | string | no | The package type. HLS: packages content into TS segments for delivery over the HLS protocol. HLS_CMAF: packages content into CMAF segments… |
| Description | string | no | The description of the packaging configuration |
| PackageConfig | string | no | The packaging configuration (JSON-encoded) |

### Creates a VOD packaging group
`POST https://apizie.tech/v1/cloud:aliyun-ice/create-vod-packaging-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| GroupName | string | no | The name of the packaging group. The name must be unique in an account and can be up to 128 characters in length. Letters, digits,… |
| Description | string | no | The packaging group description |

### Retrieves the upload credentials for a media asset
`POST https://apizie.tech/v1/cloud:aliyun-ice/create-yike-asset-upload` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| FileExt | string | yes | The file extension |
| FileType | string | no | The file type. Default value: Media |

### Creates a Yike production
`POST https://apizie.tech/v1/cloud:aliyun-ice/create-yike-production` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| Title | string | yes | The title of the Yike production |
| WorkspaceId | string | no | The ID of the workspace |

### Creates a Yike user
`POST https://apizie.tech/v1/cloud:aliyun-ice/create-yike-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| WorkspaceId | string | yes | The workspace ID |
| UserNamePrefix | string | yes | The user name prefix for the sub-account. The prefix must meet the following requirements: The prefix can be up to 50 characters long and… |
| Nickname | string | yes | The user's nickname |
| Password | string | yes | The user's password |
| ProductionIds | string | yes | The IDs of productions to add the user to. You can specify multiple IDs separated by commas. A user can be added to multiple productions |

### Creates a workspace
`POST https://apizie.tech/v1/cloud:aliyun-ice/create-yike-workspace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| Title | string | yes | The project title |
| UserCountLimit | integer | yes | The maximum number of users in the workspace team |

### Performs decryption on the CiphertextBlob ciphertext in a KMS data key (DK)
`POST https://apizie.tech/v1/cloud:aliyun-ice/decrypt-kmsdata-key` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| CiphertextBlob | string | yes | The ciphertext to be decrypted |

### Deletes dialog records of an AI agent
`POST https://apizie.tech/v1/cloud:aliyun-ice/delete-aiagent-dialogue` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| SessionId | string | yes | The session ID |
| DialogueId | string | yes | The ID of the dialogue to delete |
| NodeId | string | no | The ID of the node to delete |

### Deletes an ad insertion configuration
`POST https://apizie.tech/v1/cloud:aliyun-ice/delete-ad-insertion` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| Name | string | yes | The name of the configuration that you want to delete |

### Deletes a digital human training task that is in the init (draft) or training failed status
`POST https://apizie.tech/v1/cloud:aliyun-ice/delete-avatar-training-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| JobId | string | yes | The ID of the digital human training task |

### Deletes a media asset category
`POST https://apizie.tech/v1/cloud:aliyun-ice/delete-category` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| CateId | integer | yes | The category ID. You can obtain the category ID by using the following methods: Log on to the IMS console… |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| ChannelName | string | yes | The name of the channel |

### Deletes a custom template
`POST https://apizie.tech/v1/cloud:aliyun-ice/delete-custom-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| TemplateId | string | yes | The ID of the custom template |

### Deletes a voice cloning task that is not in the "Training" or "Training Succeeded" state
`POST https://apizie.tech/v1/cloud:aliyun-ice/delete-customized-voice-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| JobId | string | yes | The ID of the voice cloning task |

### Deletes a DNA library
`POST https://apizie.tech/v1/cloud:aliyun-ice/delete-dnadb` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| DBId | string | yes | The ID of the DNA library to delete |

### Deletes DNA files by calling DeleteDNAFiles
`POST https://apizie.tech/v1/cloud:aliyun-ice/delete-dnafiles` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| DBId | string | yes | The ID of the DNA library from which you want to delete files |
| PrimaryKeys | string | yes | The primary keys of the files that you want to delete. Separate multiple primary keys with commas (,). You can delete up to 50 files at a… |

### Deletes one or more materials from an online editing project
`POST https://apizie.tech/v1/cloud:aliyun-ice/delete-editing-project-materials` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| ProjectId | string | yes | The ID of the online editing project |
| MaterialIds | string | yes | The IDs of the materials. Separate multiple material IDs with commas (,). You can specify up to 10 material IDs |
| MaterialType | string | yes | The type of the material. Valid values: video image audio subtitle text |

### Deletes one or more online editing project
`POST https://apizie.tech/v1/cloud:aliyun-ice/delete-editing-projects` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| ProjectIds | string | no | The ID of the online editing project. You can specify multiple IDs separated with commas (,) |

### Deletes a specified hotword library based on the ID
`POST https://apizie.tech/v1/cloud:aliyun-ice/delete-hotword-library` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| HotwordLibraryId | string | no | The ID of the hotword library that you want to delete |

### Deletes a live package channel by GroupName and ChannelName
`POST https://apizie.tech/v1/cloud:aliyun-ice/delete-live-package-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| GroupName | string | yes | The channel group name |
| ChannelName | string | yes | The channel name |

### Deletes a live package channel group by name
`POST https://apizie.tech/v1/cloud:aliyun-ice/delete-live-package-channel-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| GroupName | string | yes | The channel group name |

### Deletes an origin endpoint associated with a live package channel
`POST https://apizie.tech/v1/cloud:aliyun-ice/delete-live-package-origin-endpoint` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| GroupName | string | yes | The channel group name |
| ChannelName | string | yes | The channel name |
| EndpointName | string | yes | The endpoint name |

### Deletes live stream recording files. You can choose to delete only the recording files or delete both the…
`POST https://apizie.tech/v1/cloud:aliyun-ice/delete-live-record-files` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| RecordIds | string | yes | The collection of IDs of recording files (JSON-encoded) |
| RemoveFile | string | no | Specifies whether to delete the original files in OSS |

### Deletes a live stream recording template without affecting existing jobs
`POST https://apizie.tech/v1/cloud:aliyun-ice/delete-live-record-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| TemplateId | string | yes | The ID of the template to be deleted. To obtain the template ID, log on to the Intelligent Media Services (IMS) console… |

### Deletes live snapshot files. You can choose to delete only the records or both the records and the original…
`POST https://apizie.tech/v1/cloud:aliyun-ice/delete-live-snapshot-files` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| JobId | string | yes | The ID of the snapshot job |
| CreateTimestampList | string | yes | The list of creation timestamps. You can delete up to 200 files at a time (JSON-encoded) |
| DeleteOriginalFile | string | no | Specifies whether to delete the original file. Default value: false |

### Deletes a live stream snapshot template
`POST https://apizie.tech/v1/cloud:aliyun-ice/delete-live-snapshot-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| TemplateId | string | yes | The template ID |

### Deletes a specified real-time transcoding task
`POST https://apizie.tech/v1/cloud:aliyun-ice/delete-live-transcode-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| JobId | string | yes | The transcoding task ID |

### Deletes a real-time transcoding template
`POST https://apizie.tech/v1/cloud:aliyun-ice/delete-live-transcode-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| TemplateId | string | yes | The template ID. You can obtain the template ID from the Intelligent Media Services console (https://ice.console.aliyun.com/summary) by… |

### Deletes a MediaConnect flow
`POST https://apizie.tech/v1/cloud:aliyun-ice/delete-media-connect-flow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| FlowId | string | yes | The flow ID |

### Delete the input of a specific MediaConnect instance
`POST https://apizie.tech/v1/cloud:aliyun-ice/delete-media-connect-flow-input` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| FlowId | string | yes | The flow ID |
| InputName | string | no | Input name. Required when primary/standby input is enabled for the instance |

### Deletes an output of a MediaConnect flow
`POST https://apizie.tech/v1/cloud:aliyun-ice/delete-media-connect-flow-output` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| FlowId | string | yes | The flow ID |
| OutputName | string | yes | The name of the output that you want to delete |

### Delete the specified media asset from the search library
`POST https://apizie.tech/v1/cloud:aliyun-ice/delete-media-from-search-lib` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| SearchLibName | string | no | The name of the search library. Default value: ims-default-search-lib |
| MediaId | string | yes | The ID of the media asset |
| MsgBody | string | no | The message body |
| Namespace | string | no | Namespace |

### Deletes media asset information in batches. A maximum of 20 media assets can be deleted at a time. If…
`POST https://apizie.tech/v1/cloud:aliyun-ice/delete-media-infos` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| MediaIds | string | no | The IMS media asset IDs. Separate multiple IDs with commas (,). If the MediaIds parameter is empty, the InputURLs parameter must not be… |
| InputURLs | string | no | The URLs of the media assets to be deleted in the corresponding system. The files corresponding to the URLs must be registered in IMS… |
| DeletePhysicalFiles | string | no | Specifies whether to delete the physical files of the media assets. If the storage address of a media asset is a user-owned OSS bucket,… |

### Deletes a MediaLive channel
`POST https://apizie.tech/v1/cloud:aliyun-ice/delete-media-live-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| ChannelId | string | yes | The ID of the channel |

### Deletes a MediaLive input
`POST https://apizie.tech/v1/cloud:aliyun-ice/delete-media-live-input` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| InputId | string | yes | The ID of the input |

### Deletes a security group in MediaLive
`POST https://apizie.tech/v1/cloud:aliyun-ice/delete-media-live-input-security-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| SecurityGroupId | string | yes | The ID of the security group |

### Deletes the mark information of a media asset
`POST https://apizie.tech/v1/cloud:aliyun-ice/delete-media-marks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| MediaId | string | no | The media asset ID |
| MediaMarkIds | string | no | The mark IDs. Multiple values are supported and separated by commas. If MediaMarkIds is empty, all mark information of the media asset is… |

### Deletes an ApsaraVideo Media Processing (MPS) queue
`POST https://apizie.tech/v1/cloud:aliyun-ice/delete-pipeline` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| PipelineId | string | yes | The ID of the MPS queue |

### Deletes media streams such as video streams and audio streams
`POST https://apizie.tech/v1/cloud:aliyun-ice/delete-play-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| MediaId | string | no | The ID of the media asset |
| FileURLs | string | no | The URL of the media stream file that you want to delete. Separate multiple URLs with commas (,) |
| DeletePhysicalFiles | string | no | Specifies whether to delete the physical file of the media stream. If the media asset is stored in your own Object Storage Service (OSS)… |

### Deletes a program from a channel
`POST https://apizie.tech/v1/cloud:aliyun-ice/delete-program` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| ProgramName | string | yes | The name of the program |
| ChannelName | string | yes | The name of the channel |

### Deletes an entity from the specified custom recognition library
`POST https://apizie.tech/v1/cloud:aliyun-ice/delete-recognition-entity` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| Algorithm | string | yes | The type of recognition algorithm associated with the entity. Valid values: landmark object logo face label |
| LibId | string | yes | The ID of the recognition library |
| EntityId | string | yes | The ID of the entity to be deleted |

### Deletes a specified custom recognition library, including all entities and sample data in the library
`POST https://apizie.tech/v1/cloud:aliyun-ice/delete-recognition-lib` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| Algorithm | string | yes | The recognition type. Valid values: landmark: custom landmark object: custom object logo: custom logo face: custom face label: custom label |
| LibId | string | yes | The ID of the recognition library |

### Deletes a sample for a custom entity
`POST https://apizie.tech/v1/cloud:aliyun-ice/delete-recognition-sample` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| Algorithm | string | yes | The type of recognition algorithm. Valid values: landmark object logo face label |
| LibId | string | yes | The ID of the recognition library |
| EntityId | string | yes | The ID of the entity |
| SampleId | string | yes | The ID of the sample that you want to delete |

### Deletes an intelligent production job by job ID
`POST https://apizie.tech/v1/cloud:aliyun-ice/delete-smart-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| JobId | string | no | The job ID. Separate multiple job IDs with commas |

### Deletes a source from MediaWeaver
`POST https://apizie.tech/v1/cloud:aliyun-ice/delete-source` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| SourceLocationName | string | yes | The name of the source location |
| SourceType | string | yes | The source type. Valid values: vodSource and liveSource |
| SourceName | string | yes | The name of the source |
| SoftDelete | string | no | Specifies whether to use delete markers |

### Deletes a source location
`POST https://apizie.tech/v1/cloud:aliyun-ice/delete-source-location` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| SourceLocationName | string | yes | The name of the source location |
| SoftDelete | string | no | The soft delete flag |

### Deletes templates
`POST https://apizie.tech/v1/cloud:aliyun-ice/delete-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| TemplateIds | string | no | The IDs of the templates that you want to delete. Separate multiple IDs with commas (,) |

### Deletes a VOD packaging asset
`POST https://apizie.tech/v1/cloud:aliyun-ice/delete-vod-packaging-asset` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| AssetName | string | no | The name of the VOD packaging asset |

### Deletes the VOD packaging configuration
`POST https://apizie.tech/v1/cloud:aliyun-ice/delete-vod-packaging-configuration` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| ConfigurationName | string | no | The name of the VOD packaging configuration |

### Deletes a VOD packaging group
`POST https://apizie.tech/v1/cloud:aliyun-ice/delete-vod-packaging-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| GroupName | string | no | The name of the packaging group |

### Deletes media asset information
`POST https://apizie.tech/v1/cloud:aliyun-ice/delete-yike-asset-media-infos` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| MediaIds | string | no | The media asset IDs. Separate multiple IDs with commas (,) |
| LogicDelete | string | no | Specifies whether to logically delete the media asset information and files. Valid values: true (default): logically deletes the media… |

### Queries an instance
`POST https://apizie.tech/v1/cloud:aliyun-ice/describe-aiagent-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The agent instance ID. InstanceId is the unique ID returned after the agent instance is successfully started. For more information about… |

### Queries the usage of IMS VOD video editing. The maximum query range is 31 days, and you can query data from…
`POST https://apizie.tech/v1/cloud:aliyun-ice/describe-meter-ims-edit-usage` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| StartTs | integer | yes | The start timestamp. The value is a 10-digit UNIX timestamp |
| EndTs | integer | yes | The end timestamp. The value is a 10-digit UNIX timestamp |
| Interval | integer | yes | The time granularity of the query. Valid values: 3600: hourly 86400: daily |
| Region | string | no | This parameter does not take effect. By default, the usage of all regions is returned |

### Queries the metering data for MPS UHD transcoding in IMS. The maximum query time range is 31 days, and data…
`POST https://apizie.tech/v1/cloud:aliyun-ice/describe-meter-ims-media-convert-uhdusage` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| StartTs | integer | yes | The start timestamp, which is a 10-digit UNIX timestamp |
| EndTs | integer | yes | The end timestamp, which is a 10-digit UNIX timestamp |
| RegionId | string | no | This parameter does not take effect. By default, the usage data for all regions is returned |
| Interval | string | yes | The time granularity of the query. Valid values: 3600: hourly 86400: daily |

### Queries the metering data for video-on-demand (VOD) transcoding in Intelligent Media Services (IMS). The…
`POST https://apizie.tech/v1/cloud:aliyun-ice/describe-meter-ims-media-convert-usage` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| StartTs | integer | yes | The start timestamp, which is a 10-digit UNIX timestamp. You can query data from up to 90 days ago |
| EndTs | integer | yes | The end timestamp, which is a 10-digit UNIX timestamp. The maximum query interval is 31 days, which means the interval between this… |
| Region | string | no | This parameter does not take effect. By default, the usage data for all regions is returned |
| Interval | integer | yes | The time granularity for the query. Valid values: 3600 (hourly) and 86400 (daily) |

### Queries the MPS-AI usage in IMS. The maximum query range is 31 days, and data from up to 90 days ago can be…
`POST https://apizie.tech/v1/cloud:aliyun-ice/describe-meter-ims-mps-ai-usage` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| StartTs | integer | yes | The start timestamp, which is a 10-digit UNIX timestamp. Data from up to 90 days ago can be queried |
| EndTs | integer | yes | The end timestamp, which is a 10-digit UNIX timestamp. The maximum query interval is 31 days, which means the interval between this… |
| Interval | integer | yes | The time granularity. Valid values: 3600: hourly granularity. 86400: daily granularity |
| Region | string | no | The region. This parameter does not take effect. By default, the usage across all regions is returned |

### Queries the usage statistics of Intelligent Media Services (IMS). The maximum query range is 31 days. You…
`POST https://apizie.tech/v1/cloud:aliyun-ice/describe-meter-ims-summary` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| StartTs | integer | yes | The beginning of the time range to query. The value is a 10-digit timestamp |
| EndTs | integer | yes | The end of the time range to query. The value is a 10-digit timestamp |
| Region | string | no | This parameter does not take effect. By default, the usage data of all regions is returned |

### Retrieves the event callback configuration for a specified AIAgent
`POST https://apizie.tech/v1/cloud:aliyun-ice/describe-notify-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| AIAgentId | string | yes | The ID of the AIAgent |

### Retrieves playback records based on the player's TraceId. This API supports pagination
`POST https://apizie.tech/v1/cloud:aliyun-ice/describe-play-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| PageNo | integer | yes | The page number. Default value: 1 |
| PageSize | integer | yes | The number of entries per page |
| TraceId | string | no | The TraceId of the player |
| BeginTs | string | yes | The beginning of the time range to query. By default, the system queries data of the current day |
| EndTs | string | yes | The end of the time range to query. The time range cannot exceed 24 hours |
| OrderType | string | no | The sort order. Valid values: DESC: descending order. ASC: ascending order |
| OrderName | string | no | The criteria by which the sorting is performed. Valid values: FirstFrameDuration PlayDuration VideoDuration StuckDuration |
| PlayType | string | no | The playback type. Valid value: vod |
| Status | string | no | The playback status. Valid values: complete playing unusual: A playback error occurs |

### Queries the information of a Real-Time Communication (RTC) Real-time Conversational AI agent instance
`POST https://apizie.tech/v1/cloud:aliyun-ice/describe-rtc-robot-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| InstanceId | string | no | The instance ID |

### Checks whether the user's reading contains obvious pronunciation errors or background noise. After the audio…
`POST https://apizie.tech/v1/cloud:aliyun-ice/detect-audio-for-customized-voice-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| VoiceId | string | yes | The voice ID |
| RecordUrl | string | yes | The URL of the recording file. The URL must point to an Object Storage Service (OSS) object in your account, and the region of the OSS… |
| AudioRecordId | integer | yes | The audio sequence number corresponding to the RecordUrl parameter |

### Deletes a search index. After you delete a search index, the existing index data is cleared and index-based…
`POST https://apizie.tech/v1/cloud:aliyun-ice/drop-search-index` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| SearchLibName | string | no | The name of the search library. If you leave this parameter empty, the search index is created in the default search library of… |
| IndexType | string | yes | The category of the index. Valid values: mm: large visual model. face: face recognition. aiLabel: smart tagging |

### Deletes a search library and all media assets in the library
`POST https://apizie.tech/v1/cloud:aliyun-ice/drop-search-lib` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| SearchLibName | string | yes | The name of the search library |

### Disables an output of a MediaConnect flow. When disabled, the output retains its configuration, but no live…
`POST https://apizie.tech/v1/cloud:aliyun-ice/forbid-media-connect-flow-output` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| FlowId | string | no | The ID of the MediaConnect flow |
| OutputName | string | no | The name of the output |

### Transfers an active call to a destination phone number
`POST https://apizie.tech/v1/cloud:aliyun-ice/forward-aiagent-call` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ice.ap-southeast-1.aliyuncs.com |
| InstanceId | string | no | The current call instance ID. This parameter is used only in inbound call transfer scenarios |
| CalledNumber | string | no | The destination phone number to which the call is transferred |
| TransferPrompt | string | no | The prompt text to play before the transfer begins. If this parameter is left empty, the prompt is skipped and the ringtone is played… |
| ErrorPrompt | string | no | The error prompt text to play when the transfer fails. Default value: empty |
| CallerNumber | string | no | The caller phone number for the transferred call. This parameter is optional. By default, CallerNumber is the phone number of the agent… |

…and 280 more. See the OpenAPI spec.

## Example
```
curl "https://apizie.tech/v1/cloud:aliyun-ice/active-ai-rtc-license" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud Intelligent Cloud Editor API?
Create a free Apizie key, then send POST https://apizie.tech/v1/cloud:aliyun-ice/active-ai-rtc-license with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud Intelligent Cloud Editor 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 Cloud Editor itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud Intelligent Cloud Editor 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-ice.

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