EntityCreate - 自定义实体
更新时间：2025-01-13
API访问域名
| 请求方式 | POST |
|---|---|
| base url | https://keyue.cloud.baidu.com |
| 后缀接口 | /open/v1/api/v3/entity/createEntity |
| Authentication | token为API Key |
说明
无
请求参数
Header参数
| 名称 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|
| Content-Type | string | 是 | 内容类型 | 固定值：application/json |
| token | string | 是 | API KEY | 集成-API-API Key处获取。 详细获取方式参考：准备工作 |
| uid | string | 是 | 用户ID | 鼠标移动至页面右上角账户头像即可获取。 详细获取方式参考：准备工作 |
| username | string | 是 | 用户名 | 鼠标移动至页面右上角账户头像即可获取。 详细获取方式参考：准备工作 |
Body参数
| 名称 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|
| nameZh | string | 是 | 实体名称 | |
| refer | string | 是 | 实体类型 | 根据实体类型接口获取Id，自定义实体类型固定值：0 |
响应参数
| 名称 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|
| time | integer | 是 | 时间 | 1717036810964 |
| data | object | 是 | 数据 | 数据对象，详见data子数据 |
| code | integer | 是 | 状态码 | 200 |
| msg | string | 是 | 状态信息 | OK |
data 子数据
| 名称 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|
| id | integer | 是 | 唯一标识 | UUID |
| name | object | 是 | 英文名 | 默认自动生成 |
| nameZh | integer | 是 | 中文名 | |
| entries | list[object] | 是 | 实体值列表 | 详见 entries 子数据 |
entries 子数据
| 名称 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|
| id | string | 是 | 实体值唯一标识 | UUID |
| agentId | string | 是 | agent唯一标识 | UUID |
| entityId | string | 是 | 唯一标识 | UUID |
| value | string | 是 | 实体值 | |
| synonyms | string | 是 | 同义词 | |
| created | Data | 是 | 创建时间 | yyyy-MM-dd HH:mm:ss |
| updated | Data | 是 | 更新时间 | yyyy-MM-dd HH:mm:ss |
| name | string | 是 | 名称 | 英文名，默认自动生成 |
| nameZh | string | 是 | 中文名称 | |
| description | string | 是 | 描述 | |
| refer | string | 是 | 引用 | |
| hasActiveCopy | boolean | 是 | ||
| version | integer | 是 | 版本号 | |
| type | integer | 是 | 类型 | 默认为0 |
| indexExipred | boolean | 是 |
请求示例
Bash
1curl --location --request POST 'https://keyue.cloud.baidu.com/open/v1/api/v3/entity/createEntity' \
2--header 'token: 7f3894e7-01d8-4e2e-88d0-ef437ffd3f63' \
3--header 'uid: dd6283a283df42998bab14607e23f38d' \
4--header 'username: ldd' \
5--data '{"nameZh":"自定义实体","refer":"0"}'