接口介绍
Metadata 用户管理接口用于创建、查询、删除和列出 Memory 实例下的用户账号。共4个接口:
接口 | 方法 | 功能 |
/v3/user/create | POST | 创建用户 |
/v3/user/get | POST | 获取用户信息 |
/v3/user/delete | POST | 批量删除用户 |
/v3/user/list | POST | 列出用户 |
创建用户
创建一个新用户,指定用户名和所属团队。
POST /v3/user/create
请求参数
字段 | 类型 | 必选 | 说明 |
username | string | 是 | 用户名 |
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/user/create \\-d '{"username":"alice","team_id":"team-abc"}'
响应示例
{"code":0,"message":"ok","request_id":"req-7fd3b2dd","data":{"user_id":"user-123","username":"alice","team_id":"team-abc","created_at_ms":1758096000000}}
响应 data
字段 | 类型 | 说明 |
user_id | string | 新创建的用户唯一标识 ID |
username | string | 用户名 |
team_id | string | 所属团队 ID |
created_at_ms | int | 创建时间,Unix 时间戳(毫秒) |
获取用户信息
按用户 ID 或过滤条件查询单个用户的详细信息。
POST /v3/user/get
请求参数
字段 | 类型 | 必选 | 说明 |
user_id | string | 条件必填 | 用户 ID,与 filter 二选一 |
filter | object | 条件必填 | 过滤条件,含 username、team_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/user/get \\-d '{"user_id":"user-123"}'
响应示例
{"code":0,"message":"ok","request_id":"req-7fd3b2dd","data":{"user_id":"user-123","username":"alice","team_id":"team-abc","created_at_ms":1758096000000,"updated_at_ms":1758182400000}}
响应 data
字段 | 类型 | 说明 |
user_id | string | 用户唯一标识 ID |
username | string | 用户名 |
team_id | string | 所属团队 ID |
created_at_ms | int | 创建时间 |
updated_at_ms | int | 最后更新时间 |
批量删除用户
批量删除指定用户,操作不可恢复。
POST /v3/user/delete
请求参数
字段 | 类型 | 必选 | 说明 |
user_ids | 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/user/delete \\-d '{"user_ids":["user-123","user-456"]}'
响应示例
{"code":0,"message":"ok","request_id":"req-7fd3b2dd","data":{"deleted_count":2}}
响应 data
字段 | 类型 | 说明 |
deleted_count | int | 已成功删除的用户数 |
列出用户
按团队或条件分页查询用户列表。
POST /v3/user/list
请求参数
字段 | 类型 | 必选 | 说明 |
team_id | string | 否 | 按团队 ID 筛选 |
limit | int | 否 | 每页返回数量 |
offset | int | 否 | 分页偏移量,从0开始 |
请求示例
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/user/list \\-d '{"team_id":"team-abc","limit":20,"offset":0}'
响应示例
{"code":0,"message":"ok","request_id":"req-7fd3b2dd","data":{"items":[{"user_id":"user-123","username":"alice","team_id":"team-abc","created_at_ms":1758096000000},{"user_id":"user-456","username":"bob","team_id":"team-abc","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 | USER_NOT_FOUND | 指定用户不存在。 |
409 | USER_ALREADY_EXISTS | 用户名在同一团队下已存在。 |
500 | Internal error | 服务内部错误,可有限重试。 |