列出记忆

GET

memory_stores

{memory_store_id}

memories

列出记忆

curl --request GET \
  --url http://localhost:38080/v1/memory_stores/{memory_store_id}/memories \
  --header 'X-Api-Key: <api-key>'

const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};

fetch('http://localhost:38080/v1/memory_stores/{memory_store_id}/memories', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:38080/v1/memory_stores/{memory_store_id}/memories"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Api-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "data": [
    {
      "type": "memory",
      "id": "<string>",
      "memory_store_id": "<string>",
      "path": "<string>",
      "content_size_bytes": 123,
      "content_sha256": "<string>",
      "memory_version_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "content": "<string>"
    }
  ],
  "next_page": "<string>"
}

{
  "type": "error",
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  }
}

{
  "type": "error",
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  }
}

{
  "type": "error",
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  }
}

{
  "type": "error",
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  }
}

{
  "type": "error",
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  }
}

{
  "type": "error",
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  }
}

{
  "type": "error",
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  }
}

{
  "type": "error",
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  }
}

{
  "type": "error",
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  }
}

{
  "type": "error",
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  }
}

{
  "type": "error",
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  }
}

{
  "type": "error",
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  }
}

{
  "type": "error",
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  }
}

{
  "type": "error",
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  }
}

{
  "type": "error",
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  }
}

每个请求都必须发送 ?beta=true。

授权

X-Api-Key

string

header

默认值:sk-ant-local-default

必填

OMA 工作区 API 密钥。

请求头

anthropic-version

string

anthropic-beta

string

路径参数

memory_store_id

string

必填

记忆存储标识符。

查询参数

beta

enum<boolean>

必填

为此接口启用 Beta API 合同，必须为 true。

可用选项:

true

path_prefix

string

可选的路径前缀过滤器。必须以 / 结尾（按段对齐），例如 /notes/。该值会出现在请求 URL 中。请勿包含密钥或个人身份信息。

depth

integer<int32>

0（或省略）返回 path_prefix 下的所有后代条目（递归）。1 仅返回直接子级；更深层的条目会归并为 memory_prefix 条目。depth=1 的行为类似 ls；省略 depth 的行为类似 find。

limit

integer<int32>

每页返回的最大条目数。必须介于 1 和 100 之间。省略时默认为 20。当 view=full 时上限为 20。memory 和 memory_prefix 条目都计入该限制。

page

string

不透明的分页游标（page_... 格式的值）。传入上一次响应中的 next_page 值以获取下一页；获取第一页时省略。

view

enum<string>

返回每个 memory 的哪种投影。默认为 basic（省略内容）。full 会为每个条目填充 content，并将 limit 上限设为 20；可将其作为导出和同步的批量读取路径。选择服务器返回 memory 或 memory_version 的哪种投影。basic 返回 content 置为 null 的对象；full 会填充 content。省略时默认值因端点而异：检索操作默认为 full；列表、创建和更新操作默认为 basic。使用 view=full 进行列表查询时，limit 上限为 20。

可用选项:

basic,

full

响应

请求成功。

列出记忆的响应负载。

data

object[]

一页结果。每个条目要么是 memory 对象，要么是在设置了 depth 时的 memory_prefix 汇总标记。条目按稳定的、由服务端定义的顺序返回。

memory 对象：记忆存储中位于层级路径上的单个文本文档。view=full 时填充 content 字段，view=basic 时为 null；content_size_bytes 和 content_sha256 字段始终填充，以便同步客户端无需拉取内容即可比对差异。记忆以其 mem_... ID 寻址；路径是创建时的键，可通过更新修改。

Option 1
Option 2

Show child attributes

next_page

string | null

下一页的不透明游标（page_... 值），没有更多结果时为 null。在下一次请求中作为 page 传入。

列出记忆

curl --request GET \
  --url http://localhost:38080/v1/memory_stores/{memory_store_id}/memories \
  --header 'X-Api-Key: <api-key>'

const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};

fetch('http://localhost:38080/v1/memory_stores/{memory_store_id}/memories', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:38080/v1/memory_stores/{memory_store_id}/memories"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Api-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "data": [
    {
      "type": "memory",
      "id": "<string>",
      "memory_store_id": "<string>",
      "path": "<string>",
      "content_size_bytes": 123,
      "content_sha256": "<string>",
      "memory_version_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "content": "<string>"
    }
  ],
  "next_page": "<string>"
}

{
  "type": "error",
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  }
}

{
  "type": "error",
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  }
}

{
  "type": "error",
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  }
}

{
  "type": "error",
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  }
}

{
  "type": "error",
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  }
}

{
  "type": "error",
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  }
}

{
  "type": "error",
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  }
}

{
  "type": "error",
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  }
}

{
  "type": "error",
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  }
}

{
  "type": "error",
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  }
}

{
  "type": "error",
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  }
}

{
  "type": "error",
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  }
}

{
  "type": "error",
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  }
}

{
  "type": "error",
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  }
}

{
  "type": "error",
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  }
}

开始使用

核心 API

托管智能体

Webhook

授权

请求头

路径参数

查询参数

响应