You need to enable JavaScript to run this app.
导航
智能创作云
  • 文档首页
    • /智能创作云/API对接相关/智能创作云-模板消费API相关/模版消费API
模版消费API
最近更新时间：2024.03.26 14:08:10首次发布时间：2022.06.06 10:16:00
我的收藏
公共字段

  1. 请求Host：https://icp.volcengineapi.com

  2. 请求Header

描述：http请求中header需增加的字段

参数名参数类型是否必填描述
X-DateString是使用UTC时间，精确到秒。请使用格式：YYYYMMDD'T'HHMMSS'Z' ，例如：20201103T104027Z

Authorization

String

是

HMAC-SHA256 Credential={AccessKeyId}/{ShortDate}/{Region}/{Service}/request, SignedHeaders={SignedHeaders}, Signature={Signature}

  • 签名完整过程详见：签名示例

  • Java版签名Demo详见如下附件

    muse-signer-java.zip
    31.81KB
Content-TypeString是MIME类型，固定值： application/json

X-Content-Sha256

String

否

对完整请求Body的加密结果，HexEncode(Hash(RequestPayload))

HexEncodeHexEncode代指转16进制编码
Hash代指SHA256算法
RequestPayload代指完整的请求的body。

Authorization中的信息含义：

名称类型备注

AccessKeyId

String

请求的AccessKey。

  • AK/SK获取说明

    • 说明：在调用火山引擎视觉智能控制台的各个能力之前，确保您已生成访问密钥（AccessKey）。AccessKey包括AccessKeyID（AK）和AccessKeySecret（SK），其中AccessKeyID用于标识用户，AccessKeySecret是用来验证用户的密钥，请妥善保管。

    • 获取方式：点击右上角账号，下拉列表选择【密钥管理】，点击【新建密钥】按钮，可获取AK/SK，可以此为凭证调用上述已接入应用的接口。

    注：安全起见，建议新建子账户，并使用子账户的AK/SK

ShortDateString请求的短时间，使用UTC时间，精确到日。请使用格式：YYYYMMDD，例如：20221101
RegionString请求的地域，固定值： cn-north-1
ServiceString请求的服务，固定值： iccloud_muse
SignedHeadersString参与签名的Header，用分号分隔。
SignatureString计算完毕的签名。
数据结构

  1. TemplateTaskDetail

描述：视频合成任务的结果，包含了此次任务的相关信息

参数类型描述
video_keyString任务唯一标识，用于查询任务和标识任务
req_idString渲染任务ID，用来排查问题，用户可不关注此字段
user_idString创建者账户ID
user_nameString创建者账户名称
titleString生成视频标题

type

String

模板类型
"1"、剪同款（字节生产的模板）
"2"、剪同款（安装字节插件的AE模板）

template_idString模板ID
tags[]模板标签
param_numInt视频槽位数量
urlString生成视频播放/下载URL。注：url有效期24小时

task_status

Int

任务状态：
0:任务完成
1:任务进行中
2:任务失败
3:任务取消

progressInt任务进度，范围0到100
created_atString任务创建时间，格式为2020-01-02 15:04:05
updated_atString任务更新时间，格式同上
messageString任务错误信息，用于排查bug，用户不必关注

  1. MediaInfo

描述：槽位的字段介绍，同模板概念以及模板消费API介绍 中的槽位字段介绍

名称类型是否可修改说明
uuidStringN只读，槽位的唯一id，用于映射槽位到模板中的节点
typeStringN只读，槽位类型，目前支持video、text、temptext；text指普通文字，temptext为特效文字
starttimeFloatN只读，槽位在最终视频中的开始时间，单位秒
endtimeFloatN只读，槽位在最终视频中的结束时间，单位秒
prefixStringN只读，text类型槽位中可能会有，渲染时需要，用户不必关注
recommend_wordsIntN只读，支持的TTS字数上限。（默认语速下）

source

String

Y

type为video时，传入的资源路径，http链接。不仅可以传视频链接（只支持mp4）还可以传图片链接。传入的视频时长应不小于clip_end-clip_start；且文件大小不大于50M

text（text类型和temptext类型槽位都有这个字段）

String

Y

text类型槽位中的文本内容，文字不超过300个字符

DictYtemptext类型槽位中的文本内容，例：{ 0："民宿打卡•像住在城堡里" ， 1："民宿打卡•像住在城堡里" } ，内部key不可修改，value为可修改的文本。每段文字不超过300个字符

clip_start

Float

Y

视频裁切起点和终点，单位秒（当source指向视频链接时，链接中的视频会被裁剪后再使用，裁剪起始时间为clip_start，裁剪结束时间为clip_end）
这两个字段可修改，但必须同时修改，保证clip_end与clip_start之差不变

clip_endFloatY
volumeIntY素材音量，范围0到200（素材原音量为100）

crop

List

Y

video槽位中视频或图片的裁切坐标，分别是从左下角开始顺时针的4个点，坐标原点在图像中心，右上方为正坐标。例：全图坐标为[[-1.0，-1.0]，[-1.0，1.0]，[1.0，1.0]，[1.0，-1.0]]。x和y坐标需要分别除以二分之一宽高，因此坐标范围是[-1，1]。

  1. TemplateDetail

描述：模板的详细信息

参数类型描述
idString模板id

type

String

模板类型
"1"、剪同款（字节生产的模板）
"2"、剪同款（安装字节插件的AE模板）

ratioString模板比例；例如"16:9"
titleString模板名称
tags[]String模板标签
poster_urlString封面图url
user_idString创建者子账户ID
descriptionString模板描述
preview_urlString模板预览视频url
team_visibilityInt0代表非团队可见，1代表团队可见
team_space_idString团队空间ID
recommend_wordsInt推荐的TTS字数上限。（默认语速下）
paramsJson String ([] MediaInfo)模板的槽位列表
levelString模板等级("S"，"A"，"Unset")
created_atString模板创建时间

status

Int

模板状态：
1：上传失败
2：上传完成
3：转码中
4：转码完成
5：转码失败
6：上传中
7：封面/预览视频 转码中
仅需要校验status=4的即可， 4****为成功状态

code

Int

拉取模板信息错误类型
4050, 模板已下架
4051, 该ID对应资源不是模板
4052, 该模板团队不可见
4053, 该模板不在当前用户空间下

messageString任务错误信息，用于排查bug，用户不必关注

注：消费时获取到的模板槽位列表，其中每个槽位的字段都是事先定义好的，使用时不可新增字段或删除字段，也不可新增槽位或删除槽位，只可修改槽位中允许被修改的字段。

  1. TtsInfo

描述：TTS播报的信息

参数类型描述备注
ToneIdInt音色ID，详见下方【物料】部分
TextString全局播报文本，不超过200字这两个参数只能二选一
TextList[]String槽位播报文本列表，长度等于槽位个数，每项长度不超过200字，对应槽位文本传""，则该槽位不增加TTS。如果tts槽位重叠，选择策略见下方【TTS槽位重叠选择策略】
SpeedIntTTS播报速度，100为原速度，取值范围（50~200）
PitchIntTTS播报音调，100为原音调，取值范围（50~200）
VolumeIntTTS播报音量，100为原音量，取值范围（0~200）
BgmVolumeString视频原BGM音量，100为原音量，取值范围（0~200）
FontTypeInt字幕字体ID，支持字体详见下方【物料】部分，传null不展示字幕，默认null
FontSizeInt字幕字号，默认10
FontColorString字幕颜色信息，长度=8，传16进制字符串。例如："FFFFFFFF"，前两位是透明度，FF为不透明，00为全透明，后六位为RGB颜色。默认不透明白色字幕，即"FFFFFFFF"。
MarginVInt字幕距离屏幕下方的距离，单位：像素。

注：音色ID可在SaaS平台智能配音功能试听使用，详见本文档下方【物料】部分。

  1. Entity

描述媒资归属的实体

名称类型必选描述

Type

String

是

类型，取值有：

  • PERSON：个人
IdInteger否Id，当 Type=PERSON，取值为用户 Id

HTTP接口详情

  1. DescribeTemplate

描述：根据模板id获取模板的详细信息。
Meghod：POST
请求参数

参数类型参数类型是否必填描述
ActionStringQuery是DescribeTemplate
VersionStringQuery是2021-09-01
TemplateId[]StringBody是模板id数组，上限为50
OwnerEntityBody否描述媒资归属的实体

请求参数示例：

{
    "TemplateId": ["xxxxxxxxxxx", "yyyyyyyyyyy"],
    "Owner":  { 
        "Id": 123,
        "Type": "PERSON"
    }
}

返回参数

{
    "ResponseMetadata": {
        "RequestId": "20211213140257010225133143062CC07B",
        "Action": "DescribeTemplate",
        "Version": "2021-09-01",
        "Service": "iccloud_muse",
        "Region": "cn-north-1",
    },
    "Result": {
        "Data": {
               "templates": {"123":[TemplateDetail](https://bytedance.feishu.cn/wiki/wikcnB9eyC4HR31cQc3i7YNO46g#doxcn8eym6eSIEYoQwSuDxFkACr), ...},  //模板信息,key为模板id，value为模板详情
               "total": 10, //  返回的模板总个数
                 },
        "Message": "xxx",  //错误信息. 可选
          },
    },
    "Code": 0,
    "Message": '成功'
}

  1. SearchTemplate

描述：搜索模板。在用户模板库中搜索满足条件的模板，支持多条件搜索。如果没有筛选条件（不包括Page、PageSize），则会返回所有模板
Method：POST
请求参数

参数类型参数类型是否必填描述
ActionStringQuery是SearchTemplate
VersionStringQuery是2021-09-01
SourceIntBody否模板来源，0代表模板广场模板，1代表租户下的模板，默认0
PageIntBody否要查询的页数，默认0
PageSizeIntBody否每页的数量，默认10，范围[1，50]
TitleStringBody否根据模板名称关键字或模板标签关键字筛选。例：输入"美食生活"，后台会先进行分词，得到美食、生活两个词语，模板名称或模板标签中含有美食或生活关键字，则匹配上。
Ratio[]StringBody否根据模板比例筛选，可选 "1:1", "3:4", "4:3", "16:9", "9:16"

Type

[]String

Body

否

模板类型
"1"、剪同款（字节生产的模板）
"2"、剪同款（安装字节插件的AE模板）

CreateTime

[]String

Body

否

根据创建时间段查找，例：["2020-01-02 15:04:05" ，"2020-01-02 16:04:05" ]，传""，为不限制，例如[""，"2020-01-02 16:04:05"]，或者["2020-01-02 16:04:05"，""]

ParamItemNum[]IntBody否视频槽位数量，格式为 [1，3，4]
Level[]StringBody否模板等级，可选["S","A","Unset"]。默认全选
OrderIntBody否排序方式，1正序，-1倒序，默认：-1
SortByStringBody否排序字段，暂只支持"create_time"，默认"create_time"

UserData

Int

Body

否

0代表搜索租户下所有模板，1代表只搜索自己上传的模板，默认0

TeamSpaceIdStringBody否团队空间ID，默认‘0’，搜索我的空间
OwnerEntityBody否描述媒资归属的实体

请求参数示例：

{
    "Source": 0,
    "Page": 0,
    "PageSize": 20,
    "Title": "美食生活",
    "Ratio": ["1:1"],
    "Type": ["1"],
    "CreateTime": ["2020-01-01 15:04:05", "2020-01-02 15:04:05"],
    "ParamItemNum": [4, 5],
    "Order": -1,
    "SortBy": "create_time",
    "Owner":  { 
        "Id": 123,
        "Type": "PERSON"
    }
}

返回参数

{
    "ResponseMetadata": {
        "RequestId": "20211213140257010225133143062CC07B",
        "Action": "SearchTemplate",
        "Version": "2021-09-01",
        "Service": "iccloud_muse",
        "Region": "cn-north-1",
    },
    "Result": {
        "Data": {
               "total": 10, //获取的模板总数
               "templates": [[TemplateDetail](https://bytedance.feishu.cn/wiki/wikcnB9eyC4HR31cQc3i7YNO46g#doxcn8eym6eSIEYoQwSuDxFkACr), ...],  //模板信息列表，每个元素为TemplateDetail
                 },
        "Message": "xxx",  //错误信息. 可选
          },
    },
    "Code": 0,
    "Message": '成功'
}

  1. SearchTemplateTask

描述：搜索模板合成任务。根据给定的条件搜索任务，支持多条件搜索，只能查到自己创建的任务
Method：POST
请求参数

参数类型参数类型是否必填描述
ActionStringQuery是SearchTemplateTask
VersionStringQuery是2021-09-01
PageIntBody否要查询的页数，默认0
PageSizeIntBody否每页的数量，默认10，范围[1，100]
TitleStringBody否根据视频名称关键字筛选，例：输入"美食"，模板名称中含有美食关键字，则匹配上。

Type

[]String

Body

否

按模板类型搜索
"1"、字节生产的模板
"2"、ae模板

TaskStatus

[]Int

Body

否

按任务状态：
0:任务完成
1:任务进行中
2:任务失败

CreateTime

[]String

Body

否

根据创建时间段查找，例：["2020-01-02 15:04:05" ，"2020-01-02 16:04:05" ]，传""，为不限制，例如[""，"2020-01-02 16:04:05"]，或者["2020-01-02 16:04:05"，""]

ParamItemNum[]IntBody否视频槽位数量，格式为 [1，3，4]
Tags[]StringBody否根据模板标签筛选，关键字匹配例：输入["美食，生活"]，模板标签中含有美食或生活关键字，则匹配上。
OrderIntBody否排序方式，1正序，-1倒序，默认：-1

SortBy

String

Body

否

排序字段，暂只支持"create_time"，"type"，"task_status"，默认"create_time"

OwnerEntityBody否描述媒资归属的实体

请求参数示例：

{
    "Page": 0,
    "PageSize": 20,
    "Title": "美食",
    "Type": ["1"],
    "TaskStatus": [0, 2],
    "CreateTime": ["2020-01-01 15:04:05", "2020-01-02 15:04:05"],
    "ParamItemNum": [4, 5],
    "Tags": ["美食", "生活"]
    "Order": -1,
    "SortBy": "create_time",
    "Owner":  { 
        "Id": 123,
        "Type": "PERSON"
    }
}

返回参数

{
    "ResponseMetadata": {
        "RequestId": "20211213140257010225133143062CC07B",
        "Action": "SearchTemplateTask",
        "Version": "2021-09-01",
        "Service": "iccloud_muse",
        "Region": "cn-north-1",
    },
    "Result": {
        "Data": {
               "total": 10, //获取到的任务总数
               "tasks": [[TemplateTaskDetail](https://bytedance.feishu.cn/wiki/wikcnB9eyC4HR31cQc3i7YNO46g#doxcnGYMgc6WwwYqOaITaO93G2g),...]， //任务信息列表，每个元素为TemplateTaskDetail
                 },
        "Message": "xxx",  //错误信息. 可选
          },
    },
    "Code": 0,
    "Message": '成功'
}

  1. SubmitTemplateTaskAsync

描述：提交视频合成任务，后续用户可通过DescribeTemplateTask查询合成任务。
Method：POST
请求参数

参数类型参数类型是否必填描述
ActionStringQuery是SubmitTemplateTaskAsync
VersionStringQuery是版本号，2021-09-01
TemplateIdStringBody是模板id

TemplateType

String

Body

是

模板类型
"1"、剪同款（字节生产的模板）
"2"、剪同款（安装字节插件的AE模板）
默认"1"

ParamsList[]MediaInfoBody是填充了资源的槽位列表

Title

String

Body

否

视频名称，长度不超过200个字符，如果为空，视频名称为：api_模板消费_当前时间戳

Resolution

String

Body

否

指定生成视频分辨率，可选720P，1080P，2K，4K，大写P、K。默认1080P
分辨率设置规则如下（H*W）：
720P：1280x720，
1080P：1920x1080（默认）
2K：2048×1080，
4K：3840x2160
注： AE****模板不支持自定义分辨率，依赖模版

Fps

Int

Body

否

生成视频帧率，默认25fps，可选24，25，30，50，60
注： AE模板不支持自定义帧率**，依赖模版**

TtsTtsInfoBody否音频播报信息

CallbackUri

String

Body

否

公网可访问的http url，需支持POST格式，将以json形式发送，回调格式包含TemplateTaskDetail和自定义CallbackParams

CallbackParamsStringBody否回调参数中的业务信息，JSON字符串，将在回调中带回。
TeamSpaceIdStringBody否团队空间ID
OwnerEntityBody否描述媒资归属的实体

请求参数示例：

{
    "TemplateId": "xxxxxxx",
    "TemplateType": "1",
    "ParamsList": [
        {
            "endtime": 15, 
            "prefix": "a", 
            "starttime": 0, 
            "text": "[武汉特色小吃] dliualter 2022-05-31 07:14:02.920806", 
            "type": "text", 
            "uuid": "164335994144510794653528165232"
        }, 
        {
            "endtime": 15, 
            "prefix": "aa", 
            "starttime": 0, 
            "text": "小慧小店 dliualter 2022-05-31 07:14:02.920806", 
            "type": "text", 
            "uuid": "164335994144492694653528159456"
        }, 
        {
            "endtime": 15, 
            "prefix": "aaa", 
            "starttime": 0, 
            "text": "订餐热线：088-88888888 dliualter 2022-05-31 07:14:02.92", 
            "type": "text", 
            "uuid": "164335994144478994653528153680"
        }, 
        {
            "clip_end": 14.600000381469727, 
            "clip_start": 0, 
            "endtime": 15, 
            "source": "https:xxxxx", 
            "starttime": 0.4000000059604645, 
            "type": "video", 
            "uuid": "164335994144340694653528022752", 
            "volume": 1
        }
    ] 
    "Title": "test",
    "Resolution": "720P",
    "Fps": 25,
    "Owner":  { 
        "Id": 123,
        "Type": "PERSON"
    }
}

注：获取到的模板槽位列表，顺序不可打乱，并且每个槽位的字段都是事先定义好的，使用时不可新增字段或删除字段，也不可新增槽位或删除槽位，只可修改槽位中允许被修改的字段。

返回参数

{
    "ResponseMetadata": {
        "RequestId": "20211213140257010225133143062CC07B",
        "Action": "SubmitTemplateTaskAsync",
        "Version": "2021-09-01",
        "Service": "iccloud_muse",
        "Region": "cn-north-1",
    },
    "Result": {
        "Data": {
               "video_key": "xxxxx",  //任务id，任务唯一标识，用于查询和标识任务
               "task_id": "xxxxx" // 可选   任务中心的任务id，用于去任务中心查任务
                 },
        "Message": "xxx",  //错误信息. 可选
          },
    },
    "Code": 0,
    "Message": '成功'
}

  1. DescribeTemplateTask

描述：查询模板合成任务的结果，可同时查询多个任务
Method：POST
请求参数

参数类型参数类型是否必填描述
ActionStringQuery是DescribeTemplateTask
VersionStringQuery是2021-09-01

VideoKeys

[]String

Body

是

任务id数组，上限为50

OwnerEntityBody否描述媒资归属的实体

请求参数示例：

{
    "VideoKeys": ["xxxxxx", "yyyyyyyyy"]，
    "Owner":  { 
        "Id": 123,
        "Type": "PERSON"
    }
}

返回参数

{
    "ResponseMetadata": {
        "RequestId": "20211213140257010225133143062CC07B",
        "Action": "DescribeTemplateTask",
        "Version": "2021-09-01",
        "Service": "iccloud_muse",
        "Region": "cn-north-1",
    },
    "Result": {
        "Data": {
               "tasks": [[TemplateTaskDetail](https://bytedance.feishu.cn/wiki/wikcnB9eyC4HR31cQc3i7YNO46g#doxcnGYMgc6WwwYqOaITaO93G2g),...],  //任务结果列表，每个元素为TemplateTaskDetail
                 },
        "Message": "xxx",  //错误信息. 可选
          },
    },
    "Code": 0,
    "Message": '成功'
}

  1. CreateTemplate

描述：上传自制AE模板。
Method：POST
请求参数：

参数类型参数类型是否必填描述
ActionStringQuery是CreateTemplate
VersionStringQuery是2021-09-01
UriStringBody是模板url
TitleStringBody是模板title
Tags[]StringBody否模板标签，默认[]
DescriptionStringBody否模板描述，默认""
TeamVisibilityBoolBody否是否团队可见，只有主账号有权限填true，默认false
TeamSpaceIdStringBody否团队空间ID
OwnerEntityBody否描述媒资归属的实体

请求参数示例：

{
    "Uri": "http://xxxxxx",
    "Title": "test",
    "Tags": ["美食", "生活"],
    "Description": "美好生活",
    "TeamVisibility": true,
    "Owner":  { 
        "Id": 123,
        "Type": "PERSON"
    }
}

返回参数

{
    "ResponseMetadata": {
        "RequestId": "20211213140257010225133143062CC07B",
        "Action": "CreateTemplate",
        "Version": "2021-09-01",
        "Service": "iccloud_muse",
        "Region": "cn-north-1",
    },
    "Result": {
        "Data": {
               "task_key": "xxxxx", //任务key
                 },
        "Message": "xxx",  //错误信息. 可选
          },
    "Code": 0,
    "Message": '成功'
}

  1. DescribeCreateTemplateResult

描述：查询模板上传结果。
Method：GET
请求参数：

参数类型参数类型是否必填描述
ActionStringQuery是DescribeCreateTemplateResult
VersionStringQuery是2021-09-01
TaskKeyStringQuery是上传任务key

OwnerType

String

Query

否

类型，取值有：

  • PERSON：个人
OwnerIdIntQuery否Id，当 Type=PERSON，取值为用户 Id

返回参数

{
    "ResponseMetadata": {
        "RequestId": "20211213140257010225133143062CC07B",
        "Action": "DescribeCreateTemplateResult",
        "Version": "2021-09-01",
        "Service": "iccloud_muse",
        "Region": "cn-north-1",
    },
    "Result": {
        "Data": {
               "success": true, //是否成功
               "template_id": "1233",  //模板id
                 },
        "Message": "xxx",  //错误信息. 可选
          },
    "Code": 0,
    "Message": '成功'
}

  1. UpdateTemplate

描述：更新自制模板。对模板信息进行修改编辑。
Method：POST
请求参数

参数类型参数类型是否必填描述
ActionStringQuery是UpdateTemplate
VersionStringQuery是2021-09-01
TemplateIdStringBody是模板id

TemplateDetail

Dict

Body

是

更新信息，包括title，tags，description，preview_url，poster_url，team_visibility

OwnerEntityBody否描述媒资归属的实体

请求参数示例：

{
    "TemplateId": "xxxxxx",
    "Owner":  { 
        "Id": 123,
        "Type": "PERSON"
    }，
    "TemplateDetail": {
        "title": "update",
        "tags": ["美食", "生活"],
        "description": "美好生活",
        "preview_url": "http://xxxxx",
        "poster_url": "http://xxxxx",
        "team_visibility": true
    }
}

返回参数

{
    "ResponseMetadata": {
        "RequestId": "20211213140257010225133143062CC07B",
        "Action": "UpdateTemplate",
        "Version": "2021-09-01",
        "Service": "iccloud_muse",
        "Region": "cn-north-1",
    },
    "Result": {
        "Data": {
               "success": true, //是否成功
               "template_id": "1233",  //模板id
                 },
        "Message": "xxx",  //错误信息. 可选
          },
    "Code": 0,
    "Message": '成功'
}

  1. DeleteTemplate

描述：删除自制模板。
Method：POST
请求参数

参数类型参数类型是否必填描述
ActionStringQuery是DeleteTemplate
VersionStringQuery是2021-09-01
TemplateId[]StringBody是模板Id数组，上限为50
OwnerEntityBody否描述媒资归属的实体

请求参数示例：

{
    "TemplateId": ["xxxxxx", "yyyyyyyy"]，
    "Owner":  { 
        "Id": 123,
        "Type": "PERSON"
    }
}

返回参数

{
    "ResponseMetadata": {
        "RequestId": "20211213140257010225133143062CC07B",
        "Action": "DeleteTemplate",
        "Version": "2021-09-01",
        "Service": "iccloud_muse",
        "Region": "cn-north-1",
    },
    "Result": {
        "Data": {
               "123": {"success":false, "message":"模板不存在"},  //key，为模板id，value为删除结果
                 },
        "Message": "xxx",  //错误信息. 可选
          },
    "Code": 0,
    "Message": '成功'
}

  1. CancelTemplateTask

描述：取消模板合成任务，可同时取消多个任务。
Method：POST
请求参数

参数类型参数类型是否必填描述
ActionStringQuery是CancelTemplateTask
VersionStringQuery是2021-09-01
VideoKeys[]StringBody是任务id数组，上限为50
OwnerEntityBody否描述媒资归属的实体

请求参数示例：

{
    "VideoKeys": ["xxxxxx", "yyyyyyyy"],
    "Owner":  { 
        "Id": 123,
        "Type": "PERSON"
    }
}

返回参数

{
    "ResponseMetadata": {
        "RequestId": "20211213140257010225133143062CC07B",
        "Action": "CancelTemplateTask",
        "Version": "2021-09-01",
        "Service": "iccloud_muse",
        "Region": "cn-north-1",
    },
    "Result": {
        "Data": {
                   "xxxx":{"success":true,"message":""}
               },  // key为videokey
        "Message": "xxx",  //错误信息. 可选
          },
    "Code": 0,
    "Message": '成功'
}

  1. DelFilm

描述： 根据作品ID删除作品，可同时删除多个。
Method：POST
请求参数

参数类型参数类型是否必填描述
ActionStringQuery是DelFilm
VersionStringQuery是2022-08-01
FilmIdList[]StringBody是作品id数组，上限为50
OwnerEntityBody否描述媒资归属的实体

请求参数示例：

{
    "FilmIdList": ["12345", "56789"],
    "Owner":  { 
        "Id": 123,
        "Type": "PERSON"
    }
}

返回参数

{
    "ResponseMetadata": {
        "RequestId": "20211213140257010225133143062CC07B",
        "Action": "DelFilm",
        "Version": "2022-08-01",
        "Service": "iccloud_muse",
        "Region": "cn-north-1",
    },
    "Result": {
        "Data": {
               "Result": {
                   "xxxx":{"Success":true,"Message":""}
               },  // key为作品ID
                 },
        "Message": "xxx",  //错误信息. 可选
          },
    "Code": 0,
    "Message": '成功'
}

source 字段支持的素材封装格式与编码

素材格式编解码格式封装格式备注

视频格式

h264

MP4

图片序列，不适用视频编码

hevc(h265)MP4
qtrleMP4
vp8MP4
vp9MP4
av1MP4
gif
mpeg4MP4
rawvideo

音频格式

aac

aac

音频支持封装格式即等于支持编解码

aac_latmaac_latm
mp3*mp3*
flacflac
pcm*pcm*
theora
vorbis
opusopus
M4AM4A
ALAC(编码)
WAVWAV
WMA
FLACFLAC

图片格式

png

png

图片支持封装格式即等于支持编解码

gifgif
jpg/jpegjpg/jpeg
bmpbmp
HEIFHEIF
HEIC
webpwebp
tifftiff
错误码

描述：对应返回参数中最外层的Code和Message字段

CodeMessage
0成功
4001参数错误（内含具体错误信息）
4002用量超限
4003无效账户信息
4004大于最大任务数，试用期间最多同时运行5个任务
4005请求header信息缺失
4006任务不存在或已被删除
5001服务器错误

特殊情况：网关调用服务出错时，返回参数

用户的请求由TOP网关转发给OpenApi，网关错误返回字段结构如下，

{
    "ResponseMetadata": {
        "RequestId": "20211213140257010225133143062CC07B",
        "Action": "DescribeTemplateTask",
        "Version": "2021-09-01",
        "Service": "iccloud_muse",
        "Region": "cn-north-1",
        "Error": {
            "CodeN": 100007,
            "Code": "ServiceNotFound",
            "Message": "This service[iccloud_muse] not found."
        }
    }
}

网关错误码说明如下：

CodeCodeNMessage备注Status
UndefinedError100001Undefined Internal Error. Pls Contact With Admin.一般不出现这个问题，这是系统开发兜底的错误提示500
MissingParameter100002The request is missing %s parameter.关键参数缺失，例如Action, Version参数400

MissingAuthenticationToken

100003

Request is missing Authentication Token

缺少身份认证的必要信息，例如Auth信息

401

MissingRequestInfo

100004

The request is missing %s information.

缺少请求必要信息，例如：Accesskey，service，region等

400

MissingSignature100005The request is missing signature.缺少签名结果401
InvalidTimestamp100006The Signature of the request is expired请求过期或请求的签名时间来自未来403
ServiceNotFound100007This service[%s] not found.请求的服务不存在404

InvalidActionOrVersion

100008

Could not find operation %s for version %s

请求接口不存在

404

InvalidAccessKey

100009

The accesskey [%s] included in the request is invalid.

请求的AK不合法

401

SignatureDoesNotMatch

100010

The request signature we calculated does not match the signature you provided. Check your Secret Access Key and signing method. Consult the service documentation for details.

签名结果不正确

401

ServiceShouldCallSelfApi

100011

The service(%s) should call self-api

使用service aksk访问请求，仅能访问自己的接口和公共服务的接口。公共服务例如：iam

403

LackPolicy

100012

Request was rejected because of lack of policy.

子用户请求缺少权限（默认是deny的）

403

AccessDenied100013User is not authorized to perform: %s on resource: %s子用户拥有的权限不支持当前操作403
InternalError100014Service has some internal Error. Pls Contact With AdminTOP自身内部错误，例如DB error。500
FailToConnect100015Top Fail to Connect to Internal Service业务服务连接不上，这里的业务一般指具体的imagex、vod。502

InternalServiceTimeout

100016

Internal Service is timeout. Pls Contact With Admin

内部服务执行超时，请查看服务在TOP上配置的超时时间。

504

InnerApiNeedAccountInfo100017The inner request should have account infoService aksk请求内部服务时缺少了账号信息400
FlowLimitExceeded100018Request was rejected because the request speed of this openAPI is beyond the current flow control limit.请求过于频繁，超出了基本限速429
ServiceUnavailableTemp100019Service is busy, please try again later.处于熔断状态的服务暂时不可访问，稍后重试503
MethodNotAllowed100020HTTP Method Not AllowedHttp method不合法405
LackProjectPolicy100021Request was rejected because of lack of project policy.请求需要验证Project的权限，当前Project权限验证不合法403

InternalServiceError

100023

Service has some internal Error. Pls Contact With Admin.

业务服务存在故障，这里的业务一般指具体的imagex、vod。故障不来自TOP

502

InvalidAuthorization100024Invalid 'Authorization' header, Pls check authorization header.Authorization头格式错误，检查Authorization。400

InvalidCredential

100025

Invalid credential in 'Authorization', Pls check credential in authorization header.

Authorization头中的Credential格式错误，检查Credential

400

InvalidSecretToken

100026

Invalid secret token, msg: %s.

错误的STS or STS2，可能是多种错误，例如签名错误、过期等。

401

物料

音色

可以在智能创作云SaaS平台【智能配音】功能，体验多种不同音色的播报效果，可以自由调节语速、音调等数据。

ID名称描述试听链接备注
0抖音IP小姐姐机械女声，适用于通用场景https://sf1-cdn-tos.huoshanstatic.com/obj/labcv-tob/muse/tts_new_BV001.mp3
1抖音IP小哥哥机械男声，适用于通用场景https://sf1-cdn-tos.huoshanstatic.com/obj/labcv-tob/muse/tts_BV002.mp3
2成熟女声成熟女声，适用于零售，金融场景https://sf1-cdn-tos.huoshanstatic.com/obj/labcv-tob/muse/tts_BV009_DPE.mp3
3青年女声客服女声，适用于零售，金融场景https://sf1-cdn-tos.huoshanstatic.com/obj/labcv-tob/muse/tts_BV007.mp3
4稳重大叔大气男声, 适用于广告，零售场景https://sf1-cdn-tos.huoshanstatic.com/obj/labcv-tob/muse/tts_BV006.mp3
5青年男声客服男声，适用于零售，金融场景https://sf1-cdn-tos.huoshanstatic.com/obj/labcv-tob/muse/tts_BV008_DPE.mp3
6新闻女声新闻女声, 适用于通用场景https://sf1-cdn-tos.huoshanstatic.com/obj/labcv-tob/muse/tts_BV011.mp3
7可爱少女活泼女声，适用于广告，零售场景https://sf1-cdn-tos.huoshanstatic.com/obj/labcv-tob/muse/tts_BV005.mp3
8新闻男声新闻男声, 适用于通用场景https://sf1-cdn-tos.huoshanstatic.com/obj/labcv-tob/muse/tts_BV012.mp3
9活力青年活力男生，适用于通用场景https://sf1-cdn-tos.huoshanstatic.com/obj/labcv-tob/muse/tts_BV056.mp3
10中英男声中英温柔男声，适用于通用场景https://sf1-cdn-tos.huoshanstatic.com/obj/labcv-tob/muse/tts_BV033_ParaTaco.mp3
11东北老铁东北方言，适用于泛互场景https://sf1-cdn-tos.huoshanstatic.com/obj/labcv-tob/muse/tts_BV021.mp3
12西安掌柜西安方言，适用于泛互场景https://sf1-cdn-tos.huoshanstatic.com/obj/labcv-tob/muse/tts_BV210.mp3
13港剧男神粤语方言，适用于泛互场景https://sf1-cdn-tos.huoshanstatic.com/obj/labcv-tob/muse/tts_BV026.mp3
14甜美台妹台湾方言，适用于泛互场景https://sf1-cdn-tos.huoshanstatic.com/obj/labcv-tob/muse/tts_BV025.mp3
15相声演员天津方言，适用于泛互场景https://sf1-cdn-tos.huoshanstatic.com/obj/labcv-tob/muse/tts_BV212.mp3
16重庆小伙重庆方言，适用于泛互场景https://sf1-cdn-tos.huoshanstatic.com/obj/labcv-tob/muse/tts_BV019.mp3
17二次元萝莉萝莉童声，适用于通用场景https://sf1-cdn-tos.huoshanstatic.com/obj/labcv-tob/muse/tts_BV064.mp3
18海绵宝宝卡通童声，适用于通用场景https://sf1-cdn-tos.huoshanstatic.com/obj/labcv-tob/muse/tts_BV063.mp3

19

萌娃童声

温柔童声，适用于泛互场景

https://sf1-cdn-tos.huoshanstatic.com/obj/labcv-tob/muse/tts_BV051.mp3

20说书大叔说书京腔，适用于小说场景https://sf1-cdn-tos.huoshanstatic.com/obj/labcv-tob/muse/tts_BV110.mp3
21阳光青年阳光积极，适用于小说场景https://sf1-cdn-tos.huoshanstatic.com/obj/labcv-tob/muse/tts_BV123.mp3
22憨厚青年憨厚老实，适用于小说场景https://sf1-cdn-tos.huoshanstatic.com/obj/labcv-tob/muse/tts_BV120.mp3
23散漫赘婿慵懒男声，适用于小说场景https://sf1-cdn-tos.huoshanstatic.com/obj/labcv-tob/muse/tts_BV119.mp3
24霸气青叔高冷霸气，适用于小说场景https://sf1-cdn-tos.huoshanstatic.com/obj/labcv-tob/muse/tts_BV107.mp3
25质朴青年明朗男声，适用于小说场景https://sf1-cdn-tos.huoshanstatic.com/obj/labcv-tob/muse/tts_BV100.mp3
26儒雅青年稳重男声，适用于小说场景https://sf1-cdn-tos.huoshanstatic.com/obj/labcv-tob/muse/tts_BV102.mp3
27开朗青年男声，适用于小说场景https://sf1-cdn-tos.huoshanstatic.com/obj/labcv-tob/muse/tts_BV004.mp3
28温和少御温柔女声，适用于小说场景https://sf1-cdn-tos.huoshanstatic.com/obj/labcv-tob/muse/tts_BV114.mp3
29平缓少御平缓女声，适用于小说场景https://sf1-cdn-tos.huoshanstatic.com/obj/labcv-tob/muse/tts_BV113.mp3
30甜美女声虚拟人推荐音色https://sf1-cdn-tos.huoshanstatic.com/obj/labcv-tob/muse/tts_BV405.mp3虚拟人音色
32活泼幼教https://sf1-cdn-tos.huoshanstatic.com/obj/labcv-tob/muse/tts_BV057_ParaTaco.mp3虚拟人音色
33活泼女声https://sf1-cdn-tos.huoshanstatic.com/obj/labcv-tob/muse/tts_BV005_ParaTaco.mp3虚拟人音色
34亲切女声https://sf1-cdn-tos.huoshanstatic.com/obj/labcv-tob/muse/tts_BV007_ParaTaco_streaming.mp3虚拟人音色
35知性女声https://sf1-cdn-tos.huoshanstatic.com/obj/labcv-tob/muse/tts_BV009_DPE_ParaTaco_streaming.mp3虚拟人音色

字体

ID字体备注
100001胡晓波男神体
100002卓健橄榄简体
100003站酷****庆科黄油体
100004字体视界法棍体
100005站酷酷黑体
100006优设好身体
100007智勇手书体
100008汉仪贤二体
100009站酷****仓耳渔阳体-W03
100010黄令东齐伋体
100011汉字拼音体
100012杨任东竹石体-Regular
100013站酷****快乐体
100014素材集市康康体
100015站酷****高端黑
100016思源黑体-Regular
100017沐瑶随心手写体
100018站酷****文艺体
100019OPPOSans-R
100020胡晓波真帅体

100021

思源宋体-Regular

TTS槽位重叠选择策略

如果输入要生成tts的槽位之间时间上存在重叠，那么将选出最多个不重叠的槽位来生成tts，具体策略如下：

1、输入n个槽位，包括每个槽位的开始和结束时间
input=[[1,3],[4,6],[5,8],[2,4]]
2、按照槽位结束时间升序排序，结果为
sort=[[1,3],[2,4],[4,6],[5,8]]
3、初始化列表res=[]，遍历sort列表
for i in sort:
    if 区间i的开始时间小于res中最后一个区间的结束时间：
        continue
    else:
        res.append(i)
4、res列表即为最终要生成tts的槽位