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

查询记忆库详情

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

按 ID 查询单个记忆库的配置、自定义元数据和当前统计值。需要浏览多个记忆库时,使用查询记忆库列表接口。

鉴权#

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

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

请求参数#

Path 参数#

memory_store_id string 必选  |  记忆库 ID

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

响应参数#

created_at string  |  创建时间

记忆库创建时间,采用 RFC 3339 UTC 格式。

created_by object  |  创建者

创建该记忆库的操作者信息。

type string  |  操作者类型

created_by.type

创建者类型,固定为 user_actor。

user_id string  |  用户 ID

created_by.user_id

创建该记忆库的用户 ID,由服务端根据当前请求的身份自动记录,可用于按创建者筛选记忆库。

id string  |  记忆库 ID

服务端生成的记忆库 ID,以 memstore- 开头。后续查询、更新或删除记忆库时,作为 memory_store_id 路径参数传入。

memory_count integer  |  记忆条目数量

记忆库当前包含的记忆条目数量。

metadata object  |  自定义元数据

创建或更新记忆库时设置的自定义元数据。

name string  |  记忆库名称

记忆库名称,用于识别和管理该记忆库。

session_count integer  |  活跃会话数

当前挂载该记忆库的活跃会话数量。

storage_bytes integer  |  内容总字节数

记忆库当前所有记忆正文的总字节数。

type string  |  对象类型

对象类型,固定为 memory_store。

updated_at string  |  更新时间

记忆库更新时间,采用 RFC 3339 UTC 格式。

description string  |  记忆库描述

记忆库的用途和存储内容说明。

dream_id string  |  Dream 任务 ID

仅 Dream 输出记忆库返回,表示创建该输出 Memory Store 的 Dream ID;普通 Memory Store 不返回该字段。

dream_status string  |  Dream 任务状态

仅 Dream 输出记忆库返回,表示创建该输出 Memory Store 的 Dream 当前状态;普通 Memory Store 不返回该字段。可选值:pending、running、completed、failed、canceled。

mountable boolean  |  是否可挂载

表示当前是否可以挂载、读取或修改该 Memory Store。普通 Memory Store 返回 true;Dream 输出记忆库在 pending 或 running 状态时返回 false,在 completed、failed 或 canceled 状态时返回 true。

usage_ready boolean  |  用量是否就绪

表示 memory_count 和 storage_bytes 是否已可作为准确统计值。普通 Memory Store 返回 true;Dream 输出记忆库在 pending 或 running 状态时返回 false,在 completed、failed 或 canceled 状态时返回 true。