All Products
Search
Document Center

Intelligent Media Services:API overview

Last Updated:Sep 02, 2026

API standards and multilingual preset SDKs

The OpenAPI of this product (ICE/2020-11-09) uses the RPC signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.

Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.

Custom signature scenarios

If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.

Account and security preparation

Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.

Media upload

API

Title

Description

CreateUploadMedia Retrieve media asset upload URL and credential Retrieves the upload URL and credential for audio, video, image, and auxiliary media assets, and creates media asset information.
CreateUploadStream CreateUploadStream Obtains the upload URL and credential of a media stream.
RefreshUploadMedia RefreshUploadMedia Obtain a new upload credential for a media asset after its upload credential expires.
RegisterMediaStream Register Media Stream Registers a media stream file stored in OSS with the media service and attaches the media stream to a specified MediaId.
GetUrlUploadInfos GetUrlUploadInfos Queries the information about URL-based upload jobs.
UploadMediaByURL Upload media by URL Invokes the UploadMediaByURL operation to pull audio and video media files from source file URLs for upload. Batch uploads are supported. This operation is mainly applicable to scenarios where files are not stored on a local service or terminal and need to be uploaded through a URL that supports public network access.
UploadStreamByURL UploadStreamByURL Uploads a media stream file based on the URL of the source file.

Media asset management

API

Title

Description

Media asset search Media asset search
Streaming media asset operations Streaming media asset operations
CloseStreamToSearchLib CloseStreamToSearchLib Stops the tagging and analysis process for a live stream media asset.
GetStreamTagList GetStreamTagList Retrieves tags of a live stream media asset.
CreateStreamToSearchLib CreateStreamToSearchLib Registers a live stream as a media asset.
AddStreamTagToSearchLib AddStreamTagToSearchLib Adds tags for a specific live stream media asset.
Search library management Search library management
CreateSearchLib Create search library Creates a search media library. You can use the library to store media assets.
QuerySearchLib Query Search Library Gets information about a search library.
ListSearchLib Obtain the search library list Retrieves a list of search libraries.
AlterSearchLib AlterSearchLib Modifies a search library.
DropSearchLib DropSearchLib Deletes a search library and all media assets in the library.
Search index configuration management Search index configuration management
CreateSearchIndex Create a search index Creates a search index in a search library. A search library can contain multiple search indexes of different types.
AlterSearchIndex Modify search index Modifies search index information, including the index status or index configuration.
QuerySearchIndex QuerySearchIndex Gets details about a search index.
DropSearchIndex DropSearchIndex Deletes a search index. After you delete a search index, the existing index data is cleared and index-based analysis, storage, and query are not supported for subsequent media assets.
Search index task management Search index task management
QueryMediaIndexJob QueryMediaIndexJob Queries the indexing jobs enabled for a media asset.
SearchIndexJobRerun Rerun search index tasks Reanalyzes search index tasks for specified media assets in batches. You can rerun index tasks for up to 20 media assets per request.
Media asset operations Media asset operations
InsertMediaToSearchLib Insert a media asset into the search library Insert a media asset into the search library.
UpdateMediaToSearchLib Update Media Asset to Search Library Update media asset information in the search library.
DeleteMediaFromSearchLib Delete Media Asset from Search Library Delete the specified media asset from the search library.
Search features Search features
Basic search Basic search
SearchMedia Search for media information Returns media asset information that matches the specified filter conditions.
GetVideoList GetVideoList Gets information about video and audio files.
Face search Face search
SearchMediaByFace Search for media assets by face image Searches for media assets by face image (coarse search). Accepts a face image as input and returns information about media assets that contain the person.
SearchMediaClipByFace Search media asset clips by face image Searches for media asset clips by face image (precise search). Returns relevant person clip information in the media asset based on the coarse search results.
Smart tag search Smart tag search
SearchMediaByAILabel DataQ - Smart Tag Service Text Search You can perform multimodal search based on person names, captions, and AI categorization.
Large model search Large model search
SearchMediaByMultimodal LLM Search LLM search. You can use natural language descriptions to perform searches.
SearchMediaByHybrid Hybrid Search Hybrid media asset search. Combines the text search capability of DataQ - Smart Tag Service and the LLM-based search capability to perform multi-channel recall, allowing users to search using natural language descriptions.
Media asset library Media asset library
RegisterMediaInfo Register a content library resource Initiates a media asset registration task and assigns a new IMS mediaId to the media asset. Based on the InputURL, the operation asynchronously calls other media asset information services to retrieve file information about the media asset. You can also set basic information such as the title, tags, and description. The operation synchronously returns a mediaId. You can call the GetMediaInfo operation to retrieve detailed media asset information. Currently, only OSS files and VOD media assets are supported as InputURL values.
GetMediaInfo Retrieve media asset content information Retrieves media asset information based on an IMS mediaId or media asset InputURL.
UpdateMediaInfo UpdateMediaInfo Updates information about a media asset based on the ID of the media asset in Intelligent Media Services (IMS) or the input URL of the media asset.
DeleteMediaInfos DeleteMediaInfos Deletes multiple media assets at a time. You can delete at most 20 media assets at a time. If MediaIds is specified, it is preferentially used. If MediaIds is empty, InputURLs must be specified.
BatchGetMediaInfos Batch retrieve media asset information Retrieves information about multiple media assets by specifying multiple mediaId values.
ListMediaBasicInfos List basic media asset information Returns the basic information of all media assets that match the specified parameters.
ListPublicMediaBasicInfos ListPublicMediaBasicInfos Queries a list of media assets in the public media library that meet the specified conditions. A maximum of 100 media assets can be returned.
ListAllPublicMediaTags ListAllPublicMediaTags Queries a list of tags of media assets in the public media library.
SubmitMediaAiAnalysisJob Submit an Intelligent Structured Analysis Job for a Media Asset Perform structured analysis on media assets to enable speaker analysis, video translation, paragraph summarization, and other analyses on videos.
Category management Category management
GetCategories GetCategories Queries the information about a category and its subcategories.
UpdateCategory Update a category Updates a media asset category.
Tag management Tag management
AddMediaMarks AddMediaMarks Adds marks for a media asset.
GetMediaMarks GetMediaMarks Queries the information about marks based on mark IDs.
UpdateMediaMarks Update media asset mark information Updates media asset mark information.
DeleteMediaMarks Delete mark information of a media asset Deletes the mark information of a media asset.
ListMediaMarks ListMediaMarks Queries a list of marks of a media asset.
IPC management IPC management
CreateIpcOrder Create IPC Order Creates an IPC order with shared capacity at the account level.
GetIpcDeviceInfo Obtain IPC device information Obtain IPC device information.
QueryIpcQuota Query IPC usage Query IPC usage.
GetPlayInfo Obtain audio and video playback uRLs Obtains the playback URL of a media file (video or audio) by audio or video ID. After integrating the Alibaba Cloud Player SDK (for URL-based playback) or a third-party player, you can use the URL for audio and video playback.
DeletePlayInfo DeletePlayInfo Deletes media streams such as video streams and audio streams.

Media asset review

API

Title

Description

CreateAudit Manual review Submits a manual review for a media asset by calling CreateAudit.
SubmitMediaCensorJob SubmitMediaCensorJob Submits a media file to Intelligent Media Services for a censor job. This API automates the scanning of video, audio, or image content to detect potentially non-compliant, sensitive, or inappropriate material.
QueryMediaCensorJobDetail QueryMediaCensorJobDetail Queries the information about a content moderation job.

Configuration management

API

Title

Description

Template management Template management
GetSystemTemplate GetSystemTemplate Queries the information about a system template.
SetDefaultCustomTemplate SetDefaultCustomTemplate Sets a custom template as the default template.
UpdateCustomTemplate Modify custom template information Modifies the information of a user-defined template for media processing.
ListSystemTemplates ListSystemTemplates Queries a list of system templates.
ListCustomTemplates ListCustomTemplates Retrieves a list of user-defined Video on Demand (VOD) media processing templates.

Media processing

API

Title

Description

Transcoding operations Transcoding operations
SubmitMediaConvertJob Submit a media transcoding task Submits a media processing task.
GetMediaConvertJob Query an ApsaraVideo Media Processing job MediaConvert task details
ListMediaConvertJobs ListMediaConvertJobs This operation lists media convert jobs.
SubmitTranscodeJob Submit a transcoding job (legacy) Submits a transcoding job for a video or audio file to Intelligent Media Services by specifying the source file, output format, and related parameters.
GetTranscodeJob GetTranscodeJob Queries the details of a single transcoding job.
ListTranscodeJobs ListTranscodeJobs Lists the transcoding jobs for a media file.
SubmitPackageJob SubmitPackageJob Submits a packaging job.
GetPackageJob GetPackageJob Queries the information about a packaging job.
ListPackageJobs ListPackageJobs Queries packaging jobs.
GenerateKMSDataKey Create a KMS data key Generates a random KMS data key (DK) for standard encryption transcoding of videos.
DecryptKMSDataKey Decrypt KMS data key ciphertext Performs decryption on the CiphertextBlob ciphertext in a KMS data key (DK).
Snapshot operations Snapshot operations
SubmitSnapshotJob SubmitSnapshotJob This API submits a snapshot job. Specify a media file by its ID or URL, a time point, and the desired format. The API then generates the snapshot and saves it to the specified location.
SubmitDynamicImageJob SubmitDynamicImageJob Use this API to submit a task to generate a dynamic image.
GetSnapshotUrls GetSnapshotUrls Queries the accessible URLs of the output images of a snapshot job.
GetSnapshotJob GetSnapshotJob Queries the information about a snapshot job.
GetDynamicImageJob GetDynamicImageJob Queries the information about an image animation job.
ListSnapshotJobs ListSnapshotJobs Queries a list of snapshot jobs.
ListDynamicImageJobs ListDynamicImageJobs Queries a list of image animation jobs.
Media information operations Media information operations
SubmitSyncMediaInfoJob SubmitSyncMediaInfoJob Submits a media file in synchronous mode for media information analysis.
SubmitMediaInfoJob SubmitMediaInfoJob Creates an asynchronous job to retrieve media information.
GetMediaInfoJob GetMediaInfoJob Queries the information about a media information analysis job.
ListMediaInfoJobs Query media information task list Queries the list of media information tasks.

Real-time processing

API

Title

Description

Real-time media transcoding Real-time media transcoding
CreateLiveTranscodeTemplate Create a real-time media transcoding template Creates a real-time transcoding template for submitting real-time transcoding tasks.
GetLiveTranscodeTemplate GetLiveTranscodeTemplate Queries the information a live stream transcoding template.
UpdateLiveTranscodeTemplate UpdateLiveTranscodeTemplate Updates the information about a live stream transcoding template.
DeleteLiveTranscodeTemplate Delete a real-time media transcoding template Deletes a real-time transcoding template.
ListLiveTranscodeTemplates Query real-time media transcoding templates Queries the list of real-time media transcoding templates by calling ListLiveTranscodeTemplates.
SubmitLiveTranscodeJob Submit a real-time media transcoding task Submits a real-time transcoding task.
SendLiveTranscodeJobCommand SendLiveTranscodeJobCommand Sends a command to process a live stream transcoding job.
GetLiveTranscodeJob GetLiveTranscodeJob Queries the information about a live stream transcoding job.
UpdateLiveTranscodeJob UpdateLiveTranscodeJob Updates the information about a live stream transcoding job.
DeleteLiveTranscodeJob Delete a real-time ApsaraVideo Media Processing job Delete the specified real-time transcoding job.
ListLiveTranscodeJobs Query real-time media transcoding task list Queries the list of real-time media transcoding tasks by calling ListLiveTranscodeJobs.
Real-time media recording Real-time media recording
CreateLiveRecordTemplate Create a real-time recording template Creates a real-time recording template for submitting real-time recording tasks.
GetLiveRecordTemplate GetLiveRecordTemplate Queries the information about a live stream recording template or a snapshot of the template.
UpdateLiveRecordTemplate UpdateLiveRecordTemplate Updates the information about a live stream recording template.
DeleteLiveRecordTemplate DeleteLiveRecordTemplate Deletes a live stream recording template without affecting existing jobs.
ListLiveRecordTemplates ListLiveRecordTemplates Call `ListLiveRecordTemplates` to retrieve a list of your real-time recording templates.
SubmitLiveRecordJob Submit a real-time recording task Submits a real-time recording task to record a live stream by calling SubmitLiveRecordJob.
GetLiveRecordJob GetLiveRecordJob Queries the information about a live stream recording job.
DeleteLiveRecordFiles DeleteLiveRecordFiles Deletes live stream recording files. You can choose to delete only the recording files or delete both the recording files and the original Object Storage Service (OSS) files.
ListLiveRecordJobs List real-time recording jobs Queries a list of real-time recording jobs with pagination support.
ListLiveRecordFiles ListLiveRecordFiles Queries all recording index files in the specified period of time.
Real-time media snapshot Real-time media snapshot
CreateLiveSnapshotTemplate Create a live snapshot template Creates a live snapshot template that can be used to create snapshot tasks.
GetLiveSnapshotTemplate GetLiveSnapshotTemplate Queries the information about a live stream snapshot template.
UpdateLiveSnapshotTemplate UpdateLiveSnapshotTemplate Updates the information about a live stream snapshot template.
DeleteLiveSnapshotTemplate DeleteLiveSnapshotTemplate Deletes a live stream snapshot template.
ListLiveSnapshotTemplates ListLiveSnapshotTemplates Returns a paginated list of Live Snapshot templates.
SubmitLiveSnapshotJob Submit a real-time snapshot task Submits a real-time snapshot task. If submitted during an active stream, the task starts automatically and asynchronously. Otherwise, the task remains in an unstarted state.
SendLiveSnapshotJobCommand Send a real-time snapshot task instruction Sends an instruction for a real-time snapshot task.
GetLiveSnapshotJob GetLiveSnapshotJob Queries the information a live stream snapshot job.
DeleteLiveSnapshotFiles Delete live snapshot files Deletes live snapshot files. You can choose to delete only the records or delete both the records and the original OSS files.
ListLiveSnapshotJobs ListLiveSnapshotJobs Retrieves a paginated list of live snapshot jobs.
ListLiveSnapshotFiles ListLiveSnapshotFiles Queries a list of live stream snapshot files by page.

Production

API

Title

Description

Cloud editing project management Cloud editing project management
CreateEditingProject Create a cloud editing project Creates a cloud editing project. You can set the title, description, timeline, and project cover.
GetEditingProject GetEditingProject Queries the information about an online editing project.
UpdateEditingProject Modify a cloud editing project Modifies a cloud editing project. You can modify the title, timeline, and cover image of the project.
DeleteEditingProjects DeleteEditingProjects Deletes one or more online editing project.
ListEditingProjects ListEditingProjects Queries a list of projects that meet the specified conditions. You can filter projects by project creation time.
AddEditingProjectMaterials Add materials to an editing project Adds one or more materials to an online editing project.
GetEditingProjectMaterials GetEditingProjectMaterials Retrieve all media assets bound to the current editing project.
DeleteEditingProjectMaterials Delete materials associated with an online editing project Deletes one or more materials from an online editing project.
GetLiveEditingIndexFile GetLiveEditingIndexFile Queries the index file of a live stream. The index file is used to preview an editing project in the console.
SubmitProjectExportJob SubmitProjectExportJob Submits a project export task.
GetProjectExportJob Query a project export task Queries the information about a project export task.
Editing and production Editing and production
SubmitMediaProducingJob Submit a media producing job Commits a media editing and compositing job. When you need to perform editing, compositing, or other forms of post-production on video or audio materials, you can invoke this API operation to automate the processing.
GetMediaProducingJob Query media producing job Retrieves the details of a media producing job, including the job status, timeline, template, and data.
SubmitLiveEditingJob Submit a live editing task Live editing combines one or more live stream segments into a finished product. After you submit a live editing task, the task enters a background queue and is executed asynchronously. After submission, you can call the GetLiveEditingJob operation to query the job status by jobId. You can also call the GetMediaInfo operation to query information about the generated media asset by MediaId.
GetLiveEditingJob GetLiveEditingJob Queries the information about a live editing job. The requested information includes the state, timeline, and template of the job, the ID and URL of the output file, and the configurations of the job. Query only live editing jobs created within the past year.
SubmitBatchMediaProducingJob Batch intelligent one-click video production Intelligently mixes and edits multiple video, audio, and image materials to batch-produce videos with one click.
GetBatchMediaProducingJob Obtain batch Intelligent One-Click Video Editing job information Obtain detailed information about batch Intelligent One-Click Video Editing jobs, including the input parameters, job status, and the IDs and URLs of the generated media assets. This API supports querying job data from the past year only.
SubmitSportsHighlightsJob SubmitSportsHighlightsJob Starts a job to generate a highlight video from sports footage with commentary.
SubmitScreenMediaHighlightsJob SubmitScreenMediaHighlightsJob Analyzes media assets, such as short-form dramas, to automatically identify highlight clips and generate a highlight compilation.
ListMediaProducingJobs ListMediaProducingJobs Queries a list of media editing and production jobs that meet the specified conditions. You can query the jobs based on the job state and type.
ListBatchMediaProducingJobs ListBatchMediaProducingJobs Queries a list of quick video production jobs based on conditions such as the job type and state.
Template factory Template factory
GetTemplateMaterials GetTemplateMaterials Queries the URLs of materials associated with an advanced template for use by the advanced template editor. The URLs expire in 30 minutes. FileList is an array of materials that you want to query. If you do not specify this parameter, the URLs of all materials are returned. A maximum of 400 URLs can be returned.
GetTemplateParams Retrieve template parameter information Retrieves the replaceable media parameter information of a template, including parameter names, default media values, and media thumbnails. Currently, only advanced templates are supported.
Intelligent tasks Intelligent tasks
Hot word management Hot word management
DeleteHotwordLibrary DeleteHotwordLibrary Deletes a specified hotword library based on the ID.
GetHotwordLibrary GetHotwordLibrary Queries the information about a specified hotword library based on the ID.
ListHotwordLibraries ListHotwordLibraries Queries hotword libraries that meet specific search conditions.
UpdateHotwordLibrary UpdateHotwordLibrary Modifies a specified hotword library, including its name, description, and hotword list.
CreateHotwordLibrary CreateHotwordLibrary Creates a hotword library.
Digital human training Digital human training
CreateAvatarTrainingJob Create and initialize a digital human training task Creates a digital human training task and configures the basic information and training material information for the digital human.
UpdateAvatarTrainingJob UpdateAvatarTrainingJob Modifies a digital human training job. You can modify the basic information or update parameters such as Video and Transparent for retraining if the training failed.
SubmitAvatarTrainingJob SubmitAvatarTrainingJob Use this operation to submit a new avatar training job or to resubmit a failed job.
GetAvatarTrainingJob GetAvatarTrainingJob Queries the information about a digital human training job.
DeleteAvatarTrainingJob Delete a digital human training task Deletes a digital human training task that is in the init (draft) or training failed status.
ListAvatarTrainingJobs ListAvatarTrainingJobs Queries a list of digital human training jobs.
GetAvatar GetAvatar Queries the information about a trained digital human.
ListAvatars ListAvatars Queries a list of trained digital humans.
Voice cloning Voice cloning
CreateCustomizedVoiceJob Create a voice cloning task (Basic edition) Creates a voice cloning task to initialize the basic configuration information for the task.
GetDemonstrationForCustomizedVoiceJob GetDemonstrationForCustomizedVoiceJob Queries the text to be read and sample audio for training a personalized human voice.
DetectAudioForCustomizedVoiceJob DetectAudioForCustomizedVoiceJob Checks whether the reading of users has issues, such as noticeable pronunciation errors or background noise. After the audio is checked on the cloud, the qualified audio is temporarily stored on the cloud for subsequent training. Do not skip this step.
SubmitCustomizedVoiceJob Submit a voice cloning task (Basic edition) Submits a voice cloning task of the Basic edition.
SubmitStandardCustomizedVoiceJob Submit a voice cloning task (basic edition) Submits a voice cloning task of the basic edition. After you call this operation, a JobId is synchronously returned. The training process is asynchronous. During training, you can call the GetCustomizedVoiceJob operation to query whether the current task is completed and obtain the training status.
GetCustomizedVoiceJob GetCustomizedVoiceJob Queries the information about a human voice cloning job.
DeleteCustomizedVoiceJob Delete a voice cloning task Deletes a voice cloning task that is not in the "Training" or "Training Succeeded" state.
ListCustomizedVoiceJobs ListCustomizedVoiceJobs Queries a list of human voice cloning jobs.
GetCustomizedVoice GetCustomizedVoice Queries the information about a personalized human voice.
UpdateCustomizedVoice UpdateCustomizedVoice Updates a personalized human voice. Only the media asset ID of the sample audio file can be modified.
ListCustomizedVoices ListCustomizedVoices Queries a list of personalized human voices.
SubmitASRJob Submit an ASR intelligent subtitling task Extracts time start and end points along with corresponding text information from video speech.
SubmitAvatarVideoJob SubmitAvatarVideoJob Renders an avatar video from text or an audio file.
SubmitAudioProduceJob Submit an intelligent speech task Converts provided text content into a high-quality speech audio file.
SubmitTextGenerateJob SubmitTextGenerateJob Generates marketing copy based on the provided keywords, text length, and number of copy variations. Due to the complexities of the Chinese language, the length of the output text may differ from the requested length. After submitting the job, call the `GetSmartHandleJob` operation with the returned job ID to query the job status and retrieve the results.
SubmitVideoTranslationJob Submit a Video Translation Job Call this operation to submit a video translation job. This service can translate subtitles and spoken content, and generate lip-sync for the translated audio.
SubmitHighlightExtractionJob SubmitHighlightExtractionJob Submits a highlight extraction job.
SubmitSegmentationJob SubmitSegmentationJob Submits a job to segment a long video into multiple video segments. The output can be multiple video files or a new media asset.
GetSmartHandleJob GetSmartHandleJob Retrieves the information and execution result for a smart task by task ID. This API only supports querying editing tasks from the past year.
DeleteSmartJob Delete an intelligent production job Deletes an intelligent production job by job ID.
ListSmartJobs ListSmartJobs Queries a list of intelligent jobs based on specified parameters.
ListSmartSysAvatarModels ListSmartSysAvatarModels Retrieves a paginated list of system digital avatars.
ListSmartVoiceGroups List Intelligent Speech Voice Information Retrieves a list of available smart voices, including their names, genders, and sample audio. The voices are grouped by scenario.

Real-time conversational AI

API

Title

Description

Agent management Agent management
StartAIAgentInstance Start an Agent Instance Start an AI agent instance configured in IMS.
StopAIAgentInstance Stop an agent instance Stops an agent instance.
UpdateAIAgentInstance Update AI Agent Instance Configuration Modifies the configuration of a specified AI agent instance.
DescribeAIAgentInstance Query agent instance details Queries an instance.
ListAIAgentInstance Query AI agent instance list Queries the list of AI agent instances. You can retrieve all instances or filter by specified conditions.
GetAIAgentConcurrency GetAIAgentConcurrency Retrieves the current number of active concurrent calls for a specified AI agent. This is a lightweight query operation that returns only the number of currently active instances. It does not return instance details or historical peak values.
SendAIAgentSpeech Send AI Agent Voice Message Instructs a specified agent instance to immediately play back a text message, with support for interrupt settings.
TakeoverAIAgentCall TakeoverAIAgentCall Hands off a conversation to a human agent.
SendAIAgentDataChannelMessage SendAIAgentDataChannelMessage Sends a DataChannel message to an AI agent.
SendAIAgentText Pass a message as LLM input Passes a message as input to the LLM.
AICallKit integration operations AICallKit integration operations
GenerateMessageChatToken GenerateMessageChatToken Generates the token required for interactive messaging.
GenerateAIAgentCall Generate an AI Agent Call Instance Creates an agent instance and returns the channel, username, and token to join the channel.
ListAIAgentDialogues Query conversation history Lists the history records of a session.
DeleteAIAgentDialogue DeleteAIAgentDialogue Deletes dialog records of an AI agent.
SendMessageChatText SendMessageChatText Sends a message to the client.
Carrier line operations Carrier line operations
StartAIAgentOutboundCall Start Agent Outbound Call Initiates an AI agent outbound call from a specific caller number to a called number and returns the call's InstanceId.
ListAIAgentPhoneNumber List user phone resources List user phone resources API.
ForwardAIAgentCall Transfer a call Transfers an active call to a destination phone number.
Voiceprint management Voiceprint management
SetAIAgentVoiceprint Register a voiceprint Sets a voiceprint.
ClearAIAgentVoiceprint ClearAIAgentVoiceprint Clears the voiceprint associated with a voiceprint ID.
ListAIAgentVoiceprints List voiceprints Updates the callback configuration.
Offline tasks Offline tasks
SubmitAIAgentVideoAuditTask SubmitAIAgentVideoAuditTask Submits a video to a specified AI agent for content moderation. This operation supports video input from OSS and delivers the results asynchronously via callbacks. You can define custom frame-capturing policies and moderation prompts.
RTOS License RTOS License
GetAiRtcAuthCodeList GetAiRtcAuthCodeList Retrieves a list of Real-time Conversational AI authentication codes and their status for a specified batch.
ActiveAiRtcLicense ActiveAiRtcLicense Activates a specified license using the batch ID, authorization code, and device SN.

Media AI

API

Title

Description

Intelligent content understanding Intelligent content understanding
Task operations Task operations
SubmitVideoCognitionJob SubmitVideoCognitionJob Submits a video cognition job.
QueryVideoCognitionJob QueryVideoCognitionJob Querying video understanding task results
Custom entity recognition operations Custom entity recognition operations
CreateRecognitionEntity CreateRecognitionEntity Creates an entity to be recognized in a custom recognition library. The entity can be a landmark, object, logo, or person.
CreateRecognitionLib CreateRecognitionLib Creates a custom library to store the entity information for recognition.
CreateRecognitionSample CreateRecognitionSample Adds a sample image or a text label to a specific entity within a recognition library.
ListRecognitionSamples Retrieve the list of detection samples for a Custom entity Retrieves all samples of a custom entity. Pagination is supported.
DeleteRecognitionSample DeleteRecognitionSample Deletes a sample for a custom entity.
ListRecognitionEntities ListRecognitionEntities Lists entities in a specified recognition library. Pagination is supported.
ListRecognitionLibs Retrieve the List of Custom Detection Libraries Perform a paged query to retrieve information about all Custom detection libraries under the current User.
DeleteRecognitionLib DeleteRecognitionLib Deletes a custom recognition library, including all entities and samples within it.
DeleteRecognitionEntity DeleteRecognitionEntity Deletes an entity from the specified custom recognition library.
Intelligent production Intelligent production
SubmitIProductionJob Submit an intelligent production job Submits an intelligent production job by calling SubmitIProductionJob.
QueryIProductionJob Query Intelligent Production Job Call `QueryIProductionJob` to get the status and result of an intelligent production job.
Media DNA Media DNA
CreateDNADB CreateDNADB Use the CreateDNADB operation to create a DNA database.
DeleteDNADB DeleteDNADB Deletes a media fingerprint library.
ListDNADB ListDNADB Queries a list of media fingerprint libraries.
SubmitDNAJob SubmitDNAJob Submits a DNA job.
CancelDNAJob Cancel a DNA job Cancels a DNA job.
DeleteDNAFiles DeleteDNAFiles Deletes files from a media fingerprint library.
ListDNAFiles ListDNAFiles Lists files in a media fingerprint library.
QueryDNAJobList Query DNA jobs Queries DNA jobs by calling QueryDNAJobList.
Digital watermarking Digital watermarking
SubmitCopyrightJob SubmitCopyrightJob Submits a video copyright watermark job.
QueryCopyrightJobList QueryCopyrightJobList Queries copyright watermarking jobs.
SubmitCopyrightExtractJob SubmitCopyrightExtractJob Submits a copyright watermark extraction job.
QueryCopyrightExtractJob QueryCopyrightExtractJob Queries a job for extracting a copyright watermark.
SubmitTraceAbJob SubmitTraceAbJob Submits a job to generate A/B stream variants of a video for forensic watermarking.
QueryTraceAbJobList QueryTraceAbJobList Queries A/B watermarking jobs.
SubmitTraceM3u8Job SubmitTraceM3u8Job Submits a job to process an M3U8 file for video watermarking for tracing.
QueryTraceM3u8JobList QueryTraceM3u8JobList Queries jobs for generating M3U8 files containing specific trace watermark information.
SubmitTraceExtractJob SubmitTraceExtractJob Submits a trace watermark extraction job.
QueryTraceExtractJob QueryTraceExtractJob Queries a job for extracting a trace watermark.

Usage statistics

API

Title

Description

DescribeMeterImsMediaConvertUHDUsage DescribeMeterImsMediaConvertUHDUsage Queries the usage statistics of Intelligent Media Services (IMS) on ultra high definition (UHD) transcoding of ApsaraVideo Media Processing (MPS). The maximum query range is 31 days. You can query data within the last 90 days.
DescribeMeterImsMediaConvertUsage DescribeMeterImsMediaConvertUsage Queries the usage statistics of Intelligent Media Services (IMS) on video-on-demand (VOD) transcoding. The maximum query range is 31 days. You can query data within the last 90 days.
DescribeMeterImsEditUsage DescribeMeterImsEditUsage Queries the usage statistics of Intelligent Media Services (IMS) on video-on-demand (VOD) editing. The maximum query range is 31 days. You can query data within the last 90 days.
DescribeMeterImsSummary DescribeMeterImsSummary Queries the usage statistics of Intelligent Media Services (IMS). The maximum query range is 31 days. You can query data within the last 90 days.
DescribeMeterImsMpsAiUsage DescribeMeterImsMpsAiUsage Queries the usage statistics of Intelligent Media Services (IMS) on AI processing of ApsaraVideo Media Processing (MPS). The maximum query range is 31 days. You can query data within the last 90 days.

Global configuration

API

Title

Description

SetEventCallback SetEventCallback Configures a callback method for one or more events.
GetEventCallback GetEventCallback Queries event callback configurations.

Workflow

API

Title

Description

StartWorkflow Submit a workflow task Submits a workflow template task to implement an automated media processing flow based on a workflow template.
GetWorkflowTask GetWorkflowTask Queries the information about a workflow task by task ID, including the workflow ID and the status and result of the task. You can query only the workflow task data of the last year.
ListWorkflowTasks ListWorkflowTasks Retrieves workflow tasks.
StartAIWorkflow StartAIWorkflow Initiates a workflow task for automated media processing based on a workflow template.
StopAIWorkflowTask StopAIWorkflowTask Manually stops a workflow task.
GetAIWorkflowTask GetAIWorkflowTask Retrieves the details of a workflow task.

Media services

API

Title

Description

Live streaming Live streaming
CreateMediaLiveInputSecurityGroup CreateMediaLiveInputSecurityGroup Creates a security group in MediaLive.
UpdateMediaLiveInputSecurityGroup UpdateMediaLiveInputSecurityGroup Modifies a security group created in MediaLive.
GetMediaLiveInputSecurityGroup GetMediaLiveInputSecurityGroup Gets details about a security group in MediaLive.
ListMediaLiveInputSecurityGroups ListMediaLiveInputSecurityGroups Queries the security groups in MediaLive.
DeleteMediaLiveInputSecurityGroup DeleteMediaLiveInputSecurityGroup Deletes a security group in MediaLive.
CreateMediaLiveInput Create a live media input Create a live media input.
UpdateMediaLiveInput Update a media live input Update a media live input.
GetMediaLiveInput Query media live input details Query the details of a media live input.
ListMediaLiveInputs Query media live streaming input list Query the list of media live inputs.
DeleteMediaLiveInput DeleteMediaLiveInput Deletes a MediaLive input.
CreateMediaLiveChannel CreateMediaLiveChannel Creates a MediaLive channel.
UpdateMediaLiveChannel UpdateMediaLiveChannel Modifies a MediaLive channel.
GetMediaLiveChannel GetMediaLiveChannel Queries a MediaLive channel.
ListMediaLiveChannels ListMediaLiveChannels Queries MediaLive channels.
DeleteMediaLiveChannel DeleteMediaLiveChannel Deletes a MediaLive channel.
StartMediaLiveChannel StartMediaLiveChannel Starts a MediaLive channel.
StopMediaLiveChannel StopMediaLiveChannel Stops a MediaLive channel.
Media transport Media transport
GetMediaConnectAvailableRegion GetMediaConnectAvailableRegion Retrieves all regions where MediaConnect is available.
ForbidMediaConnectFlowOutput ForbidMediaConnectFlowOutput Disables an output of a MediaConnect flow. When disabled, the output retains its configuration, but no live stream is delivered to the destination.
ResumeMediaConnectFlowOutput ResumeMediaConnectFlowOutput Resumes an output of a MediaConnect flow. When resumed, the output can deliver the live stream to the destination.
GetMediaConnectFlowAllOutputName GetMediaConnectFlowAllOutputName Retrieves the names of all outputs for a MediaConnect flow.
CloseMediaConnectFlowFailover CloseMediaConnectFlowFailover Disables Source Failover for a MediaConnect flow.
OpenMediaConnectFlowFailover OpenMediaConnectFlowFailover Enables Source Failover for a MediaConnect flow.
UpdateMediaConnectFlowOutput UpdateMediaConnectFlowOutput Modifies an output of a MediaConnect flow.
GetMediaConnectFlowOutput Get MediaConnect Flow Instance's Output Information Retrieve detailed information of a specific output based on outputName
DeleteMediaConnectFlowOutput DeleteMediaConnectFlowOutput Deletes an output of a MediaConnect flow.
AddMediaConnectFlowOutput AddMediaConnectFlowOutput Creates an output for a MediaConnect flow.
DeleteMediaConnectFlowInput Delete Input of a MediaConnect Flow Instance Delete the input of a specific MediaConnect instance
UpdateMediaConnectFlowInput Modify MediaConnect Flow Instance Input Modify the input information of a specific MediaConnect flow
GetMediaConnectFlowInput Get MediaConnect Flow Instance Input Information Retrieves the input information of a MediaConnect instance.
AddMediaConnectFlowInput AddMediaConnectFlowInput Adds an input to a MediaConnect Flow instance.
DeleteMediaConnectFlow DeleteMediaConnectFlow Deletes a MediaConnect flow.
UpdateMediaConnectFlowStatus UpdateMediaConnectFlowStatus Modifies the state of a MediaConnect flow.
GetMediaConnectFlow Get MediaConnect Flow Instance Information Retrieves the details of a MediaConnect Flow instance.
CreateMediaConnectFlow CreateMediaConnectFlow Creates a MediaConnect flow.
Media advertising Media advertising
AddAdInsertion AddAdInsertion Adds an ad insertion configuration.
UpdateAdInsertion UpdateAdInsertion Modifies an ad insertion configuration.
GetAdInsertion GetAdInsertion Obtains details of an ad insertion configuration.
ListAdInsertions ListAdInsertions Obtains ad insertion configurations.
DeleteAdInsertion DeleteAdInsertion Deletes an ad insertion configuration.
GetSourceLocation GetSourceLocation Queries a source location.
UpdateSourceLocation UpdateSourceLocation Modifies a source location.
DeleteSourceLocation DeleteSourceLocation Deletes a source location.
ListSourceLocations ListSourceLocations Lists source locations.
CreateSourceLocation CreateSourceLocation Creates a source location.
UpdateProgram UpdateProgram Modifies a program in a MediaWeaver channel.
GetProgram GetProgram Queries a program.
UpdateSource UpdateSource Modifies a source.
StartChannel StartChannel Starts a channel.
DeleteProgram DeleteProgram Deletes a program from a channel.
StopChannel StopChannel Stops a MediaWeaver channel.
ListChannels ListChannels Lists MediaWeaver channels.
ListPrograms ListPrograms Lists programs.
CreateChannel CreateChannel Creates a channel in MediaWeaver.
ListSchedules ListSchedules Lists the program schedule of a MediaWeaver channel.
ListSources ListSources Lists sources in MediaWeaver.
GetChannel GetChannel Gets information about a channel in MediaWeaver.
CreateProgram CreateProgram Creates a program in a MediaWeaver channel.
ListChannelAlerts ListChannelAlerts Lists alerts for resources in a MediaWeaver channel.
UpdateChannel UpdateChannel Modifies a MediaWeaver channel.
Media packaging Media packaging
VOD packaging VOD packaging
CreateVodPackagingGroup CreateVodPackagingGroup Creates a VOD packaging group.
GetVodPackagingGroup GetVodPackagingGroup Queries a VOD packaging group.
ListVodPackagingGroups ListVodPackagingGroups Lists VOD packaging groups.
DeleteVodPackagingGroup DeleteVodPackagingGroup Deletes a VOD packaging group.
CreateVodPackagingConfiguration CreateVodPackagingConfiguration Creates a VOD packaging configuration.
GetVodPackagingConfiguration GetVodPackagingConfiguration Queries a packaging configuration.
ListVodPackagingConfigurations ListVodPackagingConfigurations Lists VOD packaging configurations.
DeleteVodPackagingConfiguration DeleteVodPackagingConfiguration Deletes a VOD packaging configuration.
CreateVodPackagingAsset CreateVodPackagingAsset Ingests an asset for VOD packaging.
BatchCreateVodPackagingAsset BatchCreateVodPackagingAsset Ingests multiple assets for VOD packaging.
GetVodPackagingAsset GetVodPackagingAsset Queries a VOD packaging asset.
ListVodPackagingAssets ListVodPackagingAssets Lists VOD packaging assets.
DeleteVodPackagingAsset DeleteVodPackagingAsset Deletes a VOD packaging asset.
Live packaging Live packaging
CreateLivePackageChannelGroup CreateLivePackageChannelGroup Creates a live package channel group with a custom name and description.
UpdateLivePackageChannelGroup UpdateLivePackageChannelGroup Updates the information about a live package channel group including its description.
GetLivePackageChannelGroup GetLivePackageChannelGroup Gets details about a live package channel group by name.
ListLivePackageChannelGroups ListLivePackageChannelGroups Queries live package channel groups by page. Fuzzy search by name or description and sorting are supported.
DeleteLivePackageChannelGroup DeleteLivePackageChannelGroup Deletes a live package channel group by name.
CreateLivePackageChannel Create a live packaging channel Generates a real-time video stream processing channel that supports the HLS protocol and automatically assigns endpoints and keys.
UpdateLivePackageChannel Modify live packaging channel Updates the channel configuration in the live packaging service, including the protocol, duration, and segment count.
UpdateLivePackageChannelCredentials UpdateLivePackageChannelCredentials Updates the credentials of ingest endpoints associated with a live package channel.
GetLivePackageChannel GetLivePackageChannel Gets details about a live package channel.
ListLivePackageChannels ListLivePackageChannels Queries live package channels by channel group and keyword. Paging and sorting are supported.
DeleteLivePackageChannel DeleteLivePackageChannel Deletes a live package channel by GroupName and ChannelName.
CreateLivePackageOriginEndpoint Create a live packaging origin endpoint Adds an origin endpoint configuration for a live streaming channel. This operation supports HLS, HLS_CMAF, and DASH protocols and DRM encryption.
UpdateLivePackageOriginEndpoint Update a live packaging origin endpoint Updates the origin endpoint configuration of a channel group for live packaging, including protocol, time-shifting settings, and access control.
GetLivePackageOriginEndpoint Get live package origin endpoint Queries the details of the real-time stream packaging origin server configuration for a specified channel.
ListLivePackageOriginEndpoints ListLivePackageOriginEndpoints Queries origin endpoints by channel group and channel name. Paging and sorting are supported.
DeleteLivePackageOriginEndpoint DeleteLivePackageOriginEndpoint Deletes an origin endpoint associated with a live package channel.

Wanjing yike

API

Title

Description

RegisterYikeAssetMediaInfo Register media asset information Registers a content library resource.
ListYikeProductions Get project list Retrieves the list of Yike projects.
GetYikeAssetMediaInfo Retrieve media asset details Retrieves the content information of a media asset.
ListYikeAssetFolders Get folder list Retrieves the list of folders.
BatchGetYikeAssetMediaInfos Batch retrieve media asset information Retrieves information about multiple media assets in a batch.
DeleteYikeAssetMediaInfos Delete media asset information details Deletes media asset information.
ResumeYikeStoryboardJob ResumeYikeStoryboardJob Resumes a storyboard job.
CreateYikeProduction CreateYikeProduction Creates a Yike production.
CreateYikeWorkspace CreateYikeWorkspace Creates a workspace.
CreateYikeUser CreateYikeUser Creates a Yike user.
GetYikeUser GetYikeUser Gets information about a Yike sub-account.
SetYikeUserRole SetYikeUserRole Sets a user role.
AddYikeUserCredit AddYikeUserCredit Adds credits to a user account.
GetYikeUserCredit GetYikeUserCredit Retrieves the credit balance for a Yike user.
SubYikeUserCredit Deduct user credits Deducts user credits.
PrecheckYikeAIAppJob PrecheckYikeAIAppJob Validates the parameters of an application.

Others

API

Title

Description

SubmitSmarttagJob SubmitSmarttagJob Submits a smart tagging job.
QuerySmarttagJob QuerySmarttagJob Querying a smart tag task.
Collection configuration (deprecated) Collection configuration (deprecated)
SetContentAnalyzeConfig Configure Intelligent Content Analysis Configures settings for Intelligent Content Analysis.
GetContentAnalyzeConfig Obtain Intelligent Content Analysis Configuration Retrieves the configuration for Intelligent Content Analysis.
SetDefaultStorageLocation Set default storage location Sets the default storage path for temporary files. The default storage address is used for temporary file storage generated during editing when using the ICE online editor or integrated WebSDK, such as audio files generated by intelligent configurations. Setting the default storage address prevents confusion when users are prompted to specify storage paths for various temporary resources during editing. If you access ICE editing capabilities through APIs, you can flexibly set the path in the API request, and this default path does not take effect.
GetDefaultStorageLocation Obtain Default Storage Location This topic describes the API request parameters and sample for obtaining the default storage configuration.
DescribePlayList DescribePlayList Retrieves playback records based on the player's TraceId. This API supports pagination.
Material center Material center
AddFavoritePublicMedia Add public copyright media assets to favorite Adds all media assets to the favorite based on the specified list of media asset IDs.
CancelFavoritePublicMedia Cancel favorite public copyright media assets Cancels the favorite status of all media assets based on the specified list of media asset IDs.
GetPublicMediaInfo Obtain public copyright media assets Obtain and return media asset information based on the mediaId of an ICE public copyright media asset. The URL returned by the API is a preview or audition address for the copyright media asset. The official material will be used during synthesis.
SearchPublicMediaInfo Search public copyright media assets Searches for media assets that match the specified conditions.
GetStorageList GetStorageList Obtains storage configurations.
SearchEditingProject SearchEditingProject Queries online editing projects by creation time and status.
StopRtcRobotInstance Stop RTC Interactive AI Agent Instance Stop an RTC interactive AI agent instance.
StartRtcRobotInstance Start RTC Interactive AI Agent Instance Starts an RTC interactive AI agent instance and joins an RTC call.
UpdateRtcRobotInstance Update RTC Interactive AI Agent Instance Updates the configuration of an RTC AI Agent instance, such as its voice and greeting.
DescribeRtcRobotInstance Query an RTC interactive AI agent instance Retrieves information about an RTC Robot Instance.
SetNotifyConfig SetNotifyConfig Enables or disables event notifications for an AI Agent and sets the Callback URL and the Event Types to subscribe to.
DescribeNotifyConfig Query Agent Notification Configuration Retrieves the event callback configuration for a specified AIAgent.
CancelIProductionJob Cancel an intelligent production job Cancels an intelligent production job.
SubmitSceneMediaSelectionJob SubmitSceneMediaSelectionJob Selects suitable clips based on the submitted videos, images, and voiceovers, and returns the selection results. Two scenarios are supported: image-text matching and highlight mashup.
SubmitSceneBatchEditingJob SubmitSceneBatchEditingJob Submits a batch job to render multiple videos by providing a list of editing project IDs.
SubmitSceneTimelineOrganizationJob SubmitSceneTimelineOrganizationJob Arranges media assets, including videos, images, background music, and voiceovers, into a complete timeline based on media selection results, and creates an editing project for preview. Two scenarios are supported: image-text matching and highlight mashup.
CreateCustomTemplate Create a custom template Creates a custom media processing template.
CreateSource CreateSource Creates a source in MediaWeaver.
DeleteChannel DeleteChannel Deletes a channel.
DeleteCustomTemplate Delete a custom template Deletes a custom template.
DeleteSource DeleteSource Deletes a source from MediaWeaver.
GetAiRtcLicenseInfoList GetAiRtcLicenseInfoList Retrieves details for AI Real-Time Communication license batches that match specified filter criteria.
GetCustomTemplate GetCustomTemplate Gets details of a custom media processing template.
GetSource GetSource Queries a source.
ListAlerts ListAlerts Lists alerts received in MediaWeaver.
SubmitDynamicChartJob SubmitDynamicChartJob Submits a job to generate a dynamic chart video, such as a Line Chart, Pie Chart, or Bar Chart, from Excel data. You can customize chart elements like line colors and fonts.
CreatePipeline Create a pipeline Creates a media processing pipeline for automated and batch processing of media files.
DeletePipeline DeletePipeline Deletes an ApsaraVideo Media Processing (MPS) queue.
GetPipeline GetPipeline Queries the information about an ApsaraVideo Media Processing (MPS) queue.
ListPipelines ListPipelines Queries a list of ApsaraVideo Media Processing (MPS) queues.
UpdatePipeline UpdatePipeline Updates the information about an ApsaraVideo Media Processing (MPS) queue.
AddTemplate Create template Creates a template. Intelligent Cloud Editor supports the video clip feature based on standard templates and advanced templates. You can invoke AddTemplate to create a template.
BatchGetYikeAIAppJob Batch retrieve AI application jobs Retrieves a batch of Yike AI Application Generation Tasks.
CreateYikeAssetUpload Obtain audio and video upload URL and credential Retrieves the upload credential for a media asset on Yike.
DeleteTemplate DeleteTemplate Deletes templates.
GetTemplate GetTemplate Queries the information about a template based on the template ID. Query the information about an advanced template if the template is in the Available state.
GetYikeAIAppJob Retrieve task result details Retrieves the task result of an AI application.
GetYikeStoryboardJob Query storyboard generation task Retrieves an AI application task for storyboard generation.
ListTemplates ListTemplates Queries a list of templates that meet the specified conditions. You can query templates based on information such as the template status and creation source.
SubmitYikeAIAppJob Submit an application task Submits an AI application task.
SubmitYikeStoryboardJob Submit a storyboard generation task Submits a storyboard generation task for the Yike AI application.
UpdateTemplate UpdateTemplate Modifies an online editing template. You can modify the template title and template configurations.
AddCategory Create a category Creates a media asset category.
DeleteCategory Delete a category Deletes a media asset category.