模版消费API

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

2. 请求Header

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

Authorization中的信息含义：

1. TemplateTaskDetail

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

2. MediaInfo

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

3. TemplateDetail

描述：模板的详细信息

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

4. TtsInfo

描述：TTS播报的信息

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

5. Entity

描述媒资归属的实体

1. DescribeTemplate

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

请求参数示例：

{
    "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": '成功'
}

2. SearchTemplate

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

请求参数示例：

{
    "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": '成功'
}

3. SearchTemplateTask

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

请求参数示例：

{
    "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": '成功'
}

4. SubmitTemplateTaskAsync

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

请求参数示例：

{
    "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": '成功'
}

5. DescribeTemplateTask

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

请求参数示例：

{
    "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": '成功'
}

6. CreateTemplate

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

请求参数示例：

{
    "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": '成功'
}

7. DescribeCreateTemplateResult

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

返回参数

{
    "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
请求参数

请求参数示例：

{
    "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": '成功'
}

9. DeleteTemplate

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

请求参数示例：

{
    "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": '成功'
}

10. CancelTemplateTask

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

请求参数示例：

{
    "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": '成功'
}

11. DelFilm

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

请求参数示例：

{
    "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 字段支持的素材封装格式与编码

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

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

用户的请求由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."
        }
    }
}

网关错误码说明如下：

音色

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

字体

如果输入要生成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的槽位