This product(
ICE/2020-11-09) OpenAPI adopts RPC Signature style. See signature details in Description of the signature mechanism. We have packaged SDKs for common programming languages for developers. Developers can directly call the OpenAPI of this product by downloading the SDK without paying attention to the technical details. If the existing SDK cannot meet the usage requirements, you can connect through the signature mechanism. It will take about 5 working days. Therefore, it is recommended to join our DingTalk service group (78410016550) and sign under the guidance of experts. Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (SDK, CLI, etc.). For details see getAccessKey.
Media asset upload
| API | Title | Description |
|---|---|---|
| CreateUploadMedia | CreateUploadMedia | Obtains the upload URL and credential of a media asset and creates information about the media asset. |
| 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 | RegisterMediaStream | Registers a media stream. |
| GetUrlUploadInfos | GetUrlUploadInfos | Queries the information about URL-based upload jobs. |
| UploadMediaByURL | UploadMediaByURL | Uploads an audio or video file based on the URL of the source file. You can upload multiple media files at a time. |
| 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 | |
| Stream media asset | Stream media asset | |
| 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 | Search library | |
| CreateSearchLib | CreateSearchLib | Creates a search library to store media assets. |
| QuerySearchLib | QuerySearchLib | Queries the information about a search library. |
| DropSearchLib | DropSearchLib | Deletes a search library and all media assets in the library. |
| ListSearchLib | ListSearchLib | Queries the information about search libraries. |
| Search index | Search index | |
| CreateSearchIndex | CreateSearchIndex | Creates a search index in a search library. Each search library can contain multiple indexes. |
| AlterSearchIndex | AlterSearchIndex | Modifies search index information including index status and configurations. |
| QuerySearchIndex | QuerySearchIndex | Queries the details of 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 tasks | Search index tasks | |
| QueryMediaIndexJob | QueryMediaIndexJob | Queries the indexing jobs enabled for a media asset. |
| SearchIndexJobRerun | SearchIndexJobRerun | Re-analyzes the search index jobs of media assets. You can re-run the search index jobs of up to 20 media assets in each request. |
| Media asset operation | Media asset operation | |
| InsertMediaToSearchLib | InsertMediaToSearchLib | Adds a media asset in a search library. Before you call this operation, you must create a search library. |
| UpdateMediaToSearchLib | UpdateMediaToSearchLib | Updates the media asset information in a search library. |
| DeleteMediaFromSearchLib | DeleteMediaFromSearchLib | Deletes a specific media asset from a search library. |
| Search | Search | |
| Basic search | Basic search | |
| SearchMedia | SearchMedia | Queries information about media assets based on the request parameters. |
| GetVideoList | GetVideoList | Queries information about video and audio files. |
| Face search | Face search | |
| SearchMediaByFace | SearchMediaByFace | Queries the information about media assets that are related to a specific face. |
| SearchMediaClipByFace | SearchMediaClipByFace | Queries the information about media asset clips that are related to a specific face based on the response to the SearchMediaByFace operation. |
| Label search | Label search | |
| SearchMediaByAILabel | SearchMediaByAILabel | Queries media assets based on character names, subtitles, or AI categories. |
| LLM search | LLM search | |
| SearchMediaByMultimodal | SearchMediaByMultimodal | Queries media assets by using the large visual model. You can use natural language for the query. |
| SearchMediaByHybrid | SearchMediaByHybrid | Performs a hybrid search for media assets. This API combines multiple recall strategies, including tag-based text search and large language model (LLM) search. You can locate media assets using natural language descriptions. |
| Media library | Media library | |
| 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. |
| GetMediaInfo | GetMediaInfo | Queries 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. |
| 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 | BatchGetMediaInfos | Queries the information about multiple media assets at a time based on media asset IDs. |
| ListMediaBasicInfos | ListMediaBasicInfos | Queries the basic information of all media assets that meet the specified conditions. |
| 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 | SubmitMediaAiAnalysisJob | Submits a structural analysis job for a media asset. For example, you can submit a job to analyze the speaker, translate the video, and obtain the paragraph summary. |
| Classification | Classification | |
| AddCategory | AddCategory | Creates a category. |
| GetCategories | GetCategories | Queries the information about a category and its subcategories. |
| UpdateCategory | UpdateCategory | Updates a category. |
| DeleteCategory | DeleteCategory | Deletes 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 | UpdateMediaMarks | Modifies the marks of a media asset. |
| DeleteMediaMarks | DeleteMediaMarks | Deletes the marks of a media asset. |
| ListMediaMarks | ListMediaMarks | Queries a list of marks of a media asset. |
| GetPlayInfo | GetPlayInfo | Queries the playback URL of a video or audio file by its ID. You can use the playback URL to play the audio or video in ApsaraVideo Player SDK (for URL-based playback) or a third-party player. |
| DeletePlayInfo | DeletePlayInfo | Deletes media streams such as video streams and audio streams. |
Media review
| API | Title | Description |
|---|---|---|
| CreateAudit | CreateAudit | Submits manual review results for media assets. |
| SubmitMediaCensorJob | SubmitMediaCensorJob | Submits a content moderation job. |
| QueryMediaCensorJobDetail | QueryMediaCensorJobDetail | Queries the information about a content moderation job. |
| QueryMediaCensorJobList | QueryMediaCensorJobList | Queries a list of content moderation jobs. |
Configuration management
| API | Title | Description |
|---|---|---|
| Templates | Templates | |
| CreateCustomTemplate | CreateCustomTemplate | Creates a custom media processing template. |
| GetSystemTemplate | GetSystemTemplate | Queries the information about a system template. |
| GetCustomTemplate | GetCustomTemplate | Queries the information about a custom template. |
| SetDefaultCustomTemplate | SetDefaultCustomTemplate | Sets a custom template as the default template. |
| UpdateCustomTemplate | UpdateCustomTemplate | Updates a custom template. |
| DeleteCustomTemplate | DeleteCustomTemplate | Deletes a custom template. |
| ListSystemTemplates | ListSystemTemplates | Queries a list of system templates. |
| ListCustomTemplates | ListCustomTemplates | Queries a list of custom templates. |
| Pipelines | Pipelines | |
| CreatePipeline | CreatePipeline | Creates an ApsaraVideo Media Processing (MPS) queue. |
| GetPipeline | GetPipeline | Queries the information about an ApsaraVideo Media Processing (MPS) queue. |
| UpdatePipeline | UpdatePipeline | Updates the information about an ApsaraVideo Media Processing (MPS) queue. |
| DeletePipeline | DeletePipeline | Deletes an ApsaraVideo Media Processing (MPS) queue. |
| ListPipelines | ListPipelines | Queries a list of ApsaraVideo Media Processing (MPS) queues. |
Media processing
| API | Title | Description |
|---|---|---|
| Snapshot | Snapshot | |
| SubmitSnapshotJob | SubmitSnapshotJob | Submits a snapshot job. |
| SubmitDynamicImageJob | SubmitDynamicImageJob | Submits an image animation job. |
| 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 | Media information | |
| SubmitSyncMediaInfoJob | SubmitSyncMediaInfoJob | Submits a media file in synchronous mode for media information analysis. |
| SubmitMediaInfoJob | SubmitMediaInfoJob | Submits a media information analysis job in asynchronous mode. |
| GetMediaInfoJob | GetMediaInfoJob | Queries the information about a media information analysis job. |
| ListMediaInfoJobs | ListMediaInfoJobs | Queries a list of media information analysis jobs. |
Video production
| API | Title | Description |
|---|---|---|
| Project management | Project management | |
| CreateEditingProject | CreateEditingProject | Creates an online editing project. You can specify configurations such as the title, description, timeline, and thumbnail for the project. |
| GetEditingProject | GetEditingProject | Queries the information about an online editing project. |
| UpdateEditingProject | UpdateEditingProject | Modifies an online editing project. You can call this operation to modify the configurations such as the title, timeline, and thumbnail of an online editing 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 | AddEditingProjectMaterials | Adds one or more materials to an online editing project. |
| GetEditingProjectMaterials | GetEditingProjectMaterials | Queries all materials associated with an online editing project. |
| DeleteEditingProjectMaterials | DeleteEditingProjectMaterials | 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 | GetProjectExportJob | Queries the information of a project export task. |
| Video generation and editing | Video generation and editing | |
| SubmitMediaProducingJob | SubmitMediaProducingJob | Submits a media editing and production job. If you need to perform any form of post-production such as editing and production on video or audio materials, you can call this operation to automate the process. |
| GetMediaProducingJob | GetMediaProducingJob | Queries the information about a media editing and production job. The requested information includes the state, timeline, template, and data of the job. You can call this operation to query only media editing and production jobs created within the past year. |
| SubmitLiveEditingJob | SubmitLiveEditingJob | Submits a live editing job to merge one or more live stream clips into one video. After a live editing job is submitted, the job is queued in the background for asynchronous processing. You can call the GeLiveEditingJob operation to query the state of the job based on the job ID. You can also call the GetMediaInfo operation to query the information about the generated media asset based on the media asset ID. |
| 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. You can call this operation to query only live editing jobs created within the past year. |
| SubmitBatchMediaProducingJob | SubmitBatchMediaProducingJob | Submits a quick video production job that intelligently edits multiple video, audio, and image assets to generate multiple videos at a time. |
| GetBatchMediaProducingJob | GetBatchMediaProducingJob | Queries the information about a quick video production job, including the input parameters, job state, and the IDs and URLs of the output media assets. You can call this operation to query only quick video production jobs created within the past year. |
| SubmitSportsHighlightsJob | SubmitSportsHighlightsJob | Submits a sports highlights job to generate a highlights video of an event based on event materials that contain commentary. |
| SubmitScreenMediaHighlightsJob | SubmitScreenMediaHighlightsJob | Submits a task to automatically recognize the highlight segments in the video input and compile them into a dramatic and engaging clip. |
| 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. |
| Templates | Templates | |
| AddTemplate | AddTemplate | Creates a template. |
| GetTemplate | GetTemplate | Queries the information about a template based on the template ID. You can call this operation to query the information about an advanced template if the template is in the Available state. |
| UpdateTemplate | UpdateTemplate | Modifies an online editing template. You can modify the template title and template configurations. |
| DeleteTemplate | DeleteTemplate | Deletes 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. |
| 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 | GetTemplateParams | Queries the parameters for replaceable materials in a template, including the parameter names, default values, and material thumbnails. Only advanced templates are supported. |
| Smart tasks | Smart tasks | |
| Hotwords | Hotwords | |
| 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. |
| Avatar training | Avatar training | |
| CreateAvatarTrainingJob | CreateAvatarTrainingJob | Creates an avatar training job. You can configure the basic information of the avatar and the materials required for the training. |
| 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 | Submits a digital human training job. You can call this operation to submit a job the first time or submit a job again with updated parameters if the training failed. |
| GetAvatarTrainingJob | GetAvatarTrainingJob | Queries the information about a digital human training job. |
| DeleteAvatarTrainingJob | DeleteAvatarTrainingJob | Deletes a digital human training job that is in the Init or Fail state. |
| 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 clone | Voice clone | |
| CreateCustomizedVoiceJob | CreateCustomizedVoiceJob | Creates a human voice cloning job. You can configure the basic information of the human voice cloning job. |
| 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 | SubmitCustomizedVoiceJob | Submits a basic voice cloning job. |
| 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. |
| GetCustomizedVoiceJob | GetCustomizedVoiceJob | Queries the information about a human voice cloning job. |
| DeleteCustomizedVoiceJob | DeleteCustomizedVoiceJob | Deletes a human voice cloning job that is not in the Training or Success 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 | SubmitASRJob | Submits an automatic speech recognition (ASR) job to extract the start and end time and the corresponding text information of a speech in a video. |
| SubmitAvatarVideoJob | SubmitAvatarVideoJob | Submits a task to render a video of an avatar speaking the content of the specified text or a human voice audio file. |
| SubmitAudioProduceJob | SubmitAudioProduceJob | Converts the provided text content into a high-quality audio file. |
| SubmitTextGenerateJob | SubmitTextGenerateJob | Submits a text generation job to generate marketing copies based on keywords and the requirements for the word count and number of output copies. The word count of the output copies may differ from the specified word count. After the job is submitted, you can call the GetSmartHandleJob operation to obtain the job state and result based on the job ID. |
| SubmitVideoTranslationJob | SubmitVideoTranslationJob | Submits a video translation job. You can call this operation to translate video subtitles and speech to a specific language, and synchronize the speakers' lip movements with the translated audio. |
| SubmitHighlightExtractionJob | SubmitHighlightExtractionJob | Submits a highlight extraction task. |
| SubmitSegmentationJob | SubmitSegmentationJob | Splits a long video into multiple video clips and outputs as video files or media assets. |
| GetSmartHandleJob | GetSmartHandleJob | Queries the information about an intelligent job and the execution results of the job based the job ID. You can call this operation to query only intelligent jobs created within the past year. |
| DeleteSmartJob | DeleteSmartJob | Deletes intelligent jobs based on job IDs. |
| ListSmartJobs | ListSmartJobs | Queries a list of intelligent jobs based on specified parameters. |
| ListSmartSysAvatarModels | ListSmartSysAvatarModels | Queries a list of system digital humans. This operation supports paged queries. |
| ListSmartVoiceGroups | ListSmartVoiceGroups | Queries a list of speaker groups, including the name, gender, and sample audio of each speaker. The list is grouped by scenario. |
Real-time conversational AI
| API | Title | Description |
|---|---|---|
| Agent management | Agent management | |
| StartAIAgentInstance | StartAIAgentInstance | Starts an AI agent that is configured in the Intelligent Media Services (IMS) console. |
| StopAIAgentInstance | StopAIAgentInstance | Stops an AI agent instance. |
| UpdateAIAgentInstance | UpdateAIAgentInstance | Updates the configurations of an AI agent. |
| DescribeAIAgentInstance | DescribeAIAgentInstance | Queries the information about an AI agent. |
| ListAIAgentInstance | ListAIAgentInstance | Queries a list of AI agents. |
| SendAIAgentSpeech | SendAIAgentSpeech | Instructs an AI agent to immediately broadcast a text message and supports interruption settings. |
| TakeoverAIAgentCall | TakeoverAIAgentCall | Hands off a conversation to a human agent. |
| SendAIAgentDataChannelMessage | SendAIAgentDataChannelMessage | Sends a DataChannel message to an AI agent. |
| SendAIAgentText | SendAIAgentText | Sends a message as input to the large language model (LLM). |
| AICallKit integration | AICallKit integration | |
| GenerateMessageChatToken | GenerateMessageChatToken | Generates the token required for interactive messaging. |
| GenerateAIAgentCall | GenerateAIAgentCall | Creates an AI agent. This operation returns the channel in which the AI agent resides, the username of the AI agent in the channel, and the token that you can use to join the channel. |
| ListAIAgentDialogues | ListAIAgentDialogues | Lists the dialog records of an AI agent. |
| DeleteAIAgentDialogue | DeleteAIAgentDialogue | Deletes dialog records of an AI agent. |
| SendMessageChatText | SendMessageChatText | Sends a message to the client. |
| Voiceprints | Voiceprints | |
| SetAIAgentVoiceprint | SetAIAgentVoiceprint | Registers a voiceprint. |
| ClearAIAgentVoiceprint | ClearAIAgentVoiceprint | Deletes a voiceprint based on its ID. |
| ListAIAgentVoiceprints | ListAIAgentVoiceprints | Lists the registered voiceprints. |
| Offline task | Offline task | |
| 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 | |
| GetAiRtcLicenseInfoList | GetAiRtcLicenseInfoList | Retrieves a list of license batches for Real-time Conversational AI based on specified filter criteria. |
| 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 |
|---|---|---|
| Smart tagging | Smart tagging | |
| Smart tagging task | Smart tagging task | |
| SubmitVideoCognitionJob | SubmitVideoCognitionJob | Submits a video for AI analysis and processing. |
| QueryVideoCognitionJob | QueryVideoCognitionJob | Retrieves the results of an AI analysis and processing task. |
| QuerySmarttagJob | QuerySmarttagJob | Queries the information about a smart tagging job. |
| SubmitSmarttagJob | SubmitSmarttagJob | Submits a smart tagging job. |
| Recognition entity | Recognition entity | |
| 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 | ListRecognitionSamples | Retrieves all samples of a custom entity. Pagination is supported. |
| DeleteRecognitionSample | DeleteRecognitionSample | Deletes a sample for a custom entity. |
| ListRecognitionEntities | ListRecognitionEntities | Retrieves all entities in a specified recognition library. Pagination is supported. |
| ListRecognitionLibs | ListRecognitionLibs | Retrieves all custom recognition libraries. Pagination is supported. |
| 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 | SubmitIProductionJob | Submits an intelligent production job. |
| QueryIProductionJob | QueryIProductionJob | Queries the status and result of an intelligent production job. |
| Media fingerprinting | Media fingerprinting | |
| CreateDNADB | CreateDNADB | Creates media fingerprint libraries. |
| DeleteDNADB | DeleteDNADB | Deletes a media fingerprint library. |
| ListDNADB | ListDNADB | Queries a list of media fingerprint libraries. |
| SubmitDNAJob | SubmitDNAJob | Submits a media fingerprint analysis job. |
| CancelDNAJob | CancelDNAJob | Cancels a media fingerprint analysis job. |
| DeleteDNAFiles | DeleteDNAFiles | Deletes files from a media fingerprint library. |
| ListDNAFiles | ListDNAFiles | Queries a list of files in a media fingerprint library. |
| QueryDNAJobList | QueryDNAJobList | Queries a list of media fingerprint analysis jobs. |
| Digital watermarking | Digital watermarking | |
| SubmitCopyrightJob | SubmitCopyrightJob | Submits a job for adding a copyright watermark to a video. |
| QueryCopyrightJobList | QueryCopyrightJobList | Queries copyright watermarking jobs. |
| SubmitCopyrightExtractJob | SubmitCopyrightExtractJob | Submits a job that extracts a copyright watermark. |
| QueryCopyrightExtractJob | QueryCopyrightExtractJob | Queries a job for extracting a copyright watermark. |
| SubmitTraceAbJob | SubmitTraceAbJob | Submits an A/B watermarking job. |
| QueryTraceAbJobList | QueryTraceAbJobList | Queries A/B watermarking jobs. |
| SubmitTraceM3u8Job | SubmitTraceM3u8Job | Submits a job that generates an M3U8 file containing specific trace watermark information. |
| QueryTraceM3u8JobList | QueryTraceM3u8JobList | Queries jobs for generating M3U8 files containing specific trace watermark information. |
| SubmitTraceExtractJob | SubmitTraceExtractJob | Submits a job to extract the trace watermark. |
| QueryTraceExtractJob | QueryTraceExtractJob | Queries a job for extracting a trace watermark. |
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 | StartWorkflow | Submits a workflow task. You can submit a workflow task to implement automated media processing 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. |
MediaService
| API | Title | Description |
|---|---|---|
| MediaLive | MediaLive | |
| CreateMediaLiveInputSecurityGroup | CreateMediaLiveInputSecurityGroup | Creates a security group in MediaLive. |
| UpdateMediaLiveInputSecurityGroup | UpdateMediaLiveInputSecurityGroup | Modifies a security group created in MediaLive. |
| GetMediaLiveInputSecurityGroup | GetMediaLiveInputSecurityGroup | Queries the details of a security group in MediaLive. |
| ListMediaLiveInputSecurityGroups | ListMediaLiveInputSecurityGroups | Queries the security groups in MediaLive. |
| DeleteMediaLiveInputSecurityGroup | DeleteMediaLiveInputSecurityGroup | Deletes a security group in MediaLive. |
| CreateMediaLiveInput | CreateMediaLiveInput | Creates a MediaLive input. |
| UpdateMediaLiveInput | UpdateMediaLiveInput | Modifies an input of MediaLive. |
| GetMediaLiveInput | GetMediaLiveInput | Queries the details of a MediaLive input. |
| ListMediaLiveInputs | ListMediaLiveInputs | Queries MediaLive 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. |
| MediaConvert | MediaConvert | |
| SubmitMediaConvertJob | SubmitMediaConvertJob | Submits a transcoding task. |
| GetMediaConvertJob | GetMediaConvertJob | Obtains the details of a transcoding task. |
| ListMediaConvertJobs | ListMediaConvertJobs | Retrieves MediaConvert tasks. |
| MediaConnect | MediaConnect | |
| 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 | GetMediaConnectFlowOutput | Obtains information about an output of a MediaConnect flow. |
| DeleteMediaConnectFlowOutput | DeleteMediaConnectFlowOutput | Deletes an output of a MediaConnect flow. |
| AddMediaConnectFlowOutput | AddMediaConnectFlowOutput | Creates an output for a MediaConnect flow. |
| DeleteMediaConnectFlowInput | DeleteMediaConnectFlowInput | Deletes the source of a MediaConnect flow. |
| UpdateMediaConnectFlowInput | UpdateMediaConnectFlowInput | Modifies the source of a MediaConnect flow. |
| GetMediaConnectFlowInput | GetMediaConnectFlowInput | Obtains information about the source of a MediaConnect flow. |
| AddMediaConnectFlowInput | AddMediaConnectFlowInput | Creates a source for a MediaConnect flow. |
| DeleteMediaConnectFlow | DeleteMediaConnectFlow | Deletes a MediaConnect flow. |
| UpdateMediaConnectFlowStatus | UpdateMediaConnectFlowStatus | Modifies the state of a MediaConnect flow. |
| GetMediaConnectFlow | GetMediaConnectFlow | Obtains information about a specific MediaConnect flow. |
| CreateMediaConnectFlow | CreateMediaConnectFlow | Creates a MediaConnect flow. |
| MediaWeaver | MediaWeaver | |
| 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. |
| DeleteChannel | DeleteChannel | Deletes a channel. |
| UpdateSource | UpdateSource | Modifies a source. |
| StartChannel | StartChannel | Starts a channel. |
| DeleteProgram | DeleteProgram | Deletes a program from a channel. |
| DeleteSource | DeleteSource | Deletes a source from MediaWeaver. |
| StopChannel | StopChannel | Stops a MediaWeaver channel. |
| ListChannels | ListChannels | Lists MediaWeaver channels. |
| ListPrograms | ListPrograms | Lists programs. |
| GetSource | GetSource | Queries a source. |
| CreateChannel | CreateChannel | Creates a channel in MediaWeaver. |
| ListSchedules | ListSchedules | Lists the program schedule of a MediaWeaver channel. |
| ListSources | ListSources | Lists sources in MediaWeaver. |
| ListAlerts | ListAlerts | Lists alerts received in MediaWeaver. |
| GetChannel | GetChannel | Queries 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. |
| CreateSource | CreateSource | Creates a source in MediaWeaver. |
| UpdateChannel | UpdateChannel | Modifies a MediaWeaver channel. |
| MediaPackage | MediaPackage | |
| VodPackage | VodPackage | |
| 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. |
| LivePackage | LivePackage | |
| 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 | Queries the details of 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 | CreateLivePackageChannel | Creates a live package channel. |
| UpdateLivePackageChannel | UpdateLivePackageChannel | Updates the configuration of a live package channel, including the protocol, segment duration, and number of segments. |
| UpdateLivePackageChannelCredentials | UpdateLivePackageChannelCredentials | Updates the credentials of ingest endpoints associated with a live package channel. |
| GetLivePackageChannel | GetLivePackageChannel | Queries the details of 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 | CreateLivePackageOriginEndpoint | Creates an origin endpoint for a live package channel to deliver live streams in HLS format. |
| UpdateLivePackageOriginEndpoint | UpdateLivePackageOriginEndpoint | Updates the origin endpoint settings including the protocol, time shifting, and access control settings. |
| GetLivePackageOriginEndpoint | GetLivePackageOriginEndpoint | Queries origin endpoints associated with a live package 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. |
Other
| API | Title | Description |
|---|---|---|
| DescribePlayList | DescribePlayList | Retrieves playback records based on the player's TraceId. This API supports pagination. |
| GetStorageList | GetStorageList | Obtains storage configurations. |
| SearchEditingProject | SearchEditingProject | Queries online editing projects by creation time and status. |
| SubmitDynamicChartJob | SubmitDynamicChartJob | Generates animated charts based on Excel datasheets, such as line, pie, and bar charts. You can modify the line color and font. |
| SetNotifyConfig | SetNotifyConfig | Enables or disables event notifications for an AI agent and configures the callback URL and event types. |
| DescribeNotifyConfig | DescribeNotifyConfig | Queries the event callback configurations of an AI agent. |
| CancelIProductionJob | CancelIProductionJob | 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. |