All Products
Search
Document Center

Intelligent Media Services:List of operations by function

Last Updated:Dec 20, 2024
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 Upload

APITitleDescription
CreateUploadMediaCreateUploadMediaObtains the upload URL and credential of a media asset and creates information about the media asset.
CreateUploadStreamCreateUploadStreamObtains the upload URL and credential of a media stream.
RefreshUploadMediaRefreshUploadMediaObtain a new upload credential for a media asset after its upload credential expires.
RegisterMediaStreamRegisterMediaStreamRegisters a media stream.
GetUrlUploadInfosGetUrlUploadInfosQueries the information about URL-based upload jobs.
UploadMediaByURLUploadMediaByURLUploads an audio or video file based on the URL of the source file. You can upload multiple media files at a time.
UploadStreamByURLUploadStreamByURLUploads a media stream file based on the URL of the source file.

Media Asset Management

APITitleDescription
Media Asset SearchMedia Asset Search
Search LibrarySearch Library
CreateSearchLibCreateSearchLibCreates a search library to store media assets.
QuerySearchLibQuerySearchLibQueries the information about a search library.
DropSearchLibDropSearchLibDeletes a search library and all media assets in the library.
ListSearchLibListSearchLibQueries the information about search libraries.
Search IndexSearch Index
CreateSearchIndexCreateSearchIndexCreates a search index in a search library. Each search library can contain multiple indexes.
AlterSearchIndexAlterSearchIndexModifies search index information including index status and configurations.
QuerySearchIndexQuerySearchIndexQueries the details of a search index.
DropSearchIndexDropSearchIndexDeletes 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.
InsertMediaToSearchLibInsertMediaToSearchLibAdds a media asset in a search library. Before you call this operation, you must create a search library.
UpdateMediaToSearchLibUpdateMediaToSearchLibUpdates the media asset information in a search library.
DeleteMediaFromSearchLibDeleteMediaFromSearchLibDeletes a specific media asset from a search library.
QueryMediaIndexJobQueryMediaIndexJobQueries the indexing jobs enabled for a media asset.
SearchIndexJobRerunSearchIndexJobRerunRe-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.
SearchMediaSearchMediaQueries information about media assets based on the request parameters.
GetVideoListGetVideoListQueries information about video and audio files.
SearchMediaByFaceSearchMediaByFaceQueries the information about media assets that are related to a specific face.
SearchMediaClipByFaceSearchMediaClipByFaceQueries the information about media asset clips that are related to a specific face based on the response to the SearchMediaByFace operation.
SearchMediaByAILabelSearchMediaByAILabelQueries media assets based on character names, subtitles, or AI categories.
SearchMediaByMultimodalSearchMediaByMultimodalQueries media assets by using the large visual model. You can use natural language for the query.
Media LibraryMedia Library
RegisterMediaInfoRegisterMediaInfoRegisters 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.
GetMediaInfoGetMediaInfoQueries 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.
UpdateMediaInfoUpdateMediaInfoUpdates 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.
DeleteMediaInfosDeleteMediaInfosDeletes 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.
BatchGetMediaInfosBatchGetMediaInfosQueries the information about multiple media assets at a time based on media asset IDs.
ListMediaBasicInfosListMediaBasicInfosQueries the basic information of all media assets that meet the specified conditions.
ListPublicMediaBasicInfosListPublicMediaBasicInfosQueries a list of media assets in the public media library that meet the specified conditions. A maximum of 100 media assets can be returned.
ListAllPublicMediaTagsListAllPublicMediaTagsQueries a list of tags of media assets in the public media library.
SubmitMediaAiAnalysisJobSubmitMediaAiAnalysisJobSubmits 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 managementclassification management
AddCategoryAddCategoryCreates a category.
GetCategoriesGetCategoriesQueries the information about a category and its subcategories.
UpdateCategoryUpdateCategoryUpdates a category.
DeleteCategoryDeleteCategoryDeletes a media asset category.
Tag ManagementTag Management
AddMediaMarksAddMediaMarksAdds marks for a media asset.
GetMediaMarksGetMediaMarksQueries the information about marks based on mark IDs.
UpdateMediaMarksUpdateMediaMarksModifies the marks of a media asset.
DeleteMediaMarksDeleteMediaMarksDeletes the marks of a media asset.
ListMediaMarksListMediaMarksQueries a list of marks of a media asset.
GetPlayInfoGetPlayInfoQueries the playback URL of a video or audio file based on its ID.
DeletePlayInfoDeletePlayInfoDeletes media streams such as video streams and audio streams.

Media Capital Audit

APITitleDescription
CreateAuditCreateAuditSubmits manual review results for media assets.
SubmitMediaCensorJobSubmitMediaCensorJobSubmits a content moderation job.
QueryMediaCensorJobDetailQueryMediaCensorJobDetailQueries the information about a content moderation job.
QueryMediaCensorJobListQueryMediaCensorJobListQueries a list of content moderation jobs.

Configuration Management

APITitleDescription
Template ManagementTemplate Management
CreateCustomTemplateCreateCustomTemplateCreates a custom template.
GetSystemTemplateGetSystemTemplateQueries the information about a system template.
GetCustomTemplateGetCustomTemplateQueries the information about a custom template.
SetDefaultCustomTemplateSetDefaultCustomTemplateSets a custom template as the default template.
UpdateCustomTemplateUpdateCustomTemplateUpdates a custom template.
DeleteCustomTemplateDeleteCustomTemplateDeletes a custom template.
ListSystemTemplatesListSystemTemplatesQueries a list of system templates.
ListCustomTemplatesListCustomTemplatesQueries a list of custom templates.
Pipeline ManagementPipeline Management
CreatePipelineCreatePipelineCreates an ApsaraVideo Media Processing (MPS) queue.
GetPipelineGetPipelineQueries the information about an ApsaraVideo Media Processing (MPS) queue.
UpdatePipelineUpdatePipelineUpdates the information about an ApsaraVideo Media Processing (MPS) queue.
DeletePipelineDeletePipelineDeletes an ApsaraVideo Media Processing (MPS) queue.
ListPipelinesListPipelinesQueries a list of ApsaraVideo Media Processing (MPS) queues.

Media Processing

APITitleDescription
Transcoding InterfaceTranscoding Interface
SubmitTranscodeJobSubmitTranscodeJobSubmits a transcoding job.
GetTranscodeJobGetTranscodeJobQueries the information about a transcoding job.
ListTranscodeJobsListTranscodeJobsQueries a list of transcoding jobs.
SubmitPackageJobSubmitPackageJobSubmits a packaging job.
GetPackageJobGetPackageJobQueries the information about a packaging job.
ListPackageJobsListPackageJobsQueries a list of packaging jobs.
GenerateKMSDataKeyGenerateKMSDataKeyGenerates a random Key Management Service (KMS) data key used for HTTP Live Streaming (HLS) encryption and transcoding of videos.
DecryptKMSDataKeyDecryptKMSDataKeyDecrypts the ciphertext specified by CiphertextBlob in the Key Management Service (KMS) data key.
Screenshot InterfaceScreenshot Interface
SubmitSnapshotJobSubmitSnapshotJobSubmits a snapshot job.
SubmitDynamicImageJobSubmitDynamicImageJobSubmits an image animation job.
GetSnapshotUrlsGetSnapshotUrlsQueries the accessible URLs of the output images of a snapshot job.
GetSnapshotJobGetSnapshotJobQueries the information about a snapshot job.
GetDynamicImageJobGetDynamicImageJobQueries the information about an image animation job.
ListSnapshotJobsListSnapshotJobsQueries a list of snapshot jobs.
ListDynamicImageJobsListDynamicImageJobsQueries a list of image animation jobs.
Media Information InterfaceMedia Information Interface
SubmitSyncMediaInfoJobSubmitSyncMediaInfoJobSubmits a media file in synchronous mode for media information analysis.
SubmitMediaInfoJobSubmitMediaInfoJobSubmits a media information analysis job in asynchronous mode.
GetMediaInfoJobGetMediaInfoJobQueries the information about a media information analysis job.
ListMediaInfoJobsListMediaInfoJobsQueries a list of media information analysis jobs.

real-time processing

APITitleDescription
Real-time media transcodingReal-time media transcoding
CreateLiveTranscodeTemplateCreateLiveTranscodeTemplateCreates a live stream transcoding template to submit live stream transcoding jobs.
GetLiveTranscodeTemplateGetLiveTranscodeTemplateQueries the information a live stream transcoding template.
UpdateLiveTranscodeTemplateUpdateLiveTranscodeTemplateUpdates the information about a live stream transcoding template.
DeleteLiveTranscodeTemplateDeleteLiveTranscodeTemplateDeletes a live stream transcoding template.
ListLiveTranscodeTemplatesListLiveTranscodeTemplatesQueries a list of live stream transcoding templates.
SubmitLiveTranscodeJobSubmitLiveTranscodeJobSubmits a live stream transcoding job.
SendLiveTranscodeJobCommandSendLiveTranscodeJobCommandSends a command to process a live stream transcoding job.
GetLiveTranscodeJobGetLiveTranscodeJobQueries the information about a live stream transcoding job.
UpdateLiveTranscodeJobUpdateLiveTranscodeJobUpdates the information about a live stream transcoding job.
DeleteLiveTranscodeJobDeleteLiveTranscodeJob
ListLiveTranscodeJobsListLiveTranscodeJobsQueries a list of live stream transcoding jobs.
Real-time media recordingReal-time media recording
CreateLiveRecordTemplateCreateLiveRecordTemplateCreates a live stream recording template to submit live stream recording jobs.
GetLiveRecordTemplateGetLiveRecordTemplateQueries the information about a live stream recording template or a snapshot of the template.
UpdateLiveRecordTemplateUpdateLiveRecordTemplateUpdates the information about a live stream recording template.
DeleteLiveRecordTemplateDeleteLiveRecordTemplateDeletes a live stream recording template without affecting existing jobs.
ListLiveRecordTemplatesListLiveRecordTemplatesQueries a list of live stream recording templates.
SubmitLiveRecordJobSubmitLiveRecordJobSubmits a live stream recording job.
GetLiveRecordJobGetLiveRecordJobQueries the information about a live stream recording job.
DeleteLiveRecordFilesDeleteLiveRecordFilesDeletes 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.
ListLiveRecordJobsListLiveRecordJobsQueries a list of live stream recording jobs by page.
ListLiveRecordFilesListLiveRecordFilesQueries all recording index files in the specified period of time.
Real-time media screenshotsReal-time media screenshots
CreateLiveSnapshotTemplateCreateLiveSnapshotTemplateCreate a live stream snapshot template to facilitate the creation of snapshot jobs.
GetLiveSnapshotTemplateGetLiveSnapshotTemplateQueries the information about a live stream snapshot template.
UpdateLiveSnapshotTemplateUpdateLiveSnapshotTemplateUpdates the information about a live stream snapshot template.
DeleteLiveSnapshotTemplateDeleteLiveSnapshotTemplateDeletes a live stream snapshot template.
ListLiveSnapshotTemplatesListLiveSnapshotTemplatesQueries a list of live stream snapshot templates by page.
SubmitLiveSnapshotJobSubmitLiveSnapshotJobSubmits a live stream snapshot job. If the job is submitted during stream ingest, it automatically starts in asynchronous mode. Otherwise, it does not start.
SendLiveSnapshotJobCommandSendLiveSnapshotJobCommandSends a command to process a live stream snapshot job.
GetLiveSnapshotJobGetLiveSnapshotJobQueries the information a live stream snapshot job.
DeleteLiveSnapshotFilesDeleteLiveSnapshotFilesDeletes live stream snapshot files. You can choose to delete only the snapshot files or delete both the snapshot files and the original Object Storage Service (OSS) files.
ListLiveSnapshotJobsListLiveSnapshotJobsQueries a list of live stream snapshot jobs by page.
ListLiveSnapshotFilesListLiveSnapshotFilesQueries a list of live stream snapshot files by page.

Production

APITitleDescription
Cloud Clip Project ManagementCloud Clip Project Management
CreateEditingProjectCreateEditingProjectCreates an online editing project. You can specify configurations such as the title, description, timeline, and thumbnail for the project.
GetEditingProjectGetEditingProjectQueries the information about an online editing project.
UpdateEditingProjectUpdateEditingProjectModifies 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.
DeleteEditingProjectsDeleteEditingProjectsDeletes one or more online editing project.
ListEditingProjectsListEditingProjectsQueries a list of projects that meet the specified conditions. You can filter projects by project creation time.
AddEditingProjectMaterialsAddEditingProjectMaterialsAdds one or more materials to an online editing project.
GetEditingProjectMaterialsGetEditingProjectMaterialsQueries all materials associated with an online editing project.
DeleteEditingProjectMaterialsDeleteEditingProjectMaterialsDeletes one or more materials from an online editing project.
GetLiveEditingIndexFileGetLiveEditingIndexFileQueries the index file of a live stream. The index file is used to preview an editing project in the console.
Clip ProductionClip Production
SubmitMediaProducingJobSubmitMediaProducingJobSubmits 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.
GetMediaProducingJobGetMediaProducingJobQueries 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.
SubmitLiveEditingJobSubmitLiveEditingJobSubmits 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.
GetLiveEditingJobGetLiveEditingJobQueries 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.
SubmitBatchMediaProducingJobSubmitBatchMediaProducingJobSubmits a quick video production job that intelligently edits multiple video, audio, and image assets to generate multiple videos at a time.
GetBatchMediaProducingJobGetBatchMediaProducingJobQueries 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.
SubmitSportsHighlightsJobSubmitSportsHighlightsJobSubmits a sports highlights job to generate a highlights video of an event based on event materials that contain commentary.
ListMediaProducingJobsListMediaProducingJobsQueries 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.
ListBatchMediaProducingJobsListBatchMediaProducingJobsQueries a list of quick video production jobs based on conditions such as the job type and state.
Formwork FactoryFormwork Factory
AddTemplateAddTemplateCreates a template.
GetTemplateGetTemplateQueries 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.
UpdateTemplateUpdateTemplateModifies an online editing template. You can modify the template title and template configurations.
DeleteTemplateDeleteTemplateDeletes templates.
ListTemplatesListTemplatesQueries a list of templates that meet the specified conditions. You can query templates based on information such as the template status and creation source.
GetTemplateMaterialsGetTemplateMaterialsQueries 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.
GetTemplateParamsGetTemplateParamsQueries the parameters for replaceable materials in a template, including the parameter names, default values, and material thumbnails. Only advanced templates are supported.
Smart TasksSmart Tasks
Digital People TrainingDigital People Training
CreateAvatarTrainingJobCreateAvatarTrainingJobCreates a digital human training job. You can configure the basic information of the digital human and the materials required for the training. Note: This operation is used to initialize the training job. It does not submit the training job. To submit the training job, call the SubmitAvatarTrainingJob operation.
UpdateAvatarTrainingJobUpdateAvatarTrainingJobModifies 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.
SubmitAvatarTrainingJobSubmitAvatarTrainingJobSubmits 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.
GetAvatarTrainingJobGetAvatarTrainingJobQueries the information about a digital human training job.
DeleteAvatarTrainingJobDeleteAvatarTrainingJobDeletes a digital human training job that is in the Init or Fail state.
ListAvatarTrainingJobsListAvatarTrainingJobsQueries a list of digital human training jobs.
GetAvatarGetAvatarQueries the information about a trained digital human.
ListAvatarsListAvatarsQueries a list of trained digital humans.
vocal cloningvocal cloning
CreateCustomizedVoiceJobCreateCustomizedVoiceJobCreates a human voice cloning job. You can configure the basic information of the human voice cloning job.
GetDemonstrationForCustomizedVoiceJobGetDemonstrationForCustomizedVoiceJobQueries the text to be read and sample audio for training a personalized human voice.
DetectAudioForCustomizedVoiceJobDetectAudioForCustomizedVoiceJobChecks 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.
SubmitCustomizedVoiceJobSubmitCustomizedVoiceJobSubmits a human voice cloning job. The value of VoiceId must be the one used during audio check. The system uses this ID to find the cached audio file for training. 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.
SubmitStandardCustomizedVoiceJobSubmitStandardCustomizedVoiceJobSubmits 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.
GetCustomizedVoiceJobGetCustomizedVoiceJobQueries the information about a human voice cloning job.
DeleteCustomizedVoiceJobDeleteCustomizedVoiceJobDeletes a human voice cloning job that is not in the Training or Success state.
ListCustomizedVoiceJobsListCustomizedVoiceJobsQueries a list of human voice cloning jobs.
GetCustomizedVoiceGetCustomizedVoiceQueries the information about a personalized human voice.
UpdateCustomizedVoiceUpdateCustomizedVoiceUpdates a personalized human voice. Only the media asset ID of the sample audio file can be modified.
ListCustomizedVoicesListCustomizedVoicesQueries a list of personalized human voices.
SubmitASRJobSubmitASRJobSubmits an automatic speech recognition (ASR) job to extract the start and end time and the corresponding text information of a speech in a video.
SubmitAudioProduceJobSubmitAudioProduceJobSubmits an audio production job that converts text into an audio file.
SubmitTextGenerateJobSubmitTextGenerateJobSubmits 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.
SubmitVideoTranslationJobSubmitVideoTranslationJobSubmits a video translation job. You can call this operation to translate subtitles in a video and audio to a specific language. Lip-sync adaptation will be supported in the future.
GetSmartHandleJobGetSmartHandleJobQueries 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.
DeleteSmartJobDeleteSmartJobDeletes intelligent jobs based on job IDs.
ListSmartJobsListSmartJobsQueries a list of intelligent jobs based on specified parameters.
ListSmartSysAvatarModelsListSmartSysAvatarModelsQueries a list of system digital humans. This operation supports paged queries.
ListSmartVoiceGroupsListSmartVoiceGroupsQueries a list of speaker groups, including the name, gender, and sample audio of each speaker. The list is grouped by scenario.

Media AI

APITitleDescription
Smart LabelSmart Label
SubmitSmarttagJobSubmitSmarttagJobSubmits a smart tagging job.
QuerySmarttagJobQuerySmarttagJobQueries the information about a smart tagging job.
Intelligent productionIntelligent production
SubmitIProductionJobSubmitIProductionJobSubmits an intelligent production job.
QueryIProductionJobQueryIProductionJobQueries the status and result of an intelligent production job.
Media DNAMedia DNA
CreateDNADBCreateDNADBCreates media fingerprint libraries.
DeleteDNADBDeleteDNADBDeletes a media fingerprint library.
ListDNADBListDNADBQueries a list of media fingerprint libraries.
SubmitDNAJobSubmitDNAJobSubmits a media fingerprint analysis job.
CancelDNAJobCancelDNAJobCancels a media fingerprint analysis job.
DeleteDNAFilesDeleteDNAFilesDeletes files from a media fingerprint library.
ListDNAFilesListDNAFilesQueries a list of files in a media fingerprint library.
QueryDNAJobListQueryDNAJobListQueries a list of media fingerprint analysis jobs.

Dosage statistics

APITitleDescription
DescribeMeterImsMediaConvertUHDUsageDescribeMeterImsMediaConvertUHDUsageQueries 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.
DescribeMeterImsMediaConvertUsageDescribeMeterImsMediaConvertUsageQueries 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.
DescribeMeterImsEditUsageDescribeMeterImsEditUsageQueries 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.
DescribeMeterImsSummaryDescribeMeterImsSummaryQueries the usage statistics of Intelligent Media Services (IMS). The maximum query range is 31 days. You can query data within the last 90 days.
DescribeMeterImsMpsAiUsageDescribeMeterImsMpsAiUsageQueries 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

APITitleDescription
SetEventCallbackSetEventCallbackConfigures a callback method for one or more events.
GetEventCallbackGetEventCallbackQueries event callback configurations.

Workflow

APITitleDescription
StartWorkflowStartWorkflowSubmits a workflow task. You can submit a workflow task to implement automated media processing based on a workflow template.
GetWorkflowTaskGetWorkflowTaskQueries 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.

Other

APITitleDescription
SearchEditingProjectSearchEditingProjectQueries online editing projects by creation time and status.