媒资库接口
更新时间：2021-12-21
普通素材
用户上传音频/视频/图片到素材库，创作视频时可从素材中心查询该素材，并导入任务中使用
上传素材
接口描述
用户上传音频/视频/图片到素材库
请求（Request）
- 请求语法：
Http
1POST /v{version}/matlib?upload HTTP/1.1
2x-bce-date: {utc-date-string}
3host: bvw.bj.baidubce.com
4content-type: application/json
5authorization: {bce-authorization-string}- 请求头域：无特殊Header参数
- 请求参数：
| 字段名称 | 字段类型 | 是否必选 | 字段描述 | 参数位置 |
|---|---|---|---|---|
| mediaType | String | 必选 | 媒资类型，video：视频， audio：音频，image：图片 | Requestbody |
| title | String | 必选 | 素材标题，最大长度264字符 | Requestbody |
| bucket | String | 必选 | 素材在BOS中的bucket | Requestbody |
| key | String | 必选 | 素材在BOS中的key | Requestbody |
- 请求示例：
Http
1POST /v1/matlib?upload HTTP/1.1
2x-bce-date: 2019-05-31T09:27:33Z
3host: bvw.bj.baidubce.com
4content-type: application/json
5authorization: bce-auth-v1/c0188830c0c342928f199bbbdac4c227/2019-05-31T09:27:33Z/1800/host/f19dfaf46b9e6b619e9be203650701a2bec9db18a980686ddb3a3a58132558e1
6{
7 "mediaType":"audio",
8 "title":"your-title",
9 "bucket":"your-bucket",
10 "key":"your-key"
11}响应（Response）
- 响应头域：无特殊Header参数
- 响应参数：
| 字段名称 | 字段类型 | 字段描述 |
|---|---|---|
| materialId | String | 素材id |
- 响应示例：
Http
1HTTP/1.1 200 OK
2Transfer-Encoding: chunked
3x-bce-request-id: ca8620b4-0527-4153-b6ed-3a6c0a4da937
4Cache-Control: no-cache
5Server: BWS
6Date: Fri, 31 May 2019 09:27:33 GMT
7Content-Type: application/json;charset=UTF-8
8{
9 "materialId": "c56e3f4718eb202a59da7a9707ccfb63"
10}查询素材
接口描述
查询指定素材
请求（Request）
- 请求语法：
Http
1GET /v{version}/materialLibrary/{id} HTTP/1.1
2x-bce-date: {utc-date-string}
3host: bvw.bj.baidubce.com
4content-type: application/json
5authorization: {bce-authorization-string}- 请求头域：无特殊Header参数
- 请求参数：
| 字段名称 | 字段类型 | 是否必选 | 字段描述 | 参数位置 |
|---|---|---|---|---|
| id | String | 必选 | 要查询的素材id | PathParam |
- 请求示例：
Http
1GET /v1/materialLibrary/e0351bdc1cf9a773a10d7ff9ed237833 HTTP/1.1
2x-bce-date: 2019-05-31T09:27:33Z
3host: bvw.bj.baidubce.com
4content-type: application/json
5authorization: bce-auth-v1/c0188830c0c342928f199bbbdac4c227/2019-05-31T09:27:33Z/1800/host/f19dfaf46b9e6b619e9be203650701a2bec9db18a980686ddb3a3a58132558e1响应（Response）
- 响应头域：无特殊Header参数
- 响应参数：
| 字段名称 | 字段类型 | 字段描述 |
|---|---|---|
| id | string | 素材id |
| userId | string | 用户id |
| infoType | string | 素材分类 |
| mediaType | string | 素材媒资类型 |
| sourceType | string | 来源类型 |
| title | string | 名称 |
| bucket | string | 素材的bucket |
| key | string | 素材的key |
| key360p | string | 素材360p分辨率的key |
| key720p | string | 素材720p分辨率的key |
| audioKey | string | 音频的key |
| thumbnailKeys | list | 截图的key |
| subtitles | list | 字幕的key |
| sourceUrl | string | 素材鉴权url |
| sourceUrl360p | string | 素材360p分辨率的鉴权url |
| audioUrl | string | 素材音频的鉴权url |
| thumbnailList | list | 素材截图鉴权url |
| subtitleUrls | list | 字幕鉴权url |
| duration | double | 素材时长 |
| width | int | 素材宽 |
| height | int | 素材高 |
- 响应示例：
Http
1HTTP/1.1 200 OK
2Transfer-Encoding: chunked
3x-bce-request-id: ca8620b4-0527-4153-b6ed-3a6c0a4da937
4Cache-Control: no-cache
5Server: BWS
6Date: Fri, 31 May 2019 09:27:33 GMT
7Content-Type: application/json;charset=UTF-8
8{
9 "id": "e0351bdc1cf9a773a10d7ff9ed237833",
10 "userId": "your-userid",
11 "infoType": null,
12 "mediaType": "video",
13 "sourceType": "USER",
14 "status": "FINISHED",
15 "title": "your title",
16 "sourceUrl": "XXX",
17 "sourceUrl360p": "XXX",
18 "audioUrl": "XXX",
19 "thumbnailList": [
20 "XXX"
21 ],
22 "subtitleUrls": [],
23 "createTime": "2021-03-30 17:29:12",
24 "updateTime": "2021-03-30 17:29:17",
25 "duration": 3.05,
26 "height": 720,
27 "width": 1280,
28 "thumbnailKeys": [
29 "thumbnail/3s00000000.jpg"
30 ],
31 "subtitles": [
32 ""
33 ],
34 "bucket": "your-bucket",
35 "key": "your-key.mp4",
36 "key360p": "360p/your-key.mp4",
37 "key720p": "720p/your-key.mp4",
38 "audioKey": "audio/your-key.mp3"
39}删除素材
接口描述
删除指定素材
请求（Request）
- 请求语法：
Http
1DELETE /v{version}/materialLibrary/{id} HTTP/1.1
2x-bce-date: {utc-date-string}
3host: bvw.bj.baidubce.com
4content-type: application/json
5authorization: {bce-authorization-string}- 请求头域：无特殊Header参数
- 请求参数：
| 字段名称 | 字段类型 | 是否必选 | 字段描述 | 参数位置 |
|---|---|---|---|---|
| id | String | 必选 | 要删除的素材id | PathParam |
- 请求示例：
Http
1DELETE /v1/materialLibrary/e0351bdc1cf9a773a10d7ff9ed237833 HTTP/1.1
2x-bce-date: 2019-05-31T09:27:33Z
3host: bvw.bj.baidubce.com
4content-type: application/json
5authorization: bce-auth-v1/c0188830c0c342928f199bbbdac4c227/2019-05-31T09:27:33Z/1800/host/f19dfaf46b9e6b619e9be203650701a2bec9db18a980686ddb3a3a58132558e1响应（Response）
- 响应头域：无特殊Header参数
- 响应参数：无
- 响应示例：
Http
1HTTP/1.1 200 OK
2Transfer-Encoding: chunked
3x-bce-request-id: ca8620b4-0527-4153-b6ed-3a6c0a4da937
4Cache-Control: no-cache
5Server: BWS
6Date: Fri, 31 May 2019 09:27:33 GMT
7Content-Type: application/json;charset=UTF-8搜索素材
接口描述
根据素材标题关键字、来源类型等因素搜索素材
请求（Request）
- 请求语法：
Http
1GET /v{version}/materialLibrary HTTP/1.1
2x-bce-date: {utc-date-string}
3host: bvw.bj.baidubce.com
4content-type: application/json
5authorization: {bce-authorization-string}- 请求头域：无特殊Header参数
- 请求参数：
| 字段名称 | 字段类型 | 是否必选 | 字段描述 | 参数位置 |
|---|---|---|---|---|
| titleKeyword | String | 可选 | 标题关键字，可用于模糊匹配 | RequestParam |
| sourceType | String | 可选 | 来源类型，USER：用户上传素材，SERVICE：系统生成素材（包括使用快编生成的结果素材） | RequestParam |
| infoType | String | 可选 | 信息类型，ENTERTAINMENT：娱乐，NEWS：新闻，SPORT：体育，ECONOMIC：财经，TECHNOLOGY：科技，EDUCATION：教育 | RequestParam |
| mediaType | String | 可选 | 媒资类型，video：视频， audio：音频，image：图片 | RequestParam |
| status | String | 可选 | 素材状态，PROCESSING：预处理中，FAILED：失败，FINISHED：完成 | RequestParam |
| pageNo | Integer | 可选 | 页数，默认1 | RequestParam |
| size | Integer | 可选 | 分页大小，默认10，最大100 | RequestParam |
| begin | Date | 可选 | createtime范围的开始时间，格式yyyy-MM-dd'T'HH:mm:ss'Z' | RequestParam |
| end | Date | 可选 | createtime范围的结束时间，格式yyyy-MM-dd'T'HH:mm:ss'Z' | RequestParam |
- 请求示例：
Http
1GET /v1/materialLibrary?mediaType=audio HTTP/1.1
2x-bce-date: 2019-05-31T09:27:33Z
3host: bvw.bj.baidubce.com
4content-type: application/json
5authorization: bce-auth-v1/c0188830c0c342928f199bbbdac4c227/2019-05-31T09:27:33Z/1800/host/f19dfaf46b9e6b619e9be203650701a2bec9db18a980686ddb3a3a58132558e1响应（Response）
- 响应头域：无特殊Header参数
- 响应参数：
| 字段名称 | 字段类型 | 字段描述 |
|---|---|---|
| pageNo | Integer | 页数 |
| pageSize | Integer | 分页大小 |
| totalCount | Integer | 总数 |
| items | List<素材> | 结果列表，素材格式见【查询素材】 |
- 响应示例：
Http
1HTTP/1.1 200 OK
2Transfer-Encoding: chunked
3x-bce-request-id: ca8620b4-0527-4153-b6ed-3a6c0a4da937
4Cache-Control: no-cache
5Server: BWS
6Date: Fri, 31 May 2019 09:27:33 GMT
7Content-Type: application/json;charset=UTF-8
8{
9 "pageNo": 1,
10 "pageSize": 10,
11 "totalCount": 1,
12 "items": [
13 {
14 "id": "3129d94aafedba8f47d67c5a6f08b9d0",
15 "userId": "your-userid",
16 "infoType": null,
17 "mediaType": "audio",
18 "sourceType": "USER",
19 "status": "FINISHED",
20 "title": "your-key.mp3",
21 "sourceUrl": "XXX",
22 "sourceUrl360p": "XXX",
23 "audioUrl": "XXX",
24 "thumbnailList": [],
25 "subtitleUrls": [
26 "XXX"
27 ],
28 "createTime": "2020-10-10 20:06:25",
29 "updateTime": "2020-10-10 20:06:40",
30 "duration": 265,
31 "height": null,
32 "width": null,
33 "thumbnailKeys": [
34 ""
35 ],
36 "subtitles": [
37 "videoworks/console-upload/subtitle/your-key.json"
38 ],
39 "bucket": "your-bucket",
40 "key": "videoworks/console-upload/your-key.mp3",
41 "audioKey": "videoworks/console-upload/audio/your-key.mp3"
42 }
43 ]
44}预置素材
预置素材分为音乐/贴图/背景/字幕/转场，除了系统自带的预置素材外，用户可以自定义音乐/贴图预置素材。创作视频时，不需要导入，可直接使用。除了用户自己上传以外，系统提供公用的系统预置素材，可查看使用，不可删除。
上传用户预置素材
接口描述
上传一个音乐/贴图预置素材到媒资库
请求（Request）
- 请求语法：
Http
1POST /v{version}/materialLibrary/preset/{type}?upload HTTP/1.1
2x-bce-date: {utc-date-string}
3host: bvw.bj.baidubce.com
4content-type: application/json
5authorization: {bce-authorization-string}- 请求头域：无特殊Header参数
- 请求参数：
| 字段名称 | 字段类型 | 是否必选 | 字段描述 | 参数位置 |
|---|---|---|---|---|
| type | String | 必选 | 预置素材类型，只支持2种类型自定义：MUSIC：音乐，PICTURE：贴图 | PathParam |
| mediaType | String | 必选 | 媒资类型：video:视频， audio：音频，image：图片 | Requestbody |
| title | String | 必选 | 素材标题，最大长度264字符 | Requestbody |
| bucket | String | 必选 | 素材在BOS中的bucket | Requestbody |
| key | String | 必选 | 素材在BOS中的key | Requestbody |
- 请求示例：
Http
1POST /v1/materialLibrary/preset/MUSIC?upload HTTP/1.1
2x-bce-date: 2019-05-31T09:27:33Z
3host: bvw.bj.baidubce.com
4content-type: application/json
5authorization: bce-auth-v1/c0188830c0c342928f199bbbdac4c227/2019-05-31T09:27:33Z/1800/host/f19dfaf46b9e6b619e9be203650701a2bec9db18a980686ddb3a3a58132558e1
6{
7 "mediaType":"audio",
8 "title":"your-title",
9 "bucket":"your-bucket",
10 "key":"your-key"
11}响应（Response）
- 响应头域：无特殊Header参数
- 响应参数：
| 字段名称 | 字段类型 | 字段描述 |
|---|---|---|
| id | String | 预置素材id |
- 响应示例：
Http
1HTTP/1.1 200 OK
2Transfer-Encoding: chunked
3x-bce-request-id: ca8620b4-0527-4153-b6ed-3a6c0a4da937
4Cache-Control: no-cache
5Server: BWS
6Date: Fri, 31 May 2019 09:27:33 GMT
7Content-Type: application/json;charset=UTF-8
8{
9 "id": "c56e3f4718eb202a59da7a9707ccfb63"
10}查询预置素材
接口描述
查询指定预置素材，可查询范围包括用户自己的和系统的预置素材
请求（Request）
- 请求语法：
Http
1GET /v{version}/materialLibrary/preset/{id} HTTP/1.1
2x-bce-date: {utc-date-string}
3host: bvw.bj.baidubce.com
4content-type: application/json
5authorization: {bce-authorization-string}- 请求头域：无特殊Header参数
- 请求参数：
| 字段名称 | 字段类型 | 是否必选 | 字段描述 | 参数位置 |
|---|---|---|---|---|
| id | String | 必选 | 要查询的预置素材id | PathParam |
- 请求示例：
Http
1GET /v1/materialLibrary/preset/2437134a1e5ed58463d91854da5a3c36 HTTP/1.1
2x-bce-date: 2019-05-31T09:27:33Z
3host: bvw.bj.baidubce.com
4content-type: application/json
5authorization: bce-auth-v1/c0188830c0c342928f199bbbdac4c227/2019-05-31T09:27:33Z/1800/host/f19dfaf46b9e6b619e9be203650701a2bec9db18a980686ddb3a3a58132558e1响应（Response）
- 响应头域：无特殊Header参数
- 响应参数：
| 字段名称 | 字段类型 | 字段描述 |
|---|---|---|
| id | string | 素材id |
| status | string | 素材状态 |
| userId | string | 用户id |
| title | string | 名称 |
| tag | string | 预置素材标签 |
| type | string | 预置素材类型 |
| sourceType | string | 来源类型 |
| previewBucket | Map<String,String> | 素材预览bucket，key包括pic（静态预览文件），gif（动态预览文件） |
| previewKeys | Map<String,String> | 素材预览keys |
| previewMaterialIds | Map<String,String> | 素材预览素材 |
| materialId | String | 素材id |
| bucket | String | 素材bucket |
| key | String | 素材key |
| config | String | 素材配置 |
| sourceUrl | String | 素材url |
| createTime | Date | 创建时间 |
| updateTime | Date | 上次更新时间 |
- 响应示例：
Http
1HTTP/1.1 200 OK
2Transfer-Encoding: chunked
3x-bce-request-id: ca8620b4-0527-4153-b6ed-3a6c0a4da937
4Cache-Control: no-cache
5Server: BWS
6Date: Fri, 31 May 2019 09:27:33 GMT
7Content-Type: application/json;charset=UTF-8
8{
9 "id": "2437134a1e5ed58463d91854da5a3c36",
10 "status": "FINISHED",
11 "userId": "885afd0dbd8c42719729da4a0fc0aaf6",
12 "title": "马赛克",
13 "tag": "mosaic",
14 "type": "PICTURE",
15 "sourceType": "SYSTEM",
16 "previewMaterialIds": {
17 "pic": "8a9c6d28fc26cf3865ceb055ddc029f0"
18 },
19 "previewBucket": {
20 "pic": "videoworks-system-preprocess"
21 },
22 "previewKeys": {
23 "pic": "systemPreset/picture/马赛克.png"
24 },
25 "previewUrls": {
26 "pic": "XXX"
27 },
28 "materialId": "8a9c6d28fc26cf3865ceb055ddc029f0",
29 "bucket": "videoworks-system-preprocess",
30 "key": "systemPreset/picture/马赛克.png",
31 "config": "{\"category\": \"mosaic\", \"categoryText\": \"马赛克\", \"width\": 215, \"height\": 124}",
32 "createTime": "2021-05-31 15:02:43",
33 "updateTime": "2021-05-31 15:02:43",
34 "sourceUrl": "XXX"
35}删除预置素材
接口描述
删除指定用户上传的预置素材
请求（Request）
- 请求语法：
Http
1DELETE /v{version}/materialLibrary/preset/{id} HTTP/1.1
2x-bce-date: {utc-date-string}
3host: bvw.bj.baidubce.com
4content-type: application/json
5authorization: {bce-authorization-string}- 请求头域：无特殊Header参数
- 请求参数：
| 字段名称 | 字段类型 | 是否必选 | 字段描述 | 参数位置 |
|---|---|---|---|---|
| id | String | 必选 | 要删除的预置素材id | PathParam |
- 请求示例：
Http
1DELETE /v1/materialLibrary/preset/9abd185e67b1c5952e9b6335769c3406 HTTP/1.1
2x-bce-date: 2019-05-31T09:27:33Z
3host: bvw.bj.baidubce.com
4content-type: application/json
5authorization: bce-auth-v1/c0188830c0c342928f199bbbdac4c227/2019-05-31T09:27:33Z/1800/host/f19dfaf46b9e6b619e9be203650701a2bec9db18a980686ddb3a3a58132558e1响应（Response）
- 响应头域：无特殊Header参数
- 响应参数：无
- 响应示例：
Http
1HTTP/1.1 200 OK
2Transfer-Encoding: chunked
3x-bce-request-id: ca8620b4-0527-4153-b6ed-3a6c0a4da937
4Cache-Control: no-cache
5Server: BWS
6Date: Fri, 31 May 2019 09:27:33 GMT
7Content-Type: application/json;charset=UTF-8搜索预置素材
接口描述
根据来源类型、预置素材分类以及状态等因素获取符合条件的预置素材列表
请求（Request）
- 请求语法：
Http
1GET /v{version}/materialLibrary/preset HTTP/1.1
2x-bce-date: {utc-date-string}
3host: bvw.bj.baidubce.com
4content-type: application/json
5authorization: {bce-authorization-string}- 请求头域：无特殊Header参数
- 请求参数：
| 字段名称 | 字段类型 | 是否必选 | 字段描述 | 参数位置 |
|---|---|---|---|---|
| sourceType | String | 可选 | 来源类型，USER：用户上传的预置素材，SYSTEM：系统预置素材 | RequestParam |
| status | String | 可选 | 素材状态，PROCESSING：预处理中，FAILED：失败，FINISHED：完成 | RequestParam |
| type | String | 可选 | 预置素材类型，SUBTITLE：字幕，MUSIC：音乐，PICTURE：贴图，TRANSITION：转场，BACKGROUND：背景 | RequestParam |
| pageNo | Integer | 可选 | 页数，默认1 | RequestParam |
| pageSize | Integer | 可选 | 分页大小，默认10，最大100 | RequestParam |
- 请求示例：
Http
1GET /v1/materialLibrary/preset?type=PICTURE&sourceType=USER HTTP/1.1
2x-bce-date: 2019-05-31T09:27:33Z
3host: bvw.bj.baidubce.com
4content-type: application/json
5authorization: bce-auth-v1/c0188830c0c342928f199bbbdac4c227/2019-05-31T09:27:33Z/1800/host/f19dfaf46b9e6b619e9be203650701a2bec9db18a980686ddb3a3a58132558e1响应（Response）
- 响应头域：无特殊Header参数
- 响应参数：
| 字段名称 | 字段类型 | 字段描述 |
|---|---|---|
| pageNo | Integer | 页数 |
| pageSize | Integer | 分页大小 |
| totalCount | Integer | 总数 |
| result | List | 结果 |
| +type | String | 预置素材类型 |
| +addons | List<预置素材> | 预置素材格式见【查询预置素材】 |
- 响应示例：
Http
1HTTP/1.1 200 OK
2Transfer-Encoding: chunked
3x-bce-request-id: ca8620b4-0527-4153-b6ed-3a6c0a4da937
4Cache-Control: no-cache
5Server: BWS
6Date: Fri, 31 May 2019 09:27:33 GMT
7Content-Type: application/json;charset=UTF-8
8{
9 "pageNo": 1,
10 "pageSize": 10,
11 "totalCount": 1,
12 "result": [
13 {
14 "type": "PICTURE",
15 "addons": [
16 {
17 "id": "9abd185e67b1c5952e9b6335769c3406",
18 "status": "FINISHED",
19 "userId": "your-userid",
20 "title": "your-title",
21 "tag": "custom",
22 "type": "PICTURE",
23 "sourceType": "USER",
24 "previewMaterialIds": {
25 "pic": "fc6b2c83a03a5a0e40ab7e137be0ce23"
26 },
27 "previewBucket": {
28 "pic": "your-bucket"
29 },
30 "previewKeys": {
31 "pic": "source/your-key.png"
32 },
33 "previewUrls": {
34 "pic": "XXX"
35 },
36 "materialId": "fc6b2c83a03a5a0e40ab7e137be0ce23",
37 "bucket": "your-bucket",
38 "key": "source/your-key.png",
39 "config": "{\"width\":\"356\",\"category\":\"custom\",\"categoryText\":\"自定义\",\"height\":\"466\"}",
40 "createTime": "2021-05-27 17:07:26",
41 "updateTime": "2021-05-27 17:08:55",
42 "sourceUrl": "XXX"
43 }
44 ]
45 }
46 ]
47}