帮你快速理解、总结文档立即下载

列出场景文件

最近更新时间:2026-07-28 10:20:01

我的收藏

接口介绍

本接口(/v3/scenario/ls)用于列出指定场景路径下的所有场景(Scenario)文件。功能说明如下:
组织模型:场景记忆是 L2 层的结构化记忆,以文件系统模型组织。
列出范围:通过 path_prefix 指定目录范围,返回其下所有文件与子目录的列表。
说明:
路径约定path_prefix 采用相对路径格式,建议统一写成 work/... 而不带开头的 /,避免不同存储后端得到不同结果;path_prefix 为空或不传表示列出根目录下的所有场景文件。

Method 与 URL

POST https://memory.tdai.tencentyun.com/v3/scenario/ls

使用示例

curl -i -k -X POST \\
-H 'Content-Type: application/json' \\
-H 'Authorization: Bearer *********************************' \\
-H "x-tdai-service-id: tdai-mem-xxxxxxxx" \\
https://memory.tdai.tencentyun.com/v3/scenario/ls \\
-d '{
"team_id":"team-abc123",
"user_id":"usr-456",
"agent_id":"agt-xyz789",
"path_prefix":"work/projects"
}'

请求参数

参数
是否必选
参数含义
配置方法及要求
team_id
团队 ID。
数据类型:String。
user_id
用户 ID。
数据类型:String。
agent_id
Agent ID(全局唯一)。
数据类型:String。
task_id
Task ID。
数据类型:String。
path_prefix
场景文件路径前缀。
数据类型:String。
格式:相对路径,建议不带开头的 /(如 work/projects),避免不同存储后端解析不一致。
为空或不传则列出根目录下所有文件。

响应示例

{
"code":0,
"message":"ok",
"request_id":"req-7fd3b2dd",
"data":{
"entries":[
{
"path":"work/projects/product-review/",
"version":0,
"created_at":"2026-07-20T08:00:00Z",
"updated_at":"2026-07-22T10:00:00Z"
},
{
"path":"work/projects/weekly-standup.md",
"version":3,
"created_at":"2026-07-10T09:00:00Z",
"updated_at":"2026-07-21T09:00:00Z"
}
],
"total":2
}
}

响应参数说明

参数名(一级)
参数名(二级)
参数含义
data
entries
文件与目录列表。
entries[].path
文件或目录的完整路径;目录以 / 结尾。
entries[].version
版本号,数值类型,从 0 开始递增;文件为当前版本(如 3),目录固定为 0
entries[].created_at
创建时间,ISO 8601 格式。
entries[].updated_at
最后更新时间,ISO 8601 格式。
total
满足条件的条目总数。