接口介绍
Metadata 知识库管理接口用于创建、查询、更新、删除和列出知识库资源。知识库用于组织和管理 Agent 可引用的结构化知识内容。共5个接口:
接口 | 方法 | 功能 |
/v3/knowledge/create | POST | 创建知识库 |
/v3/knowledge/get | POST | 获取知识库 |
/v3/knowledge/update | POST | 更新知识库 |
/v3/knowledge/delete | POST | 删除知识库 |
/v3/knowledge/list | POST | 列出知识库 |
创建知识库
创建一个新知识库。
POST /v3/knowledge/create
请求参数
字段 | 类型 | 必选 | 说明 |
name | string | 是 | 知识库名称 |
team_id | string | 否 | 所属团队 ID |
description | string | 否 | 知识库描述 |
metadata | object | 否 | 自定义元数据 |
请求示例
curl -i -X POST \\-H 'Content-Type: application/json' \\-H 'Authorization: Bearer *********************************' \\-H "x-tdai-service-id: tdai-mem-xxxxxxxx" \\https://memory.tdai.tencentyun.com/v3/knowledge/create \\-d '{"name":"产品知识库","team_id":"team-abc","description":"产品文档和FAQ"}'
响应示例
{"code":0,"message":"ok","request_id":"req-7fd3b2dd","data":{"knowledge_id":"kb-abc123","name":"产品知识库","created_at_ms":1758096000000}}
响应 data
字段 | 类型 | 说明 |
knowledge_id | string | 新创建的知识库唯一标识 ID |
name | string | 知识库名称 |
created_at_ms | int | 创建时间 |
获取知识库
按知识库 ID 查询详细信息。
POST /v3/knowledge/get
请求参数
字段 | 类型 | 必选 | 说明 |
knowledge_id | string | 是 | 知识库 ID |
team_id | string | 否 | 团队 ID(用于归属校验) |
请求示例
curl -i -X POST \\-H 'Content-Type: application/json' \\-H 'Authorization: Bearer *********************************' \\-H "x-tdai-service-id: tdai-mem-xxxxxxxx" \\https://memory.tdai.tencentyun.com/v3/knowledge/get \\-d '{"knowledge_id":"kb-abc123"}'
响应示例
{"code":0,"message":"ok","request_id":"req-7fd3b2dd","data":{"knowledge_id":"kb-abc123","name":"产品知识库","team_id":"team-abc","description":"产品文档和FAQ","created_at_ms":1758096000000,"updated_at_ms":1758182400000}}
响应 data
字段 | 类型 | 说明 |
knowledge_id | string | 知识库 ID |
name | string | 知识库名称 |
team_id | string | 所属团队 ID |
description | string | 知识库描述 |
created_at_ms | int | 创建时间 |
updated_at_ms | int | 最后更新时间 |
更新知识库
更新知识库属性。
POST /v3/knowledge/update
请求参数
字段 | 类型 | 必选 | 说明 |
knowledge_id | string | 是 | 知识库 ID |
name | string | 否 | 更新后的名称 |
description | string | 否 | 更新后的描述 |
metadata | object | 否 | 更新后的元数据 |
请求示例
curl -i -X POST \\-H 'Content-Type: application/json' \\-H 'Authorization: Bearer *********************************' \\-H "x-tdai-service-id: tdai-mem-xxxxxxxx" \\https://memory.tdai.tencentyun.com/v3/knowledge/update \\-d '{"knowledge_id":"kb-abc123","description":"更新后的描述"}'
响应示例
{"code":0,"message":"ok","request_id":"req-7fd3b2dd","data":{"knowledge_id":"kb-abc123","updated_at_ms":1758268800000}}
响应 data
字段 | 类型 | 说明 |
knowledge_id | string | 已更新的知识库 ID |
updated_at_ms | int | 最后更新时间 |
删除知识库
批量删除知识库。
POST /v3/knowledge/delete
请求参数
字段 | 类型 | 必选 | 说明 |
knowledge_ids | string[] | 是 | 待删除的知识库 ID 列表 |
team_id | string | 否 | 团队 ID(用于归属校验) |
请求示例
curl -i -X POST \\-H 'Content-Type: application/json' \\-H 'Authorization: Bearer *********************************' \\-H "x-tdai-service-id: tdai-mem-xxxxxxxx" \\https://memory.tdai.tencentyun.com/v3/knowledge/delete \\-d '{"knowledge_ids":["kb-abc123"]}'
响应示例
{"code":0,"message":"ok","request_id":"req-7fd3b2dd","data":{"deleted":true}}
响应 data
字段 | 类型 | 说明 |
deleted | bool | 删除是否成功 |
列出知识库
按条件列表查询知识库。
POST /v3/knowledge/list
请求参数
字段 | 类型 | 必选 | 说明 |
team_id | string | 否 | 按团队 ID 筛选 |
limit | int | 否 | 每页返回数量 |
offset | int | 否 | 分页偏移量 |
请求示例
curl -i -X POST \\-H 'Content-Type: application/json' \\-H 'Authorization: Bearer *********************************' \\-H "x-tdai-service-id: tdai-mem-xxxxxxxx" \\https://memory.tdai.tencentyun.com/v3/knowledge/list \\-d '{"team_id":"team-abc"}'
响应示例
{"code":0,"message":"ok","request_id":"req-7fd3b2dd","data":{"items":[{"knowledge_id":"kb-abc123","name":"产品知识库","team_id":"team-abc","description":"产品文档和FAQ","created_at_ms":1758096000000},{"knowledge_id":"kb-def456","name":"技术文档库","team_id":"team-abc","description":"内部技术文档","created_at_ms":1758182400000}],"total":2}}
响应 data
字段 | 类型 | 说明 |
items | array | 知识库列表 |
total | int | 符合条件的知识库总数 |
错误码
HTTP 状态码 | 错误信息 | 说明 |
400 | request: Invalid input | 请求参数不合法。 |
401 | Missing or invalid Authorization header | Bearer API Key 缺失或格式不正确。 |
| Missing x-tdai-service-id header | 请求头中未携带 x-tdai-service-id。 |
404 | KNOWLEDGE_NOT_FOUND | 指定知识库不存在。 |
409 | KNOWLEDGE_NAME_ALREADY_EXISTS | 知识库名称已存在。 |
500 | Internal error | 服务内部错误,可有限重试。 |