文档

API概览

更新时间:
本产品(智能媒体生产/2020-11-09)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(11370001915),在专家指导下进行签名对接。
在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

媒体上传

API标题API概述
CreateUploadMedia获取媒资上传地址和凭证获取媒资上传地址和凭证,并创建媒资信息。
CreateUploadStream获取媒体流上传地址和凭证获取媒体流上传地址和凭证。
RefreshUploadMedia刷新媒资上传凭证用于媒资文件上传超时后重新获取媒资上传凭证。
RegisterMediaStream注册媒体流注册媒体流。
GetUrlUploadInfos获取URL上传信息调用GetURLUploadInfos获取URL上传信息。
UploadMediaByURLURL拉取上传调用UploadMediaByURL基于源文件URL,拉取音视频媒体文件进行上传,支持批量上传。
UploadStreamByURL媒体流URL拉取上传调用UploadStreamByURL基于源文件URL,拉取媒体流文件进行上传。

媒资管理

API标题API概述
媒资搜索媒资搜索
搜索库搜索库
CreateSearchLib创建搜索库用户新建搜索媒资库。可以用来保存媒资。
QuerySearchLib查询搜索库查询搜索媒资库信息。
DropSearchLib删除搜索库删除搜索媒资库。删除库下所有媒资。
搜索索引搜索索引
CreateSearchIndex创建搜索索引可以在搜索库下新增搜索索引。一个搜索库下可以有多个搜索索引。
AlterSearchIndex修改搜索索引修改搜索索引信息(索引状态或索引配置)。
QuerySearchIndex查询搜索索引查询搜索索引详细信息。
DropSearchIndex删除搜索索引删除索引,删除后对应索引存量数据会被删除,新增媒资也不再支持对应索引分析、存储、搜索。
InsertMediaToSearchLib插入媒资到搜索库插入媒资到搜索库,需要提前建立好搜索库。
UpdateMediaToSearchLib更新媒资到搜索库在搜索库中更新媒资信息。
DeleteMediaFromSearchLib删除媒资从搜索库在搜索库中删除指定媒资。
QueryMediaIndexJob查询媒资索引任务查询媒资对应开启的索引任务。
SearchMedia搜索媒体信息根据用户所提供参数,返回符合条件的媒资信息。
GetVideoList获取媒资信息列表获取视频信息列表。
SearchMediaByFace人脸图片搜媒资人脸图片搜媒资接口(粗搜),输入一张人脸图片,搜索该人物所在媒资的相关信息。
SearchMediaClipByFace人脸图片搜媒资片段人脸图片搜媒资片段接口(精搜),基于粗搜结果返回该人脸所在媒资的相关人物片段信息。
SearchMediaByAILabel智能标签文本搜索可以根据人名、字幕、AI分类进行多模搜索。
SearchMediaByMultimodal大模型搜索大模型搜索。用户可以使用自然语言描述进行搜索。
SearchMediaByHybrid混合搜索媒资混合搜索。用户可以使用自然语言描述进行混合搜索。
媒资库媒资库
RegisterMediaInfo注册内容库资源发起一个注册媒资的任务,赋予新媒资一个IMS的mediaId。接口根据InputURL,异步调用其他媒资信息服务,获取媒资的文件信息。同时用户可以设置一些基本信息的值,如标题、标签、描述等。接口同步返回mediaId,用户可以调用获取媒资内容信息GetMediaInfo的接口,获取具体的媒资信息。当前仅支持InputURL为OSS文件或VOD媒资。
GetMediaInfo获取媒资内容信息根据IMS mediaId或媒资InputURL,获取并返回媒资信息。
UpdateMediaInfo更新媒体信息根据IMS mediaId或媒资InputURL,更新一个媒资的媒资信息。
DeleteMediaInfos删除媒资内容批量删除媒资信息,最多一次删20个。MediaIds不为空时,优先使用MediaIds。如果MediaIds为空,则InputURLs必须非空。
BatchGetMediaInfos批量获取媒体信息批量获取媒资信息,支持传入多个mediaId。
ListMediaBasicInfos列出媒资基础信息根据用户所给参数,返回所有符合条件的媒资的基础信息。
ListPublicMediaBasicInfos列出公共素材库媒资基础信息列出符合条件的公共素材库媒资基础信息,最多筛选出100条。
ListAllPublicMediaTags列出公共素材库所有标签列出公共素材库媒资的所有标签。
分类管理分类管理
AddCategory创建分类调用AddCategory创建媒资分类。
GetCategories获取分类及子分类调用GetCategories获取指定的分类信息,及其子分类(即下一级分类)的列表。
UpdateCategory更新分类调用UpdateCategory更新媒资分类。
DeleteCategory删除分类调用DeleteCategory删除媒资分类。
标记管理标记管理
AddMediaMarks为媒资增加标记信息为媒资增加标记信息。
GetMediaMarks按照点位ID获取媒资标记信息按照点位ID获取媒资标记信息。
UpdateMediaMarks修改媒资标记信息修改媒资标记信息。
DeleteMediaMarks删除媒资的标记信息删除媒资的标记信息。
ListMediaMarks列出媒资的全部标记信息列出媒资的全部标记信息。
GetPlayInfo获取音视频播放地址调用GetPlayInfo通过音视频ID直接获取媒体文件(支持视频和音频)的播放地址。
DeletePlayInfo删除媒体流调用DeletePlayInfo删除媒体流(视频流,音频流)信息。

媒资审核

API标题API概述
CreateAudit人工审核调用CreateAudit针对媒资提交人工审核。
SubmitMediaCensorJob提交媒体审核作业调用SubmitMediaCensorJob提交媒体审核作业。
QueryMediaCensorJobDetail查询媒体审核作业详情调用QueryMediaCensorJobDetail查询媒体审核作业的详细信息。
QueryMediaCensorJobList查询媒体审核作业列表调用QueryMediaCensorJobList查询媒体审核作业列表。

配置管理

API标题API概述
模板管理模板管理
CreateCustomTemplate创建用户自定义模板创建媒体处理用户自定义模板。
GetSystemTemplate获取系统模板信息获取单个系统预置模板信息。
GetCustomTemplate获取自定义模板信息获取媒体处理用户自定义模板信息。
SetDefaultCustomTemplate设置默认自定义模板设置用户自定义点播媒体处理默认模板。
UpdateCustomTemplate修改用户自定义模板信息修改媒体处理用户自定义模板信息。
DeleteCustomTemplate删除自定义模板删除用户自定义模板。
ListSystemTemplates获取系统模板列表获取媒体处理系统预置模板列表。
ListCustomTemplates获取自定义模板列表获取用户自定义点播媒体处理模板列表。
管道管理管道管理
CreatePipeline创建管道创建管道。
GetPipeline获取管道详细信息获取用户管道详细信息。
UpdatePipeline更新管道信息更新用户管道信息。
DeletePipeline删除用户管道删除用户管道信息。
ListPipelines获取管道列表获取用户管道列表。

媒体处理

API标题API概述
转码接口转码接口
SubmitTranscodeJob提交转码任务提交转码任务。
GetTranscodeJob查询转码任务查询单个转码任务详情。
ListTranscodeJobs查询转码任务列表查询转码任务列表。
SubmitPackageJob提交打包任务提交打包任务接口。
GetPackageJob获取单个打包任务信息获取单个打包任务信息。
ListPackageJobs获取打包任务列表获取打包任务列表接口。
GenerateKMSDataKey创建KMS数据密钥生成一个随机的KMS数据密钥,用于对视频进行标准加密转码。
DecryptKMSDataKey解密KMS数据密钥密文解密KMS数据密钥中的CiphertextBlob密文。
截图接口截图接口
SubmitSnapshotJob提交截图任务提交截图任务。
SubmitDynamicImageJob提交动图任务提交动图任务。
GetSnapshotUrls获取截图任务输出URL获取截图任务输出图片的可访问URL。
GetSnapshotJob查询截图任务详细信息查询截图任务详细信息。
GetDynamicImageJob查询动图任务详细信息查询动图任务详细信息。
ListSnapshotJobs获取截图任务列表获取截图任务列表。
ListDynamicImageJobs获取动图任务列表获取动图任务列表。
媒体信息接口媒体信息接口
SubmitSyncMediaInfoJob提交同步媒体信息任务调用SubmitSyncMediaInfoJob以同步模式提交媒体文件进行媒体信息分析。
SubmitMediaInfoJob提交媒体信息异步任务提交媒体信息异步任务。
GetMediaInfoJob媒体信息任务查询查询媒体信息。
ListMediaInfoJobs查询媒体信息任务列表查询媒体信息任务列表。

实时处理

API标题API概述
实时媒体转码实时媒体转码
CreateLiveTranscodeTemplate创建实时媒体转码模版调用CreateLiveTranscodeTemplate创建实时转码模板,便于提交实时转码任务。
GetLiveTranscodeTemplate获取单个实时媒体转码模版调用GetLiveTranscodeTemplate获取单个实时转码模板。
UpdateLiveTranscodeTemplate更新实时媒体转码模版更新实时转码模板。
DeleteLiveTranscodeTemplate删除实时媒体转码模版删除实时转码模板。
ListLiveTranscodeTemplates获取实时媒体转码模版列表调用ListLiveTranscodeTemplates获取实时媒体转码模版列表。
SubmitLiveTranscodeJob提交实时媒体转码任务调用SubmitLiveTranscodeJob提交实时转码任务。
SendLiveTranscodeJobCommand发送实时转码任务指令发送实时转码任务指令。
GetLiveTranscodeJob获取单个实施媒体转码任务调用GetLiveTranscodeJob获取单个实时转码任务。
UpdateLiveTranscodeJob更新实时媒体转码任务调用UpdateLiveTranscodeJob更新实时转码任务信息。
DeleteLiveTranscodeJob删除实时媒体转码任务
ListLiveTranscodeJobs获取实时媒体转码任务列表调用ListLiveTranscodeJobs获取实时媒体转码任务列表。
实时媒体录制实时媒体录制
CreateLiveRecordTemplate创建实时录制模板调用CreateLiveRecordTemplate创建实时录制模板,便于提交实时录制任务。
GetLiveRecordTemplate获取实时录制模板明细调用GetLiveRecordTemplate获取实时录制模板明细或任务模板快照。
UpdateLiveRecordTemplate更新实时录制模板调用UpdateLiveRecordTemplate更新实时录制模板。
DeleteLiveRecordTemplate删除实时录制模板调用DeleteLiveRecordTemplate删除实时录制模板,不影响现有任务。
ListLiveRecordTemplates获取实时录制模板列表调用ListLiveRecordTemplates获取实时录制模板列表。
SubmitLiveRecordJob提交实时录制任务调用SubmitLiveRecordJob提交实时录制任务,对直播流进行录制。
GetLiveRecordJob获取实时录制任务明细调用GetLiveRecordJob获取单个实时录制任务明细。
DeleteLiveRecordFiles删除实时录制文件调用DeleteLiveRecordFiles删除实时录制文件,可选择只删除记录或同时删除原始OSS文件。
ListLiveRecordJobs获取实时录制任务列表调用ListLiveRecordJobs获取实时录制任务列表,可分页获取。
ListLiveRecordFiles查询所有录制索引文件调用ListLiveRecordFiles查询某个时间段内的所有录制索引文件。
实时媒体截图实时媒体截图
CreateLiveSnapshotTemplate创建实时截图模板调用CreateLiveSnapshotTemplate创建实时截图模板,模板便于创建截图任务。
GetLiveSnapshotTemplate获取实时截图模板调用GetLiveSnapshotTemplate获取单个实时截图模板。
UpdateLiveSnapshotTemplate更新实时截图模板更新实时截图模板。
DeleteLiveSnapshotTemplate删除实时截图模板删除实时截图模板。
ListLiveSnapshotTemplates获取实时截图模板列表调用ListLiveSnapshotTemplates获取实时截图模板列表,可分页获取。
SubmitLiveSnapshotJob提交实时截图任务调用SubmitLiveSnapshotJob提交实时截图任务。如果在推流中提交,则会自动异步启动任务,否则为未启动状态。
SendLiveSnapshotJobCommand发送实时截图任务指令发送实时截图任务指令。
GetLiveSnapshotJob获取实时截图任务调用GetLiveSnapshotJob获取单个实时截图任务。
DeleteLiveSnapshotFiles删除实时截图文件调用DeleteLiveSnapshotFiles删除实时截图文件,可选择只删除记录或同时删除原始OSS文件。
ListLiveSnapshotJobs获取实时截图任务列表调用ListLiveSnapshotJobs获取实时截图任务列表,可分页获取。
ListLiveSnapshotFiles获取实时截图文件列表调用ListLiveSnapshotFiles获取实时截图文件列表,可分页获取。

生产制作

API标题API概述
云剪辑工程管理云剪辑工程管理
CreateEditingProject创建云剪辑工程创建云剪辑工程,支持设置标题、描述、时间线和工程封面等。
GetEditingProject获取单个云剪辑工程查询单个云剪辑工程的信息。
UpdateEditingProject修改云剪辑工程修改云剪辑工程,支持修改标题、时间线和封面等。
DeleteEditingProjects删除云剪辑工程删除云剪辑工程,支持批量删除。
SearchEditingProject搜索云剪辑工程支持按创建时间、状态搜索。
AddEditingProjectMaterials增加剪辑工程关联素材将一个或多个素材添加到剪辑工程中。
GetEditingProjectMaterials获取剪辑工程关联素材获取当前工程绑定的所有素材。
DeleteEditingProjectMaterials删除剪辑工程关联素材将一个或多个素材从剪辑工程中删除。
GetLiveEditingIndexFile获取直播剪辑索引文件获取直播流的索引文件,用于控制台剪辑预览。
剪辑制作剪辑制作
SubmitMediaProducingJob提交剪辑合成作业将一个或多个视频、音频、图片、字幕素材合成为成品。可以通过时间线(Timeline)参数直接提交剪辑设置,也可以先创建云剪辑工程,使用工程ID提交剪辑任务。
GetMediaProducingJob查询剪辑合成作业获取剪辑合成作业的详细信息,包括剪辑合成任务的任务状态、时间线、模板及数据等。 本接口仅支持查询近一年的剪辑任务数据。
SubmitLiveEditingJob提交直播剪辑任务直播剪辑指将一个或多个直播流区间合成为成品。提交直播剪辑任务后,任务将进入后台排队,异步执行。提交后可以调用查询直播剪辑作业(GeLiveEditingJob )接口根据 jobId 来查询作业状态。 也可调用获取媒资内容信息(GetMediaInfo)接口根据 MediaId 来查询生成媒资的信息。
GetLiveEditingJob查询直播剪辑作业获取剪辑合成作业的详细信息,具体包括剪辑合成任务的任务状态、时间线、模板及数据、输出成品资源ID、存储地址、时长、以及任务其他信息等。 本接口仅支持查询近一年的直播剪辑任务数据。
SubmitBatchMediaProducingJob批量智能一键成片将多个视频、音频、图片素材进行智能混剪,一键批量合成视频。
GetBatchMediaProducingJob获取批量智能一键成片任务信息获取批量智能一键成片作业的详细信息,包括作业的输入参数、任务状态、合成的媒资ID及URL。本接口仅支持查询近一年的任务数据。
模板工厂模板工厂
AddTemplate创建模板创建云剪辑模板。模板工厂是对剪辑合成时间线的一个封装,用户可以把常用的剪辑保存为模板,当有同样的需求出现时,只需要传入替换素材即可生产视频。调用AddTemplate接口创建模板,Config为模板描述,普通模板和高级模板Config有较大差异,参考下方使用文档。
GetTemplate获取模板信息根据模板ID获取模板信息。高级模板有解析过长,当类型为高级模板时,Status为Available时即可使用。
UpdateTemplate修改模板调用UpdateTemplate接口修改云剪辑模板,支持修改模板标题、模板配置等信息。
DeleteTemplate删除模板删除模板。
ListTemplates列出符合条件的模板列出符合条件的模板,支持根据模板状态、创建来源等信息查询。
GetTemplateMaterials获取模板素材地址返回高级模板包中的素材地址,供高级模板编辑器使用,素材链接30分钟过期。FileList为所需素材数组,不填则默认返回全部素材地址,最多返回400个。
GetTemplateParams获取模板参数信息获取模板可替换素材参数信息,包括参数名称、素材默认值、素材封面。当前仅支持高级模板。
智能任务智能任务
数字人训练数字人训练
CreateAvatarTrainingJob创建和初始化数字人训练任务本接口用于创建数字人训练任务,配置数字人基础信息与训练所需要的素材信息等。 注意:本接口仅用于初始化训练任务相关信息,并不会提交训练,正式提交训练需调用 SubmitAvatarTrainingJob 接口。
UpdateAvatarTrainingJob更新数字人训练任务信息调用此接口能够修改数字人训练任务的信息,包括: 1. 修改基本信息; 2. 在训练失败后,更新 Video、Transparent 等信息后重新进行训练。
SubmitAvatarTrainingJob提交数字人训练任务调用此接口来正式提交数字人训练任务: 1. 首次提交训练; 2. 在训练失败后重新提交训练。
GetAvatarTrainingJob查询数字人训练任务的详细信息本接口用于查询单个数字人任务的详细信息。
DeleteAvatarTrainingJob删除数字人训练任务调用本接口可以删除处于「初始化(草稿)」、「训练失败」状态下的任务。
ListAvatarTrainingJobs查询数字人训练任务列表调用本接口可以查询您名下的数字人训练任务信息列表。
GetAvatar 查询数字人调用本接口,可以查询某个已经训练成功的数字人的详细信息。
ListAvatars查询数字人列表调用本接口,可以查询到您名下所有已经训练成功的数字人信息。
人声克隆人声克隆
CreateCustomizedVoiceJob创建人声克隆任务(基础版)创建人声克隆任务,用于初始化配置人声克隆任务的基础信息。
GetDemonstrationForCustomizedVoiceJob获取需要朗读的示范文本及音频(基础版)通过本接口来获取训练个性化人声所需要朗读的文本及示例音频。
DetectAudioForCustomizedVoiceJob提交音频检测(基础版)本接口用来检测用户的朗读是否有明显的发音错误、嘈杂的环境等。 云端在进行完音频检测后,对于检测合格的音频会暂存在云端,供后续训练声音时使用,请勿省略该步骤。
SubmitCustomizedVoiceJob提交人声克隆任务(基础版)提交人声克隆任务,VoiceId 需要与音频检测时传递的一致,云端依赖此参数寻找暂存的音频进行训练。 调用此接口后,会同步返回 JobId,训练过程为异步过程。 在训练期间,您可以通过调用 GetCustomizedVoiceJob - 查询人声克隆任务接口来获取当前任务是否完成或训练状态等信息。
SubmitStandardCustomizedVoiceJob提交人声克隆任务(大众版)提交大众版本的人声克隆任务。调用此接口后,会同步返回 JobId,训练过程为异步过程。在训练期间,您可以通过调用 GetCustomizedVoiceJob - 查询人声克隆训练任务接口来获取当前任务是否完成或训练状态等信息。
GetCustomizedVoiceJob查询人声克隆任务查询单个人声克隆任务。
DeleteCustomizedVoiceJob删除人声克隆任务调用此接口可以删除处于非“训练中”与“训练成功”的人声克隆任务。
ListCustomizedVoiceJobs查询人声克隆任务列表 列出当前用户的所有人声克隆训练任务。
GetCustomizedVoice查询个性化人声调用本接口可以查询特定的个性化人声信息。
UpdateCustomizedVoice更新个性化人声信息调用此接口可以修改个性化人声的信息,目前仅支持修改示例音频媒资ID,以支持自行维护示例音频。
ListCustomizedVoices查询个性化人声列表 列出当前用户的所有的个性化人声。
SubmitASRJob提交ASR智能字幕任务根据视频语音提取时间起止点及对应文字信息。
SubmitAvatarVideoJob提交数字人渲染任务以人声音频或文本作为输入,渲染虚拟人视频。
SubmitAudioProduceJob提交智能语音任务将文本内容转化成语音文件。
SubmitTextGenerateJob提交关键词扩写任务根据提交的关键词、字数、文案数,扩写出营销文案。由于中文的特殊性,输出文案字数可能跟需求字数有出入。提交任务成功后,根据JobId调用GetSmartHandleJob接口获取任务状态和结果。
SubmitVideoTranslationJob提交视频翻译任务通过本接口,您可以提交视频翻译任务。当前支持字幕级翻译,即将视频中出现的字幕翻译为指定语言,未来会拓展支持声音(口播)级翻译与面容(口型)适配。
GetSmartHandleJob获取智能任务结果获取智能任务结果,可以根据任务ID,获取智能任务信息及执行结果。 本接口仅支持查询近一年的剪辑任务数据。
DeleteSmartJob删除智能任务用户可以根据任务ID删除智能任务。
ListSmartJobs获取任务列表根据用户所给参数,返回所有符合条件的任务列表。
ListSmartSysAvatarModels获取系统数字人列表获取系统数字人列表,支持分页查询。
ListSmartVoiceGroups列出智能语音发音人信息列出智能语音发音人信息,包括发音人名称、性别、示例音频,列表按照场景进行分组。

媒体AI

API标题API概述
智能标签智能标签
SubmitSmarttagJob提交智能标签作业提交智能标签作业。
QuerySmarttagJob智能标签任务查询接口查询智能标签任务。
智能生产智能生产
SubmitIProductionJob提交智能生产任务调用SubmitIProductionJob提交智能生产任务。
QueryIProductionJob查询智能生产任务调用QueryIProductionJob查询智能生产任务状态与结果。
媒体DNA媒体DNA
CreateDNADB创建DNA库调用CreateDNADB创建DNA库。
DeleteDNADB删除DNA库调用DeleteDNADB删除DNA库。
ListDNADB查询DNA库调用ListDNADB查询DNA库。
SubmitDNAJob提交DNA作业调用SubmitDNAJob提交DNA作业。
CancelDNAJob取消DNA作业调用CancelDNAJob取消DNA作业。
DeleteDNAFiles删除DNA文件调用DeleteDNAFiles删除DNA文件。
ListDNAFiles查询DNA文件调用ListDNAFiles查询DNA文件。
QueryDNAJobList查询DNA作业列表调用QueryDNAJobList查询DNA作业。

用量统计

API标题API概述
DescribeMeterImsMediaConvertUHDUsageIMS的MPS转码UHD计量查询IMS的MPS转码UHD计量查询,最大查询范围31天,最远可查90天内的数据。
DescribeMeterImsMediaConvertUsageIMS的点播转码计量查询IMS的点播转码计量查询,最大查询范围31天,最远可查90天内的数据。
DescribeMeterImsEditUsageIMS点播视频剪辑用量查询IMS点播视频剪辑用量查询,最大查询范围31天,最远可查90天内的数据。
DescribeMeterImsSummaryIMS点播用量统计查询IMS点播用量统计查询,最大查询范围31天,最远可查90天内的数据。
DescribeMeterImsMpsAiUsageIMS的MPS-AI计量查询IMS的MPS-AI用量查询,最大查询范围31天,最远可查90天内的数据。

全局配置

API标题API概述
SetEventCallback设置事件回调设置特定事件的通知机制。
GetEventCallback获取事件回调调用GetEventCallback获取事件回调配置。

工作流

API标题API概述
StartWorkflow提交工作流任务通过调用StartWorkflow接口,您可以提交工作流模板任务,从而实现基于工作流模板的自动化媒体处理流程。
GetWorkflowTask查询工作流任务根据任务ID查询工作流任务,包括工作流Id、工作流任务状态、工作流任务结果。 本接口仅支持查询近一年的工作流任务数据。

其他

API标题API概述
DescribePlayList播放记录列表接口通过播放器TraceId来获取播放记录列表,该接口有分页。
SubmitDynamicChartJob提交动态图表任务根据Excel生成折线图、饼图、柱状图等视频,支持修改线条颜色、字体等信息。
ListMediaProducingJobs列出符合条件的剪辑合成任务列出符合条件的合成任务,可根据任务状态、类型查询。
ListBatchMediaProducingJobs列出符合条件的一键成片任务列出符合条件的一键成片任务,可以根据任务类型、状态等条件查询。