API overview
Updated at:
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 media assets | Retrieves media asset information that matches the specified parameters. |
| GetVideoList | Retrieve a list of media assets | Retrieves a list of video information. |
| 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 for media asset clips by face image | Queries media asset clips by face image in exact search mode and returns the clip information of the matched person in the media assets based on rough search results. |
| Smart tag search | Smart tag search | |
| SearchMediaByAILabel | Search smart tag text | Performs a multimodal search based on person names, subtitles, and AI categories. |
| Foundation model search | Foundation model search | |
| SearchMediaByMultimodal | Search by using large models | Searches for media assets by using large models. Users can perform searches by using natural language descriptions. |
| SearchMediaByHybrid | Hybrid search | Performs hybrid search for media assets. Combines intelligent tag text search and large model search capabilities for 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 the IMS media ID or the media asset input URL. |
| 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 | Delete media asset content | Deletes media asset information in batches. A maximum of 20 media assets can be deleted at a time. If MediaIds is not empty, MediaIds takes precedence. If MediaIds is empty, InputURLs must not be empty. |
| BatchGetMediaInfos | Retrieve media asset information in batches | Retrieves the information of one or more media assets. |
| ListMediaBasicInfos | List basic information of media assets | Queries the basic information of all media assets that match the specified parameters. |
| ListPublicMediaBasicInfos | List basic information about public media library assets | Lists basic information about media assets in the public media library that meet the specified conditions. A maximum of 100 media assets can be returned. |
| ListAllPublicMediaTags | List all tags in the public media asset library | Lists all tags for media assets in the public media asset library. |
| SubmitMediaAiAnalysisJob | Submit an intelligent structural analysis task for media assets | Performs structural analysis on media assets, such as speaker diarization, video translation, and paragraph summarization for 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 | Add mark information to a media asset | Adds mark information to a media asset such as a video or audio file for subsequent retrieval, analysis, and management. |
| 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 | List all mark information of a media asset | Lists all mark information 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 moderation
|
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 | Query content moderation job details | Queries the details of a content moderation job. |
Configuration management
|
API |
Title |
Description |
| Template management | Template management | |
| GetSystemTemplate | GetSystemTemplate | Queries the information about a system template. |
| SetDefaultCustomTemplate | Set default custom template | Sets the default custom template for VOD media processing. |
| 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 | List custom templates | Queries a list of custom VOD media processing templates. |
Media processing
|
API |
Title |
Description |
| Transcoding | Transcoding | |
| 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 video or audio transcoding job to Intelligent Media Services (IMS) by specifying the source file to be transcoded, the output format, and related parameters. |
| GetTranscodeJob | Query a transcoding job | Queries the details of a single transcoding job. |
| ListTranscodeJobs | List transcoding jobs | Queries a list of transcoding jobs for media files. |
| SubmitPackageJob | SubmitPackageJob | Submits a packaging job. |
| GetPackageJob | GetPackageJob | Queries the information about a packaging job. |
| ListPackageJobs | List packaging jobs | Queries the list of 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). |
| Snapshots | Snapshots | |
| SubmitSnapshotJob | Submit a snapshot job | Submits a snapshot job. You can specify the ID or URL of a media file, the snapshot time, and the format. The system generates snapshots based on these parameters and saves them to the specified location. |
| SubmitDynamicImageJob | Submit an animated image task | Submits a task to generate an animated image. |
| GetSnapshotUrls | GetSnapshotUrls | Queries the accessible URLs of the output images of a snapshot job. |
| GetSnapshotJob | Query snapshot job details | Queries the details of a snapshot job. |
| GetDynamicImageJob | Query dynamic image task details | Queries the details of a dynamic image task. |
| ListSnapshotJobs | Retrieve snapshot jobs | Retrieves a list of snapshot jobs. |
| ListDynamicImageJobs | List animated image tasks | Retrieves a list of animated image tasks. |
| Media information | Media information | |
| SubmitSyncMediaInfoJob | Submit a synchronous media information job | Submits a media file for media information analysis in synchronous mode. |
| SubmitMediaInfoJob | Submit an asynchronous media information task | Submits an asynchronous media information task. |
| 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 jobs. |
| GetLiveTranscodeTemplate | GetLiveTranscodeTemplate | Queries the information a live stream transcoding template. |
| UpdateLiveTranscodeTemplate | Update real-time media transcoding template | Updates a real-time 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 | Send a real-time video transcoding task instruction | Sends a real-time video transcoding task instruction. |
| 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 media transcoding task | Deletes a specified real-time transcoding task. |
| 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 | Retrieve live recording template details | Retrieves the details of a live recording template or a task template snapshot. |
| UpdateLiveRecordTemplate | UpdateLiveRecordTemplate | Updates the information about a live stream recording template. |
| DeleteLiveRecordTemplate | DeleteLiveRecordTemplate | Deletes a live stream recording template without affecting existing jobs. |
| ListLiveRecordTemplates | List live recording templates | Queries the list of live recording templates. |
| SubmitLiveRecordJob | Submit a real-time recording task | Submits a real-time recording task to record a live stream by calling SubmitLiveRecordJob. |
| GetLiveRecordJob | Retrieve live recording job details | Retrieves the details of a single live 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 paginated list of real-time recording jobs. |
| ListLiveRecordFiles | ListLiveRecordFiles | Queries all recording index files in the specified period of time. |
| Real-time media snapshots | Real-time media snapshots | |
| CreateLiveSnapshotTemplate | Create a live snapshot template | Creates a live snapshot template that can be used to create snapshot tasks. |
| GetLiveSnapshotTemplate | Retrieve a live snapshot template | Retrieves a single live snapshot template. |
| UpdateLiveSnapshotTemplate | Update a real-time snapshot template | Updates a real-time snapshot template. |
| DeleteLiveSnapshotTemplate | DeleteLiveSnapshotTemplate | Deletes a live stream snapshot template. |
| ListLiveSnapshotTemplates | List live snapshot templates | Queries a list of live snapshot templates with pagination support. |
| SubmitLiveSnapshotJob | Submit a real-time snapshot task | Submits a real-time snapshot task. If the task is submitted during an active stream, it is automatically started 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 | Retrieve a live snapshot job | Retrieves a single live 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 | List live snapshot jobs | Queries the list of live snapshot jobs with pagination support. |
| ListLiveSnapshotFiles | List live snapshot files | Queries a paginated list of live snapshot files. |
Media production
|
API |
Title |
Description |
| Cloud editor project management | Cloud editor project management | |
| CreateEditingProject | Create a cloud editing project | Creates a cloud editing project. You can set the title, description, timeline, and cover of the project. |
| GetEditingProject | Get a single cloud editing project | Queries the details of a single cloud 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 | List editing projects that meet specified conditions | Lists the editing projects that meet the specified conditions and supports filtering by creation time. |
| AddEditingProjectMaterials | Add materials to an editing project | Adds one or more materials to an editing project. |
| GetEditingProjectMaterials | Retrieve media assets associated with the editing project | Retrieves all media assets associated with the current 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. |
| Video editing | Video editing | |
| 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 a video editing and producing job | Queries the details of a video editing and producing job, including the task 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 | Retrieve batch intelligent one-click video production task information | Queries the details of batch intelligent one-click video production jobs, including the input parameters, task status, and the IDs and URLs of the produced media assets. This operation supports querying only task data from the past year. |
| SubmitSportsHighlightsJob | Submit sports highlights task | Generates a sports highlights video from sports event footage that contains commentary. |
| SubmitScreenMediaHighlightsJob | Submit a high-energy video compilation task | Submits a task to automatically identify highlight clips from video materials such as short dramas and synthesize them into high-energy compilation videos. |
| 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 | List one-click video production jobs that meet specified conditions | Lists one-click video production nodes that meet conditional requirements and supports conditional query based on node type, status, and other conditions. |
| 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. |
| Smart tasks | Smart tasks | |
| Hot word management | Hot word management | |
| DeleteHotwordLibrary | DeleteHotwordLibrary | Deletes a specified hotword library based on the ID. |
| GetHotwordLibrary | Retrieve hotword library | Queries the hotword library. |
| ListHotwordLibraries | List all hotword libraries | Retrieves the information of all hotword libraries based on specified conditions. |
| UpdateHotwordLibrary | Update a hotword library | Updates the information of a specified hotword library, including the name, description, and hotword list. |
| CreateHotwordLibrary | Create a hotword library | 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 | Update digital human training task information | Updates the information of a digital human training task. This operation allows you to: 1. Modify basic information. 2. Update parameters such as Video and Transparent to retrain the digital human after a training failure. |
| SubmitAvatarTrainingJob | SubmitAvatarTrainingJob | Use this operation to submit a new avatar training job or to resubmit a failed job. |
| GetAvatarTrainingJob | Query the details of a digital human training task | Queries the details of a single digital human task. |
| DeleteAvatarTrainingJob | Delete a digital human training task | Deletes a digital human training task that is in the init (draft) or training failed status. |
| ListAvatarTrainingJobs | List digital human training tasks | Queries the list of digital human training tasks under your account. |
| GetAvatar | Query a digital human | Queries the details of a specified digital human that has been successfully trained. |
| ListAvatars | List digital humans | Queries the details of all successfully trained digital humans under your account. |
| Voice cloning | Voice cloning | |
| SubmitCosyVoiceCustomizedVoiceJob | Submit a cosyVoice voice cloning training job | Submits a CosyVoice voice cloning training job. |
| CreateCustomizedVoiceJob | Create a voice cloning task (Basic edition) | Creates a voice cloning task to initialize the basic configuration information for the task. |
| GetDemonstrationForCustomizedVoiceJob | Retrieve demonstration text and audio (Basic edition) | Retrieves the text and sample audio required to train a personalized voice. |
| DetectAudioForCustomizedVoiceJob | Submit audio check (Basic edition) | Checks whether the user's reading contains obvious pronunciation errors or background noise. After the audio check is completed, qualified audio files are temporarily stored in the cloud for subsequent voice 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 | Query a voice cloning task | Queries a single voice cloning task. |
| DeleteCustomizedVoiceJob | Delete a voice cloning task | Deletes a voice cloning task that is not in the "Training" or "Training Succeeded" state. |
| ListCustomizedVoiceJobs | List voice cloning tasks | Lists all voice cloning training tasks for the current user. |
| GetCustomizedVoice | Query a customized voice | Queries the details of a specific customized voice. |
| UpdateCustomizedVoice | UpdateCustomizedVoice | Updates a personalized human voice. Only the media asset ID of the sample audio file can be modified. |
| ListCustomizedVoices | List personalized voices | Lists all personalized voices of the current user. |
| SubmitASRJob | Submit an ASR intelligent subtitling job | Extracts the start and end timestamps and the corresponding text from video audio. |
| SubmitAvatarVideoJob | Submit a digital human rendering task | Renders a digital human video by using human voice audio or text as input. |
| SubmitAudioProduceJob | Submit an intelligent speech task | Converts the provided text content into high-quality speech audio files. |
| SubmitTextGenerateJob | Submit a keyword expansion task | Expands marketing copy based on the submitted keywords, word count, and number of copies. Due to the characteristics of the Chinese language, the word count of the generated copy may differ from the requested word count. After you submit the task, call the GetSmartHandleJob operation by using the job ID to query the task status and results. |
| SubmitVideoTranslationJob | Submit a video translation task | Submits a video translation task. This operation supports subtitle-level translation (translating subtitles in a video into a specified language), voice-level translation (translating spoken content in audio into a specified language), and face-level translation (lip-sync adaptation). |
| SubmitHighlightExtractionJob | Submit a highlight extraction task | Submits a highlight extraction task. |
| SubmitSegmentationJob | Submit a video splitting task | Splits a long video into multiple video clips and outputs multiple video files or media assets. |
| GetSmartHandleJob | Retrieve smart node task results | Retrieves the task result of a smart node. You can obtain the smart node information and execute result based on the node ID. This operation only supports querying editing node data 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 | Lists information about intelligent speech voices, including voice names, genders, and sample audio, 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 | Instructs a specified agent instance to immediately broadcast a text message, with support for interruption 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 | AICallKit integration | |
| 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 dialogue records | Lists the history of a session. |
| DeleteAIAgentDialogue | DeleteAIAgentDialogue | Deletes dialog records of an AI agent. |
| SendMessageChatText | Send a message to an IM client | Sends a message to an IM client. |
| Carrier lines | Carrier lines | |
| StartAIAgentOutboundCall | Initiate an outbound call by using an AI agent | Initiates an outbound call by using an AI agent to call a specified callee number from a caller number and returns the instance ID of the call. |
| ListAIAgentPhoneNumber | List user phone number resources | Lists phone number resources of a user. |
| 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 | Submit a video moderation task | Submits a video moderation task that uses an AI agent to review video content. This operation supports Object Storage Service (OSS) input, allows you to customize video frame capture policies and moderation rules, and returns moderation results through asynchronous callbacks. |
| 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 | |
| Tasks | Tasks | |
| SubmitVideoCognitionJob | SubmitVideoCognitionJob | Submits a video cognition job. |
| QueryVideoCognitionJob | QueryVideoCognitionJob | Querying video understanding task results |
| Custom recognition entities | Custom recognition entities | |
| CreateRecognitionEntity | Create an entity to be recognized in a custom recognition library | Creates a new entity to be recognized in a specified custom recognition library. You can use this operation to add custom recognition entities such as landmarks, objects, logos, and faces. |
| CreateRecognitionLib | Create a custom recognition library | Creates a custom recognition library to store entity information for recognition. |
| CreateRecognitionSample | Register recognition samples for a custom entity | Adds recognition sample images or text labels to a specified custom entity for subsequent recognition and matching. |
| 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 | List entities in a custom recognition library | Performs a paged query to retrieve all entity information in a specified recognition library by using paging. |
| ListRecognitionLibs | Retrieve a list of custom recognition libraries | Queries all custom recognition library information of the current user by paging. |
| 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. |
| QueryIProductionJob | Query an intelligent production job | Queries the status and results of an intelligent production job. |
| Media fingerprint | Media fingerprint | |
| CreateDNADB | Create a DNA library | Creates a DNA library. |
| DeleteDNADB | Delete a DNA library | Deletes a DNA library. |
| ListDNADB | Query media fingerprint libraries | Queries media fingerprint libraries. |
| SubmitDNAJob | SubmitDNAJob | Submits a DNA job. |
| CancelDNAJob | Cancel a DNA job | Cancels a DNA job. |
| DeleteDNAFiles | Delete DNA files | Deletes DNA files by calling DeleteDNAFiles. |
| ListDNAFiles | Query DNA files | Queries DNA files by calling ListDNAFiles. |
| QueryDNAJobList | List DNA jobs | Queries DNA jobs. |
| Digital watermarking | Digital watermarking | |
| SubmitCopyrightJob | Submit a video copyright watermark job | Submits a video copyright watermark job. |
| QueryCopyrightJobList | QueryCopyrightJobList | Queries copyright watermarking jobs. |
| SubmitCopyrightExtractJob | SubmitCopyrightExtractJob | Submits a copyright watermark extraction job. |
| QueryCopyrightExtractJob | Query copyright watermark extraction jobs | Queries copyright watermark extraction jobs. |
| 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 | Submit a video tracing watermark m3u8 job | Submits a video tracing watermark m3u8 file job. |
| QueryTraceM3u8JobList | QueryTraceM3u8JobList | Queries jobs for generating M3U8 files containing specific trace watermark information. |
| SubmitTraceExtractJob | SubmitTraceExtractJob | Submits a trace watermark extraction job. |
| QueryTraceExtractJob | Query tracing watermark extraction jobs | Queries tracing watermark extraction jobs. |
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 | Query MPS-AI metering data in IMS | Queries the MPS-AI usage in IMS. The maximum query range is 31 days, and data from up to 90 days ago can be queried. |
Global configuration
|
API |
Title |
Description |
| SetEventCallback | SetEventCallback | Configures a callback method for one or more events. |
| GetEventCallback | GetEventCallback | Queries event callback configurations. |
Workflows
|
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 | Query a workflow task | Queries a workflow task by task ID, including the workflow ID, workflow task status, and workflow task result. This operation only supports querying workflow task data from the past year. |
| ListWorkflowTasks | List workflow task instances | Lists workflow task instances. |
| 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. |
Wanjing yike
|
API |
Title |
Description |
| RegisterYikeAssetMediaInfo | Register media asset information | Registers a content library resource. |
| ListYikeProductions | List projects | Retrieves a list of 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 | Query smart tagging jobs | Queries smart tagging jobs. |
| Full configuration--deprecated | Full configuration--deprecated | |
| SetContentAnalyzeConfig | Set intelligent content analysis configuration | Calls SetContentAnalyzeConfig to set the configuration 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 | Retrieve public copyrighted media assets | Retrieves media asset information based on the media ID of ICE public copyrighted media assets. The URL returned by the operation is the preview or trial playback address of the copyrighted media asset, and the official material is used during production. |
| SearchPublicMediaInfo | Search public copyright media assets | Searches for media assets that match the specified parameters. |
| GetStorageList | Retrieve OSS storage addresses | Retrieves a list of storage configurations. |
| SearchEditingProject | Search cloud editing projects | Searches for cloud editing projects by creation time and status. |
| StopRtcRobotInstance | Stop a real-time conversational AI agent instance | Stops a Real-time Conversational AI agent instance. |
| StartRtcRobotInstance | Start an RTC interactive AI agent instance | Starts a Real-time Conversational AI agent instance and joins an RTC call. |
| UpdateRtcRobotInstance | Update a real-time conversational AI agent instance | Updates the configuration of a Real-time Conversational AI agent instance, such as the voice and greeting. |
| DescribeRtcRobotInstance | Query an RTC real-time conversational AI agent instance | Queries the information of a Real-Time Communication (RTC) Real-time Conversational AI agent 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 | Submit scenario-based material selection task | Selects appropriate material segments based on input materials such as videos, images, and voiceovers, and returns the selection results. Supports two scenarios: intelligent matching and highlight mashup. |
| SubmitSceneBatchEditingJob | SubmitSceneBatchEditingJob | Submits a batch job to render multiple videos by providing a list of editing project IDs. |
| SubmitSceneTimelineOrganizationJob | Submit a scenario-based timeline orchestration task | Organizes materials such as videos, images, background music, and voiceovers into a complete timeline based on material selection results and creates an editing project for preview. This operation supports two scenarios: intelligent matching and high-energy 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 | Retrieve custom template information | Retrieves custom template information for media processing. |
| GetSource | GetSource | Queries a source. |
| ListAlerts | Retrieve channel assembly alert information | Retrieves alert information. |
| SubmitDynamicChartJob | Submit a dynamic chart task | Generates videos of line charts, pie charts, and bar charts based on Excel data, and supports modifying line colors, fonts, and other settings. |
| CreatePipeline | Create a pipeline | Creates a media processing pipeline to automate and batch process media files. |
| DeletePipeline | DeletePipeline | Deletes an ApsaraVideo Media Processing (MPS) queue. |
| GetPipeline | GetPipeline | Queries the information about an ApsaraVideo Media Processing (MPS) queue. |
| ListPipelines | Retrieve pipeline list | Retrieves the list of pipelines for the current user. |
| UpdatePipeline | UpdatePipeline | Updates the information about an ApsaraVideo Media Processing (MPS) queue. |
| AddTemplate | Create a template | Creates a template for intelligent media production, which supports the video clip feature based on standard 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 | Retrieve template information | Retrieves the information about a template based on the template ID. Advanced templates require a longer parsing time. When the template type is advanced, it can be used once the Status is Available. |
| 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 | List templates that meet specified conditions | Lists templates that meet specified conditions. You can query templates by status, creation source, and other information. |
| 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 | Update a template | Modifies a cloud editing template, including the template title and configuration. |
| AddCategory | Create a category | Creates a media asset category. |
| DeleteCategory | Delete a category | Deletes a media asset category. |
Is this page helpful?