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

读取场景文件

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

我的收藏

接口介绍

本接口(/v3/scenario/read)用于读取指定路径下 L2 场景文件的完整内容。功能说明如下:
读取方式:传入文件路径即可获取文件内容及其元信息。注意:服务端当前返回的内容包含文件内部的 META 信息头和正文,并非仅返回正文。如业务侧需要纯正文展示,请在客户端侧过滤 META 区块。
版本选择version 参数当前可传入但会被服务端忽略,接口始终读取最新文件(历史版本读取功能尚未实现,后续版本将支持)。

Method 与 URL

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

使用示例

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/read \\
-d '{
"team_id":"team-abc123",
"user_id":"usr-456",
"agent_id":"agt-xyz789",
"path":"work/projects/product-review.md"
}'

请求参数

参数
是否必选
参数含义
配置方法及要求
team_id
团队 ID。
数据类型:String。
user_id
用户 ID。
数据类型:String。
agent_id
Agent ID(全局唯一)。
数据类型:String。
task_id
Task ID。
数据类型:String。
path
场景文件的相对路径。
数据类型:String。
格式:相对路径,不带前导 /(如 work/projects/review.md),服务端会拒绝以 / 开头的路径并返回 400。
version
指定读取的文件版本(暂未生效)。
数据类型:Number。
当前可传入但会被服务端忽略,接口始终读取最新文件。历史版本读取功能将在后续版本支持。

响应示例

{
"code":0,
"message":"ok",
"request_id":"req-7fd3b2dd",
"data":{
"path":"work/projects/product-review.md",
"version":3,
"content":"---\\ntitle: 产品评审\\nauthor: agent-xyz789\\ncreated: 2026-07-20T10:00:00Z\\n---\\n# 产品评审\\n\\n## 2026-07-22 评审\\n\\n### 议题\\n1. V3 API 设计评审\\n2. 性能优化方案讨论\\n\\n### 决议\\n- 采用 RESTful 风格统一 V3 接口\\n- 批量操作上限统一为 100 条",
"created_at":"2026-07-20T10:00:00Z",
"updated_at":"2026-07-22T10:00:00Z"
}
}

响应参数说明

参数名(一级)
参数名(二级)
参数含义
data
path
文件的完整路径。
version
文件当前版本号,数值类型,从 0 开始递增,每次写入自增。
content
文件内容(文本)。注意:服务端当前返回的内容包含文件内部的 META 信息头(YAML front matter)和正文,并非仅返回正文。如需纯正文展示请在客户端侧过滤。
created_at
文件首次创建时间,ISO 8601 格式。
updated_at
最后更新时间,ISO 8601 格式。