一、接口介绍
·列举范围:通过 path_prefix 指定目录前缀(可选);不传或传空字符串 "" 时从根目录开始列举。
·递归返回:匹配前缀的范围内递归返回所有节点(文件与目录),不提供"仅列当前层级"的开关,也不提供分页。
·节点区分:返回项以 path 末尾是否带 / 区分——目录以 / 结尾,文件不带;文件项不返回正文,如需读取请用 POST /scenario/read。
二、Method 与 URL
POST https://{服务访问地址}/v2/scenario/list
三、示例 1:列出根目录全部节点
curl -i -k -X POST \\ -H 'Content-Type: application/json' \\ -H 'Authorization: Bearer ******************************' \\ -H "x-tdai-service-id: mem-8i8t****" \\ https://memory.tdai.tencentyun.com/v2/scenario/list \\ -d '{}'
四、示例 2:按前缀过滤
curl -i -k -X POST \\ -H 'Content-Type: application/json' \\ -H 'Authorization: Bearer ******************************' \\ -H "x-tdai-service-id: tdai-mem-8i8t****" \\ https://memory.tdai.tencentyun.com/v2/scenario/list \\ -d '{ "path_prefix": "工作/" }'
注意:说明:
注意:鉴权说明:所有接口都必须在请求头中携带 Authorization: Bearer <API Key> 与 x-tdai-service-id: <Service_ID>,否则将返回鉴权失败。
五、请求参数
| 参数名 | 类型 | 必填 | 默认值 | 描述说明 |
| path_prefix | str | 否 | "" | 路径前缀(虚拟目录过滤)。用于筛选特定目录下的文件。其传值规则如下:按目录筛选:传入特定的路径前缀(如 "documents/2026/"),则只列举该目录下的文件。列举全部:不传此参数、或显式传入空字符串 ""、None,系统将默认从根目录(最顶层)开始列举所有文件。 |
六、响应示例
{ "code": 0, "message": "ok", "request_id": "req-7fd3b2dd", "data": { "entries": [ { "path": "工作/", "created_at": "2026-04-01T08:00:00Z", "updated_at": "2026-04-21T08:30:15Z" }, { "path": "工作/交付物/", "created_at": "2026-04-01T08:00:00Z", "updated_at": "2026-04-21T08:30:15Z" }, { "path": "工作/交付物/2026Q1.md", "created_at": "2026-03-31T18:00:00Z", "updated_at": "2026-04-21T08:30:15Z" } ], "total": 3 }}
| 字段名 | 类型 | 说明 |
| data.entries | List | 列举出的场景记忆条目列表。每项包含以下完整元数据字段:path (str): 场景记忆的完整路径。created_at (str): 该节点的首次创建时间戳(ISO 8601 格式)。updated_at (str): 该节点的最后修改时间戳(ISO 8601 格式)。 |
| data.total | int | 满足前缀过滤条件的条目总数。该值为全量数据计数,不受当前单页请求的截断限制。若当前前缀下没有任何数据,则 entries 返回空数组 [],total 返回 0。 |