API standard and pre-built SDKs in multi-language
The OpenAPI specification of this product (ICE/2020-11-09) follows the RPC standard. Alibaba Cloud provides pre-built SDKs for popular programming languages to abstract low-level complexities such as request signing. This enables developers to call APIs using language-specific syntax without dealing with HTTP details directly.
Custom signature
If your specific needs, such as a customized signature, are not supported by the SDK, manually sign requests using the signature mechanism. Note that manual signing requires significant effort (usually about 5 business days). For support, join our DingTalk group (ID: 147535001692).
Before you begin
An Alibaba Cloud account has full administrative privileges. A compromised AccessKey pair exposes all associated resources to unauthorized access, posing a significant security risk. To call APIs securely, create a Resource Access Management (RAM) user with API access only, configure its AccessKey pairs, and implement the principle of least privilege (PoLP) through RAM policies. Use the Alibaba Cloud account only when its permissions are explicitly required for specific scenarios.
API list
|
API |
Title |
Description |
| ActiveAiRtcLicense | ActiveAiRtcLicense | Activates a specified license using the batch ID, authorization code, and device SN. |
| AddCategory | AddCategory | Creates a category. |
| AddEditingProjectMaterials | AddEditingProjectMaterials | Adds one or more materials to an online editing project. |
| AddFavoritePublicMedia | Collect public copyright media assets | Adds one or more public Media Assets to your Favorites list by their media IDs. |
| AddMediaMarks | AddMediaMarks | Adds marks for a media asset. |
| AddStreamTagToSearchLib | AddStreamTagToSearchLib | Adds tags for a specific live stream media asset. |
| AddTemplate | AddTemplate | Creates a template. |
| AddYikeUserCredit | AddYikeUserCredit | Adds credits to a user account. |
| AlterSearchIndex | AlterSearchIndex | Modifies search index information including index status and configurations. |
| AlterSearchLib | AlterSearchLib | Modifies a search library. |
| BatchGetMediaInfos | BatchGetMediaInfos | Retrieves information for multiple media assets in a single request by providing their `mediaId` values. |
| BatchGetYikeAIAppJob | Batch retrieve AI application jobs | Retrieves a batch of Yike AI Application Generation Tasks. |
| BatchGetYikeAssetMediaInfos | Batch Retrieve Media Asset Details | Retrieves multiple media assets. |
| CancelDNAJob | CancelDNAJob | Cancels a media fingerprint analysis job. |
| CancelFavoritePublicMedia | Remove public copyright media assets from favorites | Removes all specified media assets from favorites based on the input mediaId list. |
| CancelIProductionJob | Cancel Intelligent Production Job | Invoke CancelIProductionJob to cancel an Intelligent Production job. |
| ClearAIAgentVoiceprint | ClearAIAgentVoiceprint | Clears the voiceprint associated with a voiceprint ID. |
| CloseStreamToSearchLib | CloseStreamToSearchLib | Stops the tagging and analysis process for a live stream media asset. |
| CreateAudit | CreateAudit | Submits manual review results for media assets. |
| CreateAvatarTrainingJob | CreateAvatarTrainingJob | Creates an avatar training job. You can configure the basic information of the avatar and the materials required for the training. |
| CreateCustomTemplate | CreateCustomTemplate | Creates a custom media processing template. |
| CreateCustomizedVoiceJob | CreateCustomizedVoiceJob | Creates a human voice cloning job. You can configure the basic information of the human voice cloning job. |
| CreateDNADB | CreateDNADB | Creates media fingerprint libraries. |
| CreateEditingProject | CreateEditingProject | Creates an online editing project. You can specify configurations such as the title, description, timeline, and thumbnail for the project. |
| CreateHotwordLibrary | CreateHotwordLibrary | Creates a hotword library. |
| CreateIpcOrder | Create IPC Order | Creates an IPC order with shared capacity at the account level. |
| CreateLiveRecordTemplate | CreateLiveRecordTemplate | Use this operation to create a Live Record Template. You can use the template to submit Live Recording Jobs. |
| CreateLiveSnapshotTemplate | CreateLiveSnapshotTemplate | Create a live stream snapshot template to facilitate the creation of snapshot jobs. |
| CreateLiveTranscodeTemplate | CreateLiveTranscodeTemplate | Creates a live stream transcoding template, which can be referenced when submitting a transcoding job. |
| CreatePipeline | CreatePipeline | Creates an ApsaraVideo Media Processing (MPS) queue. |
| 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. |
| CreateSearchIndex | Create Search Index | You can create a search index under a search library. A search library can contain multiple search indexes of different types. |
| CreateSearchLib | CreateSearchLib | Creates a search library to store media assets. |
| CreateSource | CreateSource | Creates a source in MediaWeaver. |
| CreateStreamToSearchLib | CreateStreamToSearchLib | Registers a live stream as a media asset. |
| CreateUploadMedia | CreateUploadMedia | This operation obtains the upload address and credential for audio, video, image, and auxiliary media assets, and creates the corresponding media assets. |
| CreateUploadStream | CreateUploadStream | Obtains the upload URL and credential of a media stream. |
| CreateYikeAssetUpload | Obtain audio and video upload URL and credential | Obtains an upload credential for a Yike media asset. |
| CreateYikeProduction | CreateYikeProduction | Creates a Yike production. |
| CreateYikeUser | CreateYikeUser | Creates a Yike user. |
| CreateYikeWorkspace | CreateYikeWorkspace | Creates a workspace. |
| DecryptKMSDataKey | DecryptKMSDataKey | Decrypts the ciphertext specified by CiphertextBlob in the Key Management Service (KMS) data key. |
| DeleteAIAgentDialogue | DeleteAIAgentDialogue | Deletes dialog records of an AI agent. |
| DeleteAvatarTrainingJob | DeleteAvatarTrainingJob | Deletes a digital human training job that is in the Init or Fail state. |
| DeleteCategory | DeleteCategory | Deletes a media asset category. |
| DeleteChannel | DeleteChannel | Deletes a channel. |
| DeleteCustomTemplate | DeleteCustomTemplate | Deletes a custom template. |
| DeleteCustomizedVoiceJob | DeleteCustomizedVoiceJob | Deletes a human voice cloning job that is not in the Training or Success state. |
| DeleteDNADB | DeleteDNADB | Deletes a media fingerprint library. |
| DeleteDNAFiles | DeleteDNAFiles | Deletes files from a media fingerprint library. |
| DeleteEditingProjectMaterials | DeleteEditingProjectMaterials | Deletes one or more materials from an online editing project. |
| DeleteEditingProjects | DeleteEditingProjects | Deletes one or more online editing project. |
| DeleteHotwordLibrary | DeleteHotwordLibrary | Deletes a specified hotword library based on the ID. |
| 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. |
| DeleteLiveRecordTemplate | DeleteLiveRecordTemplate | Deletes a live stream recording template without affecting existing jobs. |
| DeleteLiveSnapshotFiles | DeleteLiveSnapshotFiles | Deletes live snapshot files. You can delete only the records, or both the records and the original Object Storage Service (OSS) files. |
| DeleteLiveSnapshotTemplate | DeleteLiveSnapshotTemplate | Deletes a live stream snapshot template. |
| DeleteLiveTranscodeJob | Delete a real-time ApsaraVideo Media Processing job | Delete the specified real-time transcoding job. |
| DeleteLiveTranscodeTemplate | DeleteLiveTranscodeTemplate | Deletes a live stream transcoding template. |
| DeleteMediaFromSearchLib | Delete Media Asset from Search Library | Delete the specified media asset from the search library. |
| 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. |
| DeleteMediaMarks | DeleteMediaMarks | Deletes the marks of a media asset. |
| DeletePipeline | DeletePipeline | Deletes an ApsaraVideo Media Processing (MPS) queue. |
| DeletePlayInfo | DeletePlayInfo | Deletes media streams such as video streams and audio streams. |
| DeleteRecognitionEntity | DeleteRecognitionEntity | Deletes an entity from the specified custom recognition library. |
| DeleteRecognitionLib | DeleteRecognitionLib | Deletes a custom recognition library, including all entities and samples within it. |
| DeleteRecognitionSample | DeleteRecognitionSample | Deletes a sample for a custom entity. |
| DeleteSmartJob | DeleteSmartJob | Deletes intelligent jobs based on job IDs. |
| DeleteSource | DeleteSource | Deletes a source from MediaWeaver. |
| DeleteTemplate | DeleteTemplate | Deletes templates. |
| DeleteYikeAssetMediaInfos | Details of deleting media asset information | Deletes one or more media assets. |
| DescribeAIAgentInstance | Query Agent Instance Details | Retrieves information about a specified AI agent instance. |
| 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. |
| 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. |
| 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. |
| 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. |
| DescribeNotifyConfig | Query Agent Notification Configuration | Retrieves the event callback configuration for a specified AIAgent. |
| DescribePlayList | DescribePlayList | Retrieves playback records based on the player's TraceId. This API supports pagination. |
| DescribeRtcRobotInstance | Query an RTC interactive AI agent instance | Retrieves information about an RTC Robot Instance. |
| 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. |
| 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. |
| DropSearchLib | DropSearchLib | Deletes a search library and all media assets in the library. |
| ForwardAIAgentCall | Call Transfer API | Transfer the call to the target phone number. |
| GenerateAIAgentCall | Generate an AI Agent Call Instance | Creates an agent instance and returns the channel, username, and token to join the channel. |
| GenerateKMSDataKey | GenerateKMSDataKey | Generates a random Key Management Service (KMS) data key used for HTTP Live Streaming (HLS) encryption and transcoding of videos. |
| GenerateMessageChatToken | GenerateMessageChatToken | Generates the token required for interactive messaging. |
| 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. |
| GetAIWorkflowTask | GetAIWorkflowTask | Retrieves the details of a workflow task. |
| GetAiRtcAuthCodeList | GetAiRtcAuthCodeList | Retrieves a list of Real-time Conversational AI authentication codes and their status for a specified batch. |
| GetAiRtcLicenseInfoList | GetAiRtcLicenseInfoList | Retrieves details for AI Real-Time Communication license batches that match specified filter criteria. |
| GetAvatar | GetAvatar | Queries the information about a trained digital human. |
| GetAvatarTrainingJob | GetAvatarTrainingJob | Queries the information about a digital human training job. |
| 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. |
| GetCategories | GetCategories | Queries the information about a category and its subcategories. |
| GetContentAnalyzeConfig | Obtain Intelligent Content Analysis Configuration | Retrieves the configuration for Intelligent Content Analysis. |
| GetCustomTemplate | GetCustomTemplate | Gets the details of a Custom Template for Media Processing. |
| GetCustomizedVoice | GetCustomizedVoice | Queries the information about a personalized human voice. |
| GetCustomizedVoiceJob | GetCustomizedVoiceJob | Queries the information about a human voice cloning job. |
| GetDefaultStorageLocation | Obtain Default Storage Location | This topic describes the API request parameters and sample for obtaining the default storage configuration. |
| GetDemonstrationForCustomizedVoiceJob | GetDemonstrationForCustomizedVoiceJob | Queries the text to be read and sample audio for training a personalized human voice. |
| GetDynamicImageJob | GetDynamicImageJob | Queries the information about an image animation job. |
| GetEditingProject | GetEditingProject | Queries the information about an online editing project. |
| GetEditingProjectMaterials | GetEditingProjectMaterials | Retrieve all media assets bound to the current editing project. |
| GetEventCallback | GetEventCallback | Queries event callback configurations. |
| GetHotwordLibrary | GetHotwordLibrary | Queries the information about a specified hotword library based on the ID. |
| GetIpcDeviceInfo | Obtain IPC device information | Obtain IPC device information. |
| GetLiveEditingIndexFile | GetLiveEditingIndexFile | Queries the index file of a live stream. The index file is used to preview an editing project in the console. |
| 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. |
| GetLiveRecordJob | GetLiveRecordJob | Queries the information about a live stream recording job. |
| GetLiveRecordTemplate | GetLiveRecordTemplate | Queries the information about a live stream recording template or a snapshot of the template. |
| GetLiveSnapshotJob | GetLiveSnapshotJob | Queries the information a live stream snapshot job. |
| GetLiveSnapshotTemplate | GetLiveSnapshotTemplate | Queries the information about a live stream snapshot template. |
| GetLiveTranscodeJob | GetLiveTranscodeJob | Queries the information about a live stream transcoding job. |
| GetLiveTranscodeTemplate | GetLiveTranscodeTemplate | Queries the information a live stream transcoding template. |
| GetMediaConvertJob | Query an ApsaraVideo Media Processing job | MediaConvert task details |
| GetMediaInfo | GetMediaInfo | Retrieves media asset information using an Intelligent Media Services (IMS) `mediaId` or an `InputURL`. |
| GetMediaInfoJob | GetMediaInfoJob | Queries the information about a media information analysis job. |
| GetMediaMarks | GetMediaMarks | Queries the information about marks based on mark IDs. |
| GetMediaProducingJob | GetMediaProducingJob | Retrieves details for an editing and composition job, such as its task status, timeline, template, and data. |
| GetPackageJob | GetPackageJob | Queries the information about a packaging job. |
| GetPipeline | GetPipeline | Queries the information about an ApsaraVideo Media Processing (MPS) queue. |
| GetPlayInfo | GetPlayInfo | This API fetches the playback URL for a media file, such as video or audio, by its Media ID. Use this URL to play the media with the Alibaba Cloud Player SDK (for URL-based playback) or a third-party player. |
| GetProjectExportJob | GetProjectExportJob | Gets information about a project export task. |
| 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. |
| GetSmartHandleJob | GetSmartHandleJob | Retrieves the information and execution result of an intelligent task by task ID. This API can only query clipping tasks from the past year. |
| GetSnapshotJob | GetSnapshotJob | Queries the information about a snapshot job. |
| GetSnapshotUrls | GetSnapshotUrls | Queries the accessible URLs of the output images of a snapshot job. |
| GetSource | GetSource | Queries a source. |
| GetStorageList | GetStorageList | Obtains storage configurations. |
| GetStreamTagList | GetStreamTagList | Retrieves tags of a live stream media asset. |
| GetSystemTemplate | GetSystemTemplate | Queries the information about a system template. |
| 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. |
| 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 | Obtain template parameter information | Obtain the replaceable material parameter information of a template, including the parameter name, default material value, and material thumbnail. Currently, only advanced templates are supported. |
| GetTranscodeJob | GetTranscodeJob | Queries the details of a single transcoding job. |
| GetUrlUploadInfos | GetUrlUploadInfos | Queries the information about URL-based upload jobs. |
| GetVideoList | GetVideoList | Gets information about video and audio files. |
| 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. |
| GetYikeAIAppJob | Obtain Job Result Details | Retrieves the details of a Yike AI App job. |
| GetYikeAssetMediaInfo | Obtain media asset information details | Gets media asset information. |
| GetYikeStoryboardJob | Query storyboard generation Job | Retrieves the details of a Yike storyboard job. |
| GetYikeUser | GetYikeUser | Gets information about a Yike sub-account. |
| GetYikeUserCredit | GetYikeUserCredit | Retrieves the credit balance for a Yike user. |
| InsertMediaToSearchLib | Insert a media asset into the search library | Insert a media asset into the search library. |
| ListAIAgentDialogues | ListAIAgentDialogues | Returns the session history. |
| ListAIAgentInstance | Query AI Agent Instance List | List AI agent instances. You can retrieve all instances or filter them by specified conditions. |
| ListAIAgentPhoneNumber | List user phone resources | List user phone resources API. |
| ListAIAgentVoiceprints | ListAIAgentVoiceprints | Retrieves a list of AI agent voiceprints. |
| ListAlerts | ListAlerts | Lists alerts received in MediaWeaver. |
| ListAllPublicMediaTags | ListAllPublicMediaTags | Queries a list of tags of media assets in the public media library. |
| ListAvatarTrainingJobs | ListAvatarTrainingJobs | Queries a list of digital human training jobs. |
| ListAvatars | ListAvatars | Queries a list of trained digital humans. |
| ListBatchMediaProducingJobs | ListBatchMediaProducingJobs | Queries a list of quick video production jobs based on conditions such as the job type and state. |
| ListCustomTemplates | ListCustomTemplates | Retrieves a list of user-defined Video on Demand (VOD) media processing templates. |
| ListCustomizedVoiceJobs | ListCustomizedVoiceJobs | Queries a list of human voice cloning jobs. |
| ListCustomizedVoices | ListCustomizedVoices | Queries a list of personalized human voices. |
| ListDNADB | ListDNADB | Queries a list of media fingerprint libraries. |
| ListDNAFiles | ListDNAFiles | Lists files in a media fingerprint library. |
| ListDynamicImageJobs | ListDynamicImageJobs | Queries a list of image animation jobs. |
| ListEditingProjects | ListEditingProjects | Queries a list of projects that meet the specified conditions. You can filter projects by project creation time. |
| ListHotwordLibraries | ListHotwordLibraries | Queries hotword libraries that meet specific search conditions. |
| ListLiveRecordFiles | ListLiveRecordFiles | Queries all recording index files in the specified period of time. |
| ListLiveRecordJobs | ListLiveRecordJobs | Queries a list of live stream recording jobs by page. |
| ListLiveRecordTemplates | ListLiveRecordTemplates | Call `ListLiveRecordTemplates` to retrieve a list of your real-time recording templates. |
| ListLiveSnapshotFiles | ListLiveSnapshotFiles | Queries a list of live stream snapshot files by page. |
| ListLiveSnapshotJobs | ListLiveSnapshotJobs | Retrieves a paginated list of live snapshot jobs. |
| ListLiveSnapshotTemplates | ListLiveSnapshotTemplates | Returns a paginated list of Live Snapshot templates. |
| ListLiveTranscodeJobs | ListLiveTranscodeJobs | Queries a list of live stream transcoding jobs. |
| ListLiveTranscodeTemplates | ListLiveTranscodeTemplates | Queries a list of live stream transcoding templates. |
| ListMediaBasicInfos | ListMediaBasicInfos | Returns basic information about media assets that match the specified parameters. |
| ListMediaConvertJobs | ListMediaConvertJobs | This operation lists media convert jobs. |
| ListMediaInfoJobs | ListMediaInfoJobs | Queries a list of media information analysis jobs. |
| ListMediaMarks | ListMediaMarks | Queries a list of marks of a media asset. |
| 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. |
| ListPackageJobs | ListPackageJobs | Queries packaging jobs. |
| ListPipelines | ListPipelines | Queries a list of ApsaraVideo Media Processing (MPS) queues. |
| 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. |
| 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. |
| ListRecognitionSamples | Retrieve the list of detection samples for a Custom entity | Retrieves all samples of a custom entity. Pagination is supported. |
| ListSearchLib | Obtain the search library list | Retrieves a list of search libraries. |
| ListSmartJobs | ListSmartJobs | Queries a list of intelligent jobs based on specified parameters. |
| ListSmartSysAvatarModels | ListSmartSysAvatarModels | Lists the system Digital Avatars. This operation supports pagination. |
| ListSmartVoiceGroups | List Intelligent Speech Voice Information | Lists available Smart Voice voices, grouped by Scenario. This operation returns the name, gender, and Sample Audio for each voice. |
| ListSnapshotJobs | ListSnapshotJobs | Queries a list of snapshot jobs. |
| ListSystemTemplates | ListSystemTemplates | Queries a list of system templates. |
| 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. |
| ListTranscodeJobs | ListTranscodeJobs | Lists the transcoding jobs for a media file. |
| ListWorkflowTasks | ListWorkflowTasks | Retrieves workflow tasks. |
| ListYikeAssetFolders | Retrieve Folder List | Retrieves a list of Yike folders. |
| ListYikeProductions | Retrieve the project list | Queries the list of Yike projects. |
| PrecheckYikeAIAppJob | PrecheckYikeAIAppJob | Validates the parameters of an application. |
| QueryCopyrightExtractJob | QueryCopyrightExtractJob | Queries a job for extracting a copyright watermark. |
| QueryCopyrightJobList | QueryCopyrightJobList | Queries copyright watermarking jobs. |
| QueryDNAJobList | QueryDNAJobList | Queries a list of media fingerprint analysis jobs. |
| QueryIProductionJob | Query Intelligent Production Job | Call `QueryIProductionJob` to get the status and result of an intelligent production job. |
| QueryIpcQuota | Query IPC usage | Query IPC usage. |
| QueryMediaCensorJobDetail | QueryMediaCensorJobDetail | Queries the information about a content moderation job. |
| QueryMediaCensorJobList | QueryMediaCensorJobList | Queries a list of content moderation jobs. |
| QueryMediaIndexJob | QueryMediaIndexJob | Queries the indexing jobs enabled for a media asset. |
| QuerySearchIndex | QuerySearchIndex | Gets details about a search index. |
| QuerySearchLib | Query Search Library | Gets information about a search library. |
| QuerySmarttagJob | QuerySmarttagJob | Query Smart Tag tasks. |
| QueryTraceAbJobList | QueryTraceAbJobList | Queries A/B watermarking jobs. |
| QueryTraceExtractJob | QueryTraceExtractJob | Queries a job for extracting a trace watermark. |
| QueryTraceM3u8JobList | QueryTraceM3u8JobList | Queries jobs for generating M3U8 files containing specific trace watermark information. |
| QueryVideoCognitionJob | QueryVideoCognitionJob | Querying video understanding task results |
| RefreshUploadMedia | RefreshUploadMedia | Obtain a new upload credential for a media asset after its upload credential expires. |
| RegisterMediaInfo | RegisterMediaInfo | Registers a media asset with Intelligent Media Services (IMS). IMS assigns an ID to the media asset. This operation asynchronously accesses the media asset service in which the media asset is stored to obtain the file information of the media asset based on the input URL. You can also specify basic information, such as the title, tags, and description, for the media asset. This operation returns the ID of the media asset. You can call the GetMediaInfo operation based on the ID to query the details of the media asset. You can set InputURL only to the URL of an Object Storage Service (OSS) file or an ApsaraVideo VOD media asset. |
| 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. |
| RegisterYikeAssetMediaInfo | Register media asset information | Registers a media asset in the asset library. |
| ResumeYikeStoryboardJob | ResumeYikeStoryboardJob | Resumes a storyboard job. |
| SearchEditingProject | SearchEditingProject | Queries online editing projects by creation time and status. |
| SearchIndexJobRerun | Rerun Search Index Job | Rerun the search index jobs for the specified media assets in batch. You can rerun index jobs for up to 20 media assets per request. |
| SearchMedia | Search Media Information | Returns media assets that match the specified conditions. |
| SearchMediaByAILabel | DataQ - Smart Tag Service Text Search | You can perform multimodal search based on person names, captions, and AI categorization. |
| SearchMediaByFace | Search Media Assets by Face Image | Search media assets by face image (coarse search). Input a face image to retrieve information about media assets containing the person in the image. |
| 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. |
| SearchMediaByMultimodal | LLM Search | LLM search. You can use natural language descriptions to perform searches. |
| SearchMediaClipByFace | Search media asset clips by face image | The API for searching media asset segments by face image (fine search) returns information about relevant character segments in the media asset where the face appears, based on coarse search results. |
| SearchPublicMediaInfo | Search public copyright media assets | Search for media assets that meet the conditions based on the parameters provided by the User. |
| SendAIAgentDataChannelMessage | SendAIAgentDataChannelMessage | Sends a DataChannel message to an AI agent. |
| SendAIAgentSpeech | Send AI Agent Voice Message | Instructs a specified agent instance to immediately play back a text message, with support for interrupt settings. |
| SendAIAgentText | SendAIAgentText | Sends a message as input to the large language model (LLM). |
| SendLiveSnapshotJobCommand | SendLiveSnapshotJobCommand | Sends a command to process a live stream snapshot job. |
| SendLiveTranscodeJobCommand | SendLiveTranscodeJobCommand | Sends a command to process a live stream transcoding job. |
| SendMessageChatText | SendMessageChatText | Sends a message to the client. |
| SetAIAgentVoiceprint | SetAIAgentVoiceprint | Registers a voiceprint. |
| SetContentAnalyzeConfig | Configure Intelligent Content Analysis | Configures settings for Intelligent Content Analysis. |
| SetDefaultCustomTemplate | SetDefaultCustomTemplate | Sets a custom template as the default template. |
| SetDefaultStorageLocation | Set Default Storage Location | Set the default storage path for temporary files. The default storage address is used by the ICE online editor and the integrated web SDK to store temporary files generated during video editing, such as audio files generated by Intelligent configurations. Setting a default storage address avoids inconveniencing users who would otherwise need to specify storage paths for various temporary resources during editing. If you integrate ICE editing capabilities through an API, you can flexibly specify the path in the API request, and this default path will not take effect. |
| SetEventCallback | SetEventCallback | Configures a callback method for one or more events. |
| SetNotifyConfig | SetNotifyConfig | Enables or disables event notifications for an AI Agent and sets the Callback URL and the Event Types to subscribe to. |
| SetYikeUserRole | SetYikeUserRole | Sets a user role. |
| StartAIAgentInstance | Start an Agent Instance | Start an AI agent instance configured in IMS. |
| 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. |
| StartAIWorkflow | StartAIWorkflow | Initiates a workflow task for automated media processing based on a workflow template. |
| StartRtcRobotInstance | Start RTC Interactive AI Agent Instance | Starts an RTC interactive AI agent instance and joins an RTC call. |
| StartWorkflow | Submit Flow Task | By invoking the StartWorkflow API, you can submit a media workflow template task to implement an automated media processing flow based on the workflow template. |
| StopAIAgentInstance | Stop Agent Instance | Stop an agent instance. |
| StopAIWorkflowTask | StopAIWorkflowTask | Manually stops a workflow task. |
| StopRtcRobotInstance | Stop RTC Interactive AI Agent Instance | Stop an RTC interactive AI agent instance. |
| SubYikeUserCredit | SubYikeUserCredit | Deducts credits from a sub-account. |
| 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. |
| SubmitASRJob | Submit an ASR intelligent subtitling Job | Transcribes speech from a media file and returns the text with corresponding start and end timestamps. |
| SubmitAudioProduceJob | SubmitAudioProduceJob | This API converts text into a high-quality audio file of speech. |
| SubmitAvatarTrainingJob | SubmitAvatarTrainingJob | Use this operation to submit a new avatar training job or to resubmit a failed job. |
| SubmitAvatarVideoJob | SubmitAvatarVideoJob | Renders an avatar video from text or an audio file. |
| SubmitBatchMediaProducingJob | Batch Intelligent One-click Video Production | Intelligently edits and combines multiple video, audio, and image media assets to create videos in batches with a single API call. |
| SubmitCopyrightExtractJob | SubmitCopyrightExtractJob | Submits a copyright watermark extraction job. |
| SubmitCopyrightJob | SubmitCopyrightJob | Submits a video copyright watermark job. |
| SubmitCustomizedVoiceJob | SubmitCustomizedVoiceJob | Submits a basic voice cloning job. |
| SubmitDNAJob | SubmitDNAJob | Submits a DNA job. |
| 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. |
| SubmitDynamicImageJob | SubmitDynamicImageJob | Use this API to submit a task to generate a dynamic image. |
| SubmitHighlightExtractionJob | SubmitHighlightExtractionJob | Submits a highlight extraction job. |
| SubmitIProductionJob | Submit an Intelligent Production Job | Use the `SubmitIProductionJob` operation to submit an intelligent production job. |
| SubmitLiveEditingJob | SubmitLiveEditingJob | Live editing creates an output file by combining one or more segments from live streams. After you submit a live editing job, it is processed asynchronously. You can then call the GetLiveEditingJob operation with the returned JobId to query the job status, or call the GetMediaInfo operation with the MediaId to get details of the generated media asset. |
| SubmitLiveRecordJob | SubmitLiveRecordJob | Submits a live stream recording job. |
| SubmitLiveSnapshotJob | SubmitLiveSnapshotJob | Submits a live stream snapshot job. If the job is submitted during stream ingest, it automatically starts in asynchronous mode. Otherwise, it does not start. |
| SubmitLiveTranscodeJob | SubmitLiveTranscodeJob | Submits a live stream transcoding job. |
| 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. |
| SubmitMediaCensorJob | SubmitMediaCensorJob | Submits a censor job to ApsaraVideo for Media Processing to automatically moderate media files. This operation detects non-compliant, sensitive, or inappropriate content in video, audio, and image files. |
| SubmitMediaConvertJob | SubmitMediaConvertJob | Submit a media processing job |
| SubmitMediaInfoJob | SubmitMediaInfoJob | Creates an asynchronous job to retrieve media information. |
| SubmitMediaProducingJob | SubmitMediaProducingJob | The `SubmitMediaProducingJob` API submits a media production job. This job provides automated processing for post-production tasks, such as editing and composing video and audio assets. |
| SubmitPackageJob | SubmitPackageJob | Submits a packaging job. |
| SubmitProjectExportJob | SubmitProjectExportJob | Submits a project export task. |
| SubmitSceneBatchEditingJob | SubmitSceneBatchEditingJob | Submits a batch job to render multiple videos by providing a list of editing project IDs. |
| 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. |
| 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. |
| SubmitScreenMediaHighlightsJob | SubmitScreenMediaHighlightsJob | Analyzes media assets, such as short-form dramas, to automatically identify highlight clips and generate a highlight compilation. |
| 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. |
| SubmitSmarttagJob | SubmitSmarttagJob | Submits a Smarttag Job. |
| 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. |
| SubmitSportsHighlightsJob | SubmitSportsHighlightsJob | Starts a job to generate a highlight video from sports footage with commentary. |
| SubmitStandardCustomizedVoiceJob | SubmitStandardCustomizedVoiceJob | Submits a standard human voice cloning job. After you call this operation, the JobId is returned. The training process is asynchronous. During training, you can call the GetCustomizedVoiceJob operation to query information such as the job state. |
| SubmitSyncMediaInfoJob | SubmitSyncMediaInfoJob | Submits a media file in synchronous mode for media information analysis. |
| 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. |
| SubmitTraceAbJob | SubmitTraceAbJob | Submits a job to generate A/B stream variants of a video for forensic watermarking. |
| SubmitTraceExtractJob | SubmitTraceExtractJob | Submits a trace watermark extraction job. |
| SubmitTraceM3u8Job | SubmitTraceM3u8Job | Submits a job to process an M3U8 file for video watermarking for tracing. |
| SubmitTranscodeJob | SubmitTranscodeJob | Call the SubmitTranscodeJob operation to submit a video or audio transcoding job to Intelligent Media Services. In the request, you must specify the source file to transcode, the output format, and related parameters. |
| SubmitVideoCognitionJob | SubmitVideoCognitionJob | Submits a video cognition job. |
| 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. |
| SubmitYikeAIAppJob | Submit an application job | Submits a Yike AI application job. |
| SubmitYikeStoryboardJob | Submit a storyboard generation job | Submits a Yike AI application job. |
| TakeoverAIAgentCall | TakeoverAIAgentCall | Hands off a conversation to a human agent. |
| UpdateAIAgentInstance | Update AI Agent Instance Configuration | Modifies the configuration of a specified AI agent instance. |
| 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. |
| UpdateCategory | UpdateCategory | Updates a category. |
| UpdateCustomTemplate | UpdateCustomTemplate | Updates a custom template. |
| UpdateCustomizedVoice | UpdateCustomizedVoice | Updates a personalized human voice. Only the media asset ID of the sample audio file can be modified. |
| UpdateEditingProject | UpdateEditingProject | Modifies an online editing project. Modify the configurations such as the title, timeline, and thumbnail of an online editing project. |
| UpdateHotwordLibrary | UpdateHotwordLibrary | Modifies a specified hotword library, including its name, description, and hotword list. |
| UpdateLiveRecordTemplate | UpdateLiveRecordTemplate | Updates the information about a live stream recording template. |
| UpdateLiveSnapshotTemplate | UpdateLiveSnapshotTemplate | Updates the information about a live stream snapshot template. |
| UpdateLiveTranscodeJob | UpdateLiveTranscodeJob | Updates the information about a live stream transcoding job. |
| UpdateLiveTranscodeTemplate | UpdateLiveTranscodeTemplate | Updates the information about a live stream transcoding template. |
| 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. |
| UpdateMediaMarks | UpdateMediaMarks | Modifies the marks of a media asset. |
| UpdateMediaToSearchLib | Update Media Asset to Search Library | Update media asset information in the search library. |
| UpdatePipeline | UpdatePipeline | Updates the information about an ApsaraVideo Media Processing (MPS) queue. |
| UpdateRtcRobotInstance | Update RTC Interactive AI Agent Instance | Updates the configuration of an RTC AI Agent instance, such as its voice and greeting. |
| UpdateTemplate | UpdateTemplate | Modifies an online editing template. You can modify the template title and template configurations. |
| UploadMediaByURL | UploadMediaByURL | The UploadMediaByURL API uploads audio or video files from source URLs. It supports batch uploads and is ideal for uploading files from a public URL instead of a local server or device. |
| UploadStreamByURL | UploadStreamByURL | Uploads a media stream file based on the URL of the source file. |
该文章对您有帮助吗？