# 公共字段 1. ### 请求Host：[https://icp.volcengineapi.com](https://icp.volcengineapi.com) 2. ### 请求Header > 描述：http请求中header需增加的字段 |**参数名** |**参数类型** |**是否必填** |**描述** | |---|---|---|---| |X\-Date |String |是 |使用UTC时间，精确到秒。请使用格式：`YYYYMMDD'T'HHMMSS'Z'` ，例如：`20201103T104027Z` | |Authorization |String |是 |`HMAC-SHA256 Credential={AccessKeyId}/{ShortDate}/{Region}/{Service}/request, SignedHeaders={SignedHeaders}, Signature={Signature}`|\ | | | ||\ | | | |* 签名完整过程详见：[签名示例](https://www.volcengine.com/docs/6369/67269)|\ | | | |* Java版签名Demo详见如下附件|\ | | | | | |Content\-Type |String |是 |MIME类型，**固定值：** **`application/json`** | |X\-Content\-Sha256 |String |否 |对完整请求Body的加密结果，`HexEncode(Hash(RequestPayload))`|\ | | | |> `HexEncode`HexEncode代指转16进制编码|\ | | | |> `Hash`代指SHA256算法|\ | | | |> `RequestPayload`代指完整的请求的body。 | **Authorization中的信息含义：** |**名称** |**类型** |**备注** | |---|---|---| |AccessKeyId |String |请求的AccessKey。|\ | | ||\ | | |* AK/SK获取说明|\ | | | * 说明：在调用火山引擎视觉智能控制台的各个能力之前，确保您已生成访问密钥（AccessKey）。AccessKey包括AccessKeyID（AK）和AccessKeySecret（SK），其中AccessKeyID用于标识用户，AccessKeySecret是用来验证用户的密钥，请妥善保管。|\ | | | * 获取方式：点击右上角账号，下拉列表选择【密钥管理】，点击【新建密钥】按钮，可获取AK/SK，可以此为凭证调用上述已接入应用的接口。|\ | | | 注：安全起见，建议新建子账户，并使用子账户的AK/SK|\ | | ||\ | | |![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_c657b47334954b69c684cbaac0c4cd95.png) | |ShortDate |String |请求的短时间，使用UTC时间，精确到日。请使用格式：YYYYMMDD，例如：20221101 | |Region |String |请求的地域，**固定值：** **`cn-north-1`** | |Service |String |请求的服务，**固定值：** **`iccloud_muse`** | |SignedHeaders |String |参与签名的Header，用分号分隔。 | |Signature |String |计算完毕的签名。 | # 数据结构 1. ### **TemplateTaskDetail** 描述：视频合成任务的结果，包含了此次任务的相关信息 |参数 |类型 |描述 | |---|---|---| |video_key |String |任务唯一标识，用于查询任务和标识任务 | |req_id |String |渲染任务ID，用来排查问题，用户可不关注此字段 | |user_id |String |创建者账户ID | |user_name |String |创建者账户名称 | |title |String |生成视频标题 | |type |String |模板类型|\ | | |"1"、剪同款（字节生产的模板）|\ | | |"2"、剪同款（安装字节插件的AE模板） | |template_id |String |模板ID | |tags |[] |模板标签 | |param_num |Int |视频槽位数量 | |url |String |生成视频播放/下载URL。注：url有效期24小时 | |task_status |Int |任务状态：|\ | | |0:任务完成|\ | | |1:任务进行中|\ | | |2:任务失败|\ | | |3:任务取消 | |progress |Int |任务进度，范围0到100 | |created_at |String |任务创建时间，格式为2020\-01\-02 15:04:05 | |updated_at |String |任务更新时间，格式同上 | |message |String |任务错误信息，用于排查bug，用户不必关注 | 2. ### **MediaInfo** 描述：槽位的字段介绍，同[模板概念以及模板消费API介绍](https://www.volcengine.com/docs/6664/115992) 中的槽位字段介绍 |名称 |类型 |是否可修改 |说明 | |---|---|---|---| |uuid |String |N |只读，槽位的唯一id，用于映射槽位到模板中的节点 | |type |String |N |只读，槽位类型，目前支持video、text、temptext；text指普通文字，temptext为特效文字 | |starttime |Float |N |只读，槽位在最终视频中的开始时间，单位秒 | |endtime |Float |N |只读，槽位在最终视频中的结束时间，单位秒 | |prefix |String |N |只读，text类型槽位中可能会有，渲染时需要，用户不必关注 | |recommend_words |Int |N |只读，支持的TTS字数上限。（默认语速下） | |[source](https://www.volcengine.com/docs/6664/116005?lang=zh#.c291cmNlLeWtl-auteaUr-aMgeeahOe0oOadkOWwgeijheagvOW8j-S4jue8lueggQ==) |String |Y |type为video时，传入的资源路径，http链接。不仅可以传视频链接（只支持mp4）还可以传图片链接。传入的视频时长应不小于clip_end\-clip_start；且文件大小不大于50M | |text（text类型和temptext类型槽位都有这个字段） |String |Y |text类型槽位中的文本内容，文字不超过300个字符 | |^^|Dict |Y |temptext类型槽位中的文本内容，例：{ 0："民宿打卡•像住在城堡里" ， 1："民宿打卡•像住在城堡里" } ，内部key不可修改，value为可修改的文本。每段文字不超过300个字符 | |clip_start |Float |Y |视频裁切起点和终点，单位秒（当source指向视频链接时，链接中的视频会被裁剪后再使用，裁剪起始时间为clip_start，裁剪结束时间为clip_end）|\ | | | |这两个字段可修改，但必须同时修改，保证clip_end与clip_start之差不变 | |clip_end |Float |Y |^^| |volume |Int |Y |素材音量，范围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]。|\ | | | |![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_9c3bb5b927bbbfdf1ff83a71b29ff111.png) | 3. ### TemplateDetail 描述：模板的详细信息 |参数 |类型 |描述 | |---|---|---| |id |String |模板id | |type |String |模板类型|\ | | |"1"、剪同款（字节生产的模板）|\ | | |"2"、剪同款（安装字节插件的AE模板） | |ratio |String |模板比例；例如"16:9" | |title |String |模板名称 | |tags |[]String |模板标签 | |poster_url |String |封面图url | |user_id |String |创建者子账户ID | |description |String |模板描述 | |preview_url |String |模板预览视频url | |team_visibility |Int |0代表非团队可见，1代表团队可见 | |team_space_id |String |团队空间ID | |recommend_words |Int |推荐的TTS字数上限。（默认语速下） | |params |Json String ([] [MediaInfo](https://www.volcengine.com/docs/6664/116005?lang=zh#mediainfo)) |模板的槽位列表 | |level |String |模板等级("S"，"A"，"Unset") | |created_at |String |模板创建时间 | |status |Int |模板状态：|\ | | |1：上传失败|\ | | |2：上传完成|\ | | |3：转码中|\ | | |4：转码完成|\ | | |5：转码失败|\ | | |6：上传中|\ | | |7：封面/预览视频转码中|\ | | |**仅需要校验status=4的即可， 4为成功状态** | |code |Int |拉取模板信息错误类型|\ | | |4050, 模板已下架|\ | | |4051, 该ID对应资源不是模板|\ | | |4052, 该模板团队不可见|\ | | |4053, 该模板不在当前用户空间下 | |message |String |任务错误信息，用于排查bug，用户不必关注 | 注：消费时获取到的模板槽位列表，其中每个槽位的字段都是事先定义好的，使用时不可新增字段或删除字段，也不可新增槽位或删除槽位，只可修改槽位中允许被修改的字段。 4. ### **TtsInfo** 描述：TTS播报的信息 |参数 |类型 |描述 |备注 | |---|---|---|---| |ToneId |Int |音色ID，详见下方[【物料】](https://www.volcengine.com/docs/6664/116005?lang=zh#.54mp5paZ)部分 | | |Text |String |全局播报文本，不超过200字 |这两个参数只能二选一 | |TextList |[]String |槽位播报文本列表，长度等于槽位个数，每项长度不超过200字，对应槽位文本传""，则该槽位不增加TTS。如果tts槽位重叠，选择策略见下方【[TTS槽位重叠选择策略](https://www.volcengine.com/docs/6664/116005?lang=zh#.dHRz5qe95L2N6YeN5Y-g6YCJ5oup562W55Wl)】 |^^| |Speed |Int |TTS播报速度，100为原速度，取值范围（50~200） | | |Pitch |Int |TTS播报音调，100为原音调，取值范围（50~200） | | |Volume |Int |TTS播报音量，100为原音量，取值范围（0~200） | | |BgmVolume |String |视频原BGM音量，100为原音量，取值范围（0~200） | | |FontType |Int |字幕字体ID，支持字体详见下方[【物料】](https://www.volcengine.com/docs/6664/116005?lang=zh#.54mp5paZ)部分，传null不展示字幕，默认null | | |FontSize |Int |字幕字号，默认10 | | |FontColor |String |字幕颜色信息，长度=8，传16进制字符串。例如："FFFFFFFF"，前两位是透明度，FF为不透明，00为全透明，后六位为RGB颜色。默认不透明白色字幕，即"FFFFFFFF"。 | | |MarginV |Int |字幕距离屏幕下方的距离，单位：像素。 | | 注：音色ID可在SaaS平台智能配音功能试听使用，详见本文档下方[【物料】](https://www.volcengine.com/docs/6664/116005?lang=zh#.54mp5paZ)部分。 5. ### Entity 描述媒资归属的实体 |**名称** |**类型** |**必选** |**描述** | |---|---|---|---| |Type |String |是 |类型，取值有：|\ | | | ||\ | | | |* PERSON：个人 | |Id |Integer |否 |Id，当 Type=PERSON，取值为用户 Id | # HTTP接口详情 1. ### DescribeTemplate 描述：根据模板id获取模板的详细信息。 Meghod：POST 请求参数 |参数 |类型 |参数类型 |是否必填 |描述 | |---|---|---|---|---| |Action |String |Query |是 |DescribeTemplate | |Version |String |Query |是 |2021\-09\-01 | |TemplateId |[]String |Body |是 |模板id数组，上限为50 | |Owner |Entity |Body |否 |描述媒资归属的实体 | 请求参数示例： ```json { "TemplateId": ["xxxxxxxxxxx", "yyyyyyyyyyy"], "Owner": { "Id": 123, "Type": "PERSON" } } ``` 返回参数 ```json { "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": '成功' } ``` 2. ### SearchTemplate 描述：搜索模板。在用户模板库中搜索满足条件的模板，支持多条件搜索。如果没有筛选条件（不包括Page、PageSize），则会返回所有模板 Method：POST 请求参数 |参数 |类型 |参数类型 |是否必填 |描述 | |---|---|---|---|---| |Action |String |Query |是 |SearchTemplate | |Version |String |Query |是 |2021\-09\-01 | |Source |Int |Body |否 |模板来源，0代表模板广场模板，1代表租户下的模板，默认0 | |Page |Int |Body |否 |要查询的页数，默认0 | |PageSize |Int |Body |否 |每页的数量，默认10，范围[1，50] | |Title |String |Body |否 |根据模板名称关键字或模板标签关键字筛选。例：输入"美食生活"，后台会先进行分词，得到美食、生活两个词语，模板名称或模板标签中含有美食或生活关键字，则匹配上。 | |Ratio |[]String |Body |否 |根据模板比例筛选，可选 "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 |[]Int |Body |否 |视频槽位数量，格式为 [1，3，4] | |Level |[]String |Body |否 |模板等级，可选["S","A","Unset"]。默认全选 | |Order |Int |Body |否 |排序方式，1正序，\-1倒序，默认：\-1 | |SortBy |String |Body |否 |排序字段，暂只支持"create_time"，默认"create_time" | |UserData |Int |Body |否 |0代表搜索租户下所有模板，1代表只搜索自己上传的模板，默认0 | |TeamSpaceId |String |Body |否 |团队空间ID，默认‘0’，搜索我的空间 | |Owner |Entity |Body |否 |描述媒资归属的实体 | 请求参数示例： ```json { "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" } } ``` 返回参数 ```json { "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": '成功' } ``` 3. ### SearchTemplateTask 描述：搜索模板合成任务。根据给定的条件搜索任务，支持多条件搜索，只能查到自己创建的任务 Method：POST 请求参数 |参数 |类型 |参数类型 |是否必填 |描述 | |---|---|---|---|---| |Action |String |Query |是 |SearchTemplateTask | |Version |String |Query |是 |2021\-09\-01 | |Page |Int |Body |否 |要查询的页数，默认0 | |PageSize |Int |Body |否 |每页的数量，默认10，范围[1，100] | |Title |String |Body |否 |根据视频名称关键字筛选，例：输入"美食"，模板名称中含有美食关键字，则匹配上。 | |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 |[]Int |Body |否 |视频槽位数量，格式为 [1，3，4] | |Tags |[]String |Body |否 |根据模板标签筛选，关键字匹配例：输入["美食，生活"]，模板标签中含有美食或生活关键字，则匹配上。 | |Order |Int |Body |否 |排序方式，1正序，\-1倒序，默认：\-1 | |SortBy |String |Body |否 |排序字段，暂只支持"create_time"，"type"，"task_status"，默认"create_time" | |Owner |Entity |Body |否 |描述媒资归属的实体 | 请求参数示例： ```json { "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" } } ``` 返回参数 ```json { "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": '成功' } ``` 4. ### SubmitTemplateTaskAsync 描述：提交视频合成任务，后续用户可通过DescribeTemplateTask查询合成任务。 Method：POST 请求参数 |参数 |类型 |参数类型 |是否必填 |描述 | |---|---|---|---|---| |Action |String |Query |是 |SubmitTemplateTaskAsync | |Version |String |Query |是 |版本号，2021\-09\-01 | |TemplateId |String |Body |是 |模板id | |TemplateType |String |Body |是 |模板类型|\ | | | | |"1"、剪同款（字节生产的模板）|\ | | | | |"2"、剪同款（安装字节插件的AE模板）|\ | | | | |默认"1" | |ParamsList |[][MediaInfo](https://www.volcengine.com/docs/6664/116005?lang=zh#mediainfo) |Body |是 |填充了资源的槽位列表 | |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模板不支持自定义帧率，依赖模版** | |Tts |[TtsInfo](https://www.volcengine.com/docs/6664/116005?lang=zh#ttsinfo) |Body |否 |音频播报信息 | |CallbackUri |String |Body |否 |公网可访问的http url，需支持POST格式，将以json形式发送，回调格式包含[TemplateTaskDetail](https://www.volcengine.com/docs/6664/116005?lang=zh#templatetaskdetail)和自定义CallbackParams | |CallbackParams |String |Body |否 |回调参数中的业务信息，JSON字符串，将在回调中带回。 | |TeamSpaceId |String |Body |否 |团队空间ID | |Owner |Entity |Body |否 |描述媒资归属的实体 | 请求参数示例： ```json { "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" } } ``` 注：获取到的模板槽位列表，顺序不可打乱，并且每个槽位的字段都是事先定义好的，使用时不可新增字段或删除字段，也不可新增槽位或删除槽位，只可修改槽位中允许被修改的字段。返回参数 ```json { "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": '成功' } ``` 5. ### DescribeTemplateTask 描述：查询模板合成任务的结果，可同时查询多个任务 Method：POST 请求参数 |参数 |类型 |参数类型 |是否必填 |描述 | |---|---|---|---|---| |Action |String |Query |是 |DescribeTemplateTask | |Version |String |Query |是 |2021\-09\-01 | |VideoKeys |[]String |Body |是 |任务id数组，上限为50 | |Owner |Entity |Body |否 |描述媒资归属的实体 | 请求参数示例： ```json { "VideoKeys": ["xxxxxx", "yyyyyyyyy"]， "Owner": { "Id": 123, "Type": "PERSON" } } ``` 返回参数 ```json { "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": '成功' } ``` 6. ### CreateTemplate 描述：上传自制AE模板。 Method：POST 请求参数： |参数 |类型 |参数类型 |是否必填 |描述 | |---|---|---|---|---| |Action |String |Query |是 |CreateTemplate | |Version |String |Query |是 |2021\-09\-01 | |Uri |String |Body |是 |模板url | |Title |String |Body |是 |模板title | |Tags |[]String |Body |否 |模板标签，默认[] | |Description |String |Body |否 |模板描述，默认"" | |TeamVisibility |Bool |Body |否 |是否团队可见，只有主账号有权限填true，默认false | |TeamSpaceId |String |Body |否 |团队空间ID | |Owner |Entity |Body |否 |描述媒资归属的实体 | 请求参数示例： ```json { "Uri": "http://xxxxxx", "Title": "test", "Tags": ["美食", "生活"], "Description": "美好生活", "TeamVisibility": true, "Owner": { "Id": 123, "Type": "PERSON" } } ``` 返回参数 ```json { "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": '成功' } ``` 7. ### DescribeCreateTemplateResult 描述：查询模板上传结果。 Method：GET 请求参数： |参数 |类型 |参数类型 |是否必填 |描述 | |---|---|---|---|---| |Action |String |Query |是 |DescribeCreateTemplateResult | |Version |String |Query |是 |2021\-09\-01 | |TaskKey |String |Query |是 |上传任务key | |OwnerType |String |Query |否 |类型，取值有：|\ | | | | ||\ | | | | |* PERSON：个人 | |OwnerId |Int |Query |否 |Id，当 Type=PERSON，取值为用户 Id | 返回参数 ```json { "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": '成功' } ``` 8. ### UpdateTemplate 描述：更新自制模板。对模板信息进行修改编辑。 Method：POST 请求参数 |参数 |类型 |参数类型 |是否必填 |描述 | |---|---|---|---|---| |Action |String |Query |是 |UpdateTemplate | |Version |String |Query |是 |2021\-09\-01 | |TemplateId |String |Body |是 |模板id | |TemplateDetail |Dict |Body |是 |更新信息，包括title，tags，description，preview_url，poster_url，team_visibility | |Owner |Entity |Body |否 |描述媒资归属的实体 | 请求参数示例： ```json { "TemplateId": "xxxxxx", "Owner": { "Id": 123, "Type": "PERSON" }， "TemplateDetail": { "title": "update", "tags": ["美食", "生活"], "description": "美好生活", "preview_url": "http://xxxxx", "poster_url": "http://xxxxx", "team_visibility": true } } ``` 返回参数 ```json { "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": '成功' } ``` 9. ### DeleteTemplate 描述：删除自制模板。 Method：POST 请求参数 |参数 |类型 |参数类型 |是否必填 |描述 | |---|---|---|---|---| |Action |String |Query |是 |DeleteTemplate | |Version |String |Query |是 |2021\-09\-01 | |TemplateId |[]String |Body |是 |模板Id数组，上限为50 | |Owner |Entity |Body |否 |描述媒资归属的实体 | 请求参数示例： ```json { "TemplateId": ["xxxxxx", "yyyyyyyy"]， "Owner": { "Id": 123, "Type": "PERSON" } } ``` 返回参数 ```json { "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": '成功' } ``` 10. ### CancelTemplateTask 描述：取消模板合成任务，可同时取消多个任务。 Method：POST 请求参数 |参数 |类型 |参数类型 |是否必填 |描述 | |---|---|---|---|---| |Action |String |Query |是 |CancelTemplateTask | |Version |String |Query |是 |2021\-09\-01 | |VideoKeys |[]String |Body |是 |任务id数组，上限为50 | |Owner |Entity |Body |否 |描述媒资归属的实体 | 请求参数示例： ```json { "VideoKeys": ["xxxxxx", "yyyyyyyy"], "Owner": { "Id": 123, "Type": "PERSON" } } ``` 返回参数 ```json { "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": '成功' } ``` 11. ### DelFilm 描述：根据作品ID删除作品，可同时删除多个。 Method：POST 请求参数 |参数 |类型 |参数类型 |是否必填 |描述 | |---|---|---|---|---| |Action |String |Query |是 |DelFilm | |Version |String |Query |是 |2022\-08\-01 | |FilmIdList |[]String |Body |是 |作品id数组，上限为50 | |Owner |Entity |Body |否 |描述媒资归属的实体 | 请求参数示例： ```json { "FilmIdList": ["12345", "56789"], "Owner": { "Id": 123, "Type": "PERSON" } } ``` 返回参数 ```json { "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 |^^| |^^|qtrle |MP4 |^^| |^^|vp8 |MP4 |^^| |^^|vp9 |MP4 |^^| |^^|av1 |MP4 |^^| |^^|gif | |^^| |^^|mpeg4 |MP4 |^^| |^^|rawvideo | |^^| |音频格式 |aac |aac |音频支持封装格式即等于支持编解码 | |^^|aac_latm |aac_latm |^^| |^^|mp3\* |mp3\* |^^| |^^|flac |flac |^^| |^^|pcm\* |pcm\* |^^| |^^|theora | |^^| |^^|vorbis | |^^| |^^|opus |opus |^^| |^^|M4A |M4A |^^| |^^|ALAC(编码) | |^^| |^^|WAV |WAV |^^| |^^|WMA | |^^| |^^|FLAC |FLAC |^^| |图片格式 |png |png |图片支持封装格式即等于支持编解码 | |^^|gif |gif |^^| |^^|jpg/jpeg |jpg/jpeg |^^| |^^|bmp |bmp |^^| |^^|HEIF |HEIF |^^| |^^|HEIC | |^^| |^^|webp |webp |^^| |^^|tiff |tiff |^^| # 错误码描述：对应返回参数中最外层的Code和Message字段 |Code |Message | |---|---| |0 |成功 | |4001 |参数错误（内含具体错误信息） | |4002 |用量超限 | |4003 |无效账户信息 | |4004 |大于最大任务数，试用期间最多同时运行5个任务 | |4005 |请求header信息缺失 | |4006 |任务不存在或已被删除 | |5001 |服务器错误 | ## 特殊情况：网关调用服务出错时，返回参数用户的请求由TOP网关转发给OpenApi，网关错误返回字段结构如下， ```json { "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." } } } ``` 网关错误码说明如下： |

|

|

|

|

|\ |Code

|CodeN

|Message

|备注

|Status

|\ | | | | | | |---|---|---|---|---| |

|

|

|

|

|\ |UndefinedError

|100001

|Undefined Internal Error. Pls Contact With Admin.

|一般不出现这个问题，这是系统开发兜底的错误提示

|500

|\ | | | | | | |

|

|

|

|

|\ |MissingParameter

|100002

|The 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

|\ | | | | | | |

|

|

|

|

|\ |MissingSignature

|100005

|The request is missing signature.

|缺少签名结果

|401

|\ | | | | | | |

|

|

|

|

|\ |InvalidTimestamp

|100006

|The Signature of the request is expired

|请求过期或请求的签名时间来自未来

|403

|\ | | | | | | |

|

|

|

|

|\ |ServiceNotFound

|100007

|This 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

|\ | | | | | | |

|

|

|

|

|\ |AccessDenied

|100013

|User is not authorized to perform: %s on resource: %s

|子用户拥有的权限不支持当前操作

|403

|\ | | | | | | |

|

|

|

|

|\ |InternalError

|100014

|Service has some internal Error. Pls Contact With Admin

|TOP自身内部错误，例如DB error。

|500

|\ | | | | | | |

|

|

|

|

|\ |FailToConnect

|100015

|Top Fail to Connect to Internal Service

|业务服务连接不上，这里的业务一般指具体的imagex、vod。

|502

|\ | | | | | | |

|

|

|

|

|\ |InternalServiceTimeout

|100016

|Internal Service is timeout. Pls Contact With Admin

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

|504

|\ | | | | | | |

|

|

|

|

|\ |InnerApiNeedAccountInfo

|100017

|The inner request should have account info

|Service aksk请求内部服务时缺少了账号信息

|400

|\ | | | | | | |

|

|

|

|

|\ |FlowLimitExceeded

|100018

|Request was rejected because the request speed of this openAPI is beyond the current flow control limit.

|请求过于频繁，超出了基本限速

|429

|\ | | | | | | |

|

|

|

|

|\ |ServiceUnavailableTemp

|100019

|Service is busy, please try again later.

|处于熔断状态的服务暂时不可访问，稍后重试

|503

|\ | | | | | | |

|

|

|

|

|\ |MethodNotAllowed

|100020

|HTTP Method Not Allowed

|Http method不合法

|405

|\ | | | | | | |

|

|

|

|

|\ |LackProjectPolicy

|100021

|Request 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

|\ | | | | | | |

|

|

|

|

|\ |InvalidAuthorization

|100024

|Invalid '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 |**站酷文艺体** | | |100019 |**OPPOSans\-R** | | |100020 |**胡晓波真帅体** | | |100021 |**思源宋体\-Regular** | | # **TTS槽位重叠选择策略** 如果输入要生成tts的槽位之间时间上存在重叠，那么将选出最多个不重叠的槽位来生成tts，具体策略如下： ```python 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的槽位 ```

创作Agent