面向 AI 助手:本页的 Markdown 版本位于 https://ark.volcengine.com/region:cn-beijing/docs/list-memories-api.md,全部文档索引见 https://ark.volcengine.com/llms.txt。

查询记忆列表

GET https://ark.cn-beijing.volces.com/api/v3/memory_stores/{memory_store_id}/memories

查询指定记忆库中的记忆条目。支持按 path_prefix 筛选,并通过 depth 折叠子目录。列表项仅包含路径和精简信息,不含 content;需要正文时,调用查询记忆详情接口。

鉴权#

本接口支持鉴权方式如下,详情请参见 Base URL 及鉴权。

  • API Key 鉴权,请在 API Key 管理 页面,获取长效 API Key。

请求参数#

Path 参数#

memory_store_id string 必选  |  记忆库 ID

用于指定目标记忆库,以 memstore- 开头。传入创建或查询记忆库接口返回的完整 ID,不要自行拼接。

Query 参数#

在 URL Query String 中传入。

depth integer  |  折叠层数

控制从 path_prefix 之后展示的目录层数。省略时,平铺返回全部匹配的记忆。

例如,path_prefix 为 /preferences/ 且 depth 为 1 时:

  • /preferences/language.md 作为 memory 返回。
  • 更深层级的记忆合并为 /preferences/editors/ 等 memory_prefix 项。

最小值:1

limit integer 默认值 100  |  每页数量

单页返回的记忆条目数量。

取值范围:[1, 2000]

order_by string 默认值 path  |  排序字段

指定列表排序方式。可选值:path、updated_at、created_at。

page string  |  下一页标识

上一页响应返回的下一页标识。首次请求时省略;后续请求将 next_page 的值原样传入。

path_prefix string  |  路径前缀

按记忆 path 字段的目录前缀筛选。非空值必须以 / 开头;服务端按目录边界匹配,/foo 与 /foo/ 等价,不会匹配 /foobar.md。

响应参数#

data object[]  |  记忆列表

记忆列表项。type 为 memory 时返回文件元信息;type 为 memory_prefix 时返回折叠目录的 path 和 memory_count。

path string  |  记忆路径

data.path

记忆文件或折叠目录的路径;memory_prefix 类型时以 / 结尾。

type string  |  列表项类型

data.type

列表项类型。memory 表示记忆文件,memory_prefix 表示折叠目录。

content_sha256 string  |  内容摘要

data.content_sha256

记忆正文的 SHA-256 摘要,以小写十六进制字符串表示,仅 type 为 memory 时返回。

content_size_bytes integer  |  内容字节数

data.content_size_bytes

记忆正文采用 UTF-8 编码后的字节数,仅 type 为 memory 时返回。

created_at string  |  创建时间

data.created_at

创建时间,仅 type 为 memory 时返回,采用 RFC 3339 UTC 格式。

id string  |  记忆 ID

data.id

服务端生成的记忆 ID,仅 type 为 memory 时返回。后续查询、更新或删除记忆时,作为 memory_id 路径参数传入。

memory_count integer  |  记忆条数

data.memory_count

折叠目录下的记忆条数,仅 type 为 memory_prefix 时返回。

memory_store_id string  |  记忆库 ID

data.memory_store_id

该记忆所属的记忆库 ID,仅 type 为 memory 时返回。

memory_version_id string  |  版本 ID

data.memory_version_id

记忆条目的当前版本标识,仅 type 为 memory 时返回。内容或路径成功更新后,该值会变化。

updated_at string  |  更新时间

data.updated_at

最后更新时间,仅 type 为 memory 时返回,采用 RFC 3339 UTC 格式。

next_page string  |  下一页标识

下一页标识。返回非空值时,将其原样传入下一次请求的 page 参数;无更多数据时不返回该字段。