主体
更新时间:2026-02-13
本接口用于主体相关接口,包括:
- 创建自定义主体
- 查询自定义主体
- 修改自定义主体
- 查询预设主体
创建自定义主体
请求结构
Http
1POST /v2/subject/custom/{manu} HTTP/1.1
2connection: keep-alive
3host: vod.bj.baidubce.com
4content-type: application/json
5x-bce-request-id: <bce-request-id>
6x-bce-date: <utc-date-string>
7authorization: <bce-authorization-string>
请求头域
除公共头域外,无其它特殊头域。
请求参数
传参 elementImageList,elementVideoList 有且仅需有一个
| 参数 | 类型 | 是否必填 | 参数位置 | 描述 |
|---|---|---|---|---|
| manu | string | 是 | Path参数 | 厂商编号,枚举值: |
| elementName | string | 是 | Body参数 | 主体名称。 |
| elementImageList | List<ImageItem> | 否 | Body参数 | 图片主体列表,与视频主体列表互斥。 |
| elementVideoList | List<AIGCVideoItem> | 否 | Body参数 | 视频主体列表,与视频主体列表互斥。仅支持 videoUrl 方式传入。 |
| voiceId | string | 否 | Body参数 | 主体音色Id,该信息仅在创建音视频直出任务时使用 |
返回头域
除公共头域,无其它特殊头域。
返回参数
| 参数 | 类型 | 描述 |
|---|---|---|
| elementId | string | 本次生成的主体id |
| elementName | string | 本次生成自定义的主体名称 |
| elementImageList | List<ImageItem> | 图片主体列表 |
| elementVideoList | List<AIGCVideoItem> | 视频主体列表 |
| elementDescription | String | 本次生成的主体描述 |
| voiceId | List | 本次生成主体绑定的音色id |
| style | String | 本次生成的主体风格信息 |
| code | String | 错误码,异常时返回 |
| subjectId | String | 主体返回标识,异常时返回 |
| message | String | 错误信息,异常时返回 |
请求示例
请求内容
Http
1POST /v2/subject/custom/V HTTP/1.1
2host: vod.bj.baidubce.com
3accept: */*
4connection: keep-alive
5content-type: application/json
6x-bce-request-id: 6bae5cb3-97d1-4b1a-b8b6-0ad577c1d481
7x-bce-date: 2024-03-24T13:08:44Z
8authorization: bce-auth-v1/46bd9968a6194b4bbdf0341f2286ccce/2024-03-24T13:08:44Z/1800/host;x-bce-date/7e21c9cf1e4e2cc6921a407a388fe98df122c53b9f509043d841be76eb09a1f9
9
10{
11 "elementName": "一只小猫",
12 "elementImageList": [
13 "https://example.com/example1.jpg",
14 "https://example.com/example2.jpg"
15 ]
16}
返回示例
JSON
1{
2 "elementId": "1234567890",
3 "elementName": "一只小猫",
4 "elementDescription": "一只可爱的折耳猫",
5 "elementImageList": [
6 "https://example.com/example1.jpg",
7 "https://example.com/example2.jpg"
8 ],
9 "elementVideoList": [],
10 "voiceId": "",
11 "style": "写实"
12}
查询自定义主体
请求结构
Http
1GET /v2/subject/custom/{manu} HTTP/1.1
2connection: keep-alive
3host: vod.bj.baidubce.com
4content-type: application/json
5x-bce-request-id: <bce-request-id>
6x-bce-date: <utc-date-string>
7authorization: <bce-authorization-string>
8{
9 "count":10,
10 "nextPageToken":""
11}
请求头域
除公共头域外,无其它特殊头域。
请求参数
传参 count,elementIdList 有且仅需有一个
| 参数 | 类型 | 是否必填 | 参数位置 | 描述 |
|---|---|---|---|---|
| manu | string | 是 | Path参数 | 厂商编号,枚举值: |
| count | int | 否 | Body参数 | 指定数量查询,默认20条,最多100条。与elementIdList互斥。 |
| elementIdList | list |
否 | Body参数 | 指定主体id查询,可以查询多个。与count互斥。 |
| nextPageToken | string | 否 | Body参数 | 第一次nextPageToken可以不传为空,如果有多页,则会返回nextPageToken,下一页用 nextPageToken 来请求 |
返回头域
除公共头域,无其它特殊头域。
返回参数
| 参数 | 类型 | 描述 |
|---|---|---|
| count | int | 查询数量 |
| subjects | object | 本次查询的主体信息 |
| [+]elementId | String | 主体id |
| [+]elementName | String | 主体名称 |
| [+]elementDescription | String | 主体的详细描述信息 |
| [+]elementImageList | List | 主体的图像参数 |
| [+][+]imageUrl | String | 图片url |
| [+]elementVideoList | List | 图片的视频参数 |
| [+][+]videoUrl | String | 视频url |
| [+]voiceId | String | 主体绑定的音色id |
| [+]style | String | 主体的风格信息 |
| nextPageToken | String | 分页标识 |
| code | String | 错误码,异常时返回 |
| subjectId | String | 主体返回标识,异常时返回 |
| message | String | 错误信息,异常时返回 |
请求示例
请求内容
Http
1GET /v2/subject/custom/V HTTP/1.1
2host: vod.bj.baidubce.com
3accept: */*
4connection: keep-alive
5content-type: application/json
6x-bce-request-id: 6bae5cb3-97d1-4b1a-b8b6-0ad577c1d481
7x-bce-date: 2024-03-24T13:08:44Z
8authorization: bce-auth-v1/46bd9968a6194b4bbdf0341f2286ccce/2024-03-24T13:08:44Z/1800/host;x-bce-date/7e21c9cf1e4e2cc6921a407a388fe98df122c53b9f509043d841be76eb09a1f9
9
10{
11 "count":10,
12 "nextPageToken":""
13}
返回示例
JSON
1{
2 "message": "SUCCESS",
3 "count": 1,
4 "subjects": [
5 {
6 "elementId": "1234567890",
7 "elementName": "卡通人物",
8 "elementDescription": "卡通人物的详细描述",
9 "elementImageList": [
10 {
11 "imageUrl": "https://example.com/example1.jpg"
12 },
13 {
14 "imageUrl": "https://example.com/example2.jpg"
15 }
16 ],
17 "elementVideoList": [],
18 "voiceId": "",
19 "style": ""
20 }
21 ]
22}
编辑自定义主体
请求结构
Http
1PUT /v2/subject/custom/{manu} HTTP/1.1
2connection: keep-alive
3host: vod.bj.baidubce.com
4content-type: application/json
5x-bce-request-id: <bce-request-id>
6x-bce-date: <utc-date-string>
7authorization: <bce-authorization-string>
8{
9 "elementId":"1234567890",
10 "elementName": "新的主体名称",
11 "elementDescription":"新的主体描述",
12 "voiceId":"新的音色",
13 "style":"新的主体风格"
14}
请求头域
除公共头域外,无其它特殊头域。
请求参数
| 参数 | 类型 | 是否必填 | 参数位置 | 描述 |
|---|---|---|---|---|
| manu | string | 是 | Path参数 | 厂商编号,枚举值: |
| elementId | string | 否 | Body参数 | 编辑的主体id |
| elementName | string | 否 | Body参数 | 新的主体名称,64字符 |
| elementDescription | string | 否 | Body参数 | 新的主体风格描述,100字符 |
| voiceId | string | 否 | Body参数 | 新的主体的详细描述信息,2000字符 |
| style | string | 否 | Body参数 | 新的主体音色Id |
返回头域
除公共头域,无其它特殊头域。
返回参数
| 参数 | 类型 | 说明 |
|---|---|---|
| elementId | String | 主体id |
| elementName | String | 新的主体名称 |
| elementDescription | String | 新的主体的详细描述信息 |
| style | String | 新的主体风格描述 |
| voiceId | String | 新的主体音色Id |
请求示例
请求内容
Http
1PUT /v2/subject/custom/V HTTP/1.1
2host: vod.bj.baidubce.com
3accept: */*
4connection: keep-alive
5content-type: application/json
6x-bce-request-id: 6bae5cb3-97d1-4b1a-b8b6-0ad577c1d481
7x-bce-date: 2024-03-24T13:08:44Z
8authorization: bce-auth-v1/46bd9968a6194b4bbdf0341f2286ccce/2024-03-24T13:08:44Z/1800/host;x-bce-date/7e21c9cf1e4e2cc6921a407a388fe98df122c53b9f509043d841be76eb09a1f9
9
10{
11 "elementId":"1234567890",
12 "elementName": "一只折耳猫",
13 "elementDescription":"一只折耳猫的写实图片"
14}
返回示例
JSON
1{
2 "elementId":"1234567890",
3 "elementName": "一只折耳猫",
4 "elementDescription":"一只折耳猫的写实图片",
5 "voiceId": "",
6 "style": ""
7}
查询预设主体
请求结构
Http
1GET /v2/subject/preset/{manu}?{请求参数} HTTP/1.1
2connection: keep-alive
3host: vod.bj.baidubce.com
4content-type: application/json
5x-bce-request-id: <bce-request-id>
6x-bce-date: <utc-date-string>
7authorization: <bce-authorization-string>
请求头域
除公共头域外,无其它特殊头域。
请求参数
| 参数 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| manu | string | 是 | Path参数 | 厂商编号,枚举值: |
| pageNum | int | 否 | Query参数 | 页码,默认1。取值范围:[1,1000] |
| pageSize | int | 否 | Query参数 | 每页数据量,默认30。取值范围:[1,500] |
返回头域
除公共头域,无其它特殊头域。
请求示例
请求内容
Http
1GET /v2/subject/preset/K?pageNum=1&pageSize=1 HTTP/1.1
2host: vod.bj.baidubce.com
3accept: */*
4connection: keep-alive
5content-type: application/json
6x-bce-request-id: 6bae5cb3-97d1-4b1a-b8b6-0ad577c1d481
7x-bce-date: 2024-03-24T13:08:44Z
8authorization: bce-auth-v1/46bd9968a6194b4bbdf0341f2286ccce/2024-03-24T13:08:44Z/1800/host;x-bce-date/7e21c9cf1e4e2cc6921a407a388fe98df122c53b9f509043d841be76eb09a1f9
返回示例
JSON
1{
2 "message": "SUCCEED",
3 "data": [
4 {
5 "elementId": "171",
6 "elementName": "天台",
7 "elementDescription": "天台",
8 "elementFrontImage": "https://example.com/example1.png",
9 "elementReferList": [
10 {
11 "imageUrl": "https://example.com/example2.png"
12 }
13 ]
14 }
15 ]
16}
