List memories

GET

memory_stores

{memory_store_id}

memories

List 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"
  }
}

Every request requires ?beta=true.

Authorizations

X-Api-Key

string

header

default:sk-ant-local-default

required

OMA workspace API key.

Headers

anthropic-version

string

anthropic-beta

string

Path Parameters

memory_store_id

string

required

Path parameter memory_store_id

Query Parameters

beta

enum<boolean>

required

Selects the beta API contract for this endpoint. Must be true.

Available options:

true

path_prefix

string

Optional path prefix filter. Must end with / (segment-aligned), e.g., /notes/. This value appears in request URLs. Do not include secrets or personally identifiable information.

depth

integer<int32>

0 (or omitted) returns all descendants below path_prefix (recursive). 1 returns immediate children only; deeper entries roll up as memory_prefix items. depth=1 behaves like ls; omitting depth behaves like find.

limit

integer<int32>

Maximum number of items to return per page. Must be between 1 and 100. Defaults to 20 when omitted. Capped at 20 when view=full. Both memory and memory_prefix items count toward the limit.

page

string

Opaque pagination cursor (a page_... value). Pass the next_page value from a previous response to fetch the next page; omit for the first page.

view

enum<string>

Which projection of each memory to return. Defaults to basic (content omitted). full populates content on each item and caps limit at 20; use this as the bulk-read path for export and sync. Selects which projection of a memory or memory_version the server returns. basic returns the object with content set to null; full populates content. When omitted, the default is endpoint-specific: retrieve operations default to full; list, create, and update operations default to basic. Listing with view=full caps limit at 20.

Available options:

basic,

full

Response

Successful response (OK)

Response payload for List memories.

data

object[]

One page of results. Each item is either a memory object or, when depth was set, a memory_prefix rollup marker. Items are returned in a stable, server-defined order.

A memory object: a single text document at a hierarchical path inside a memory store. The content field is populated when view=full and null when view=basic; the content_size_bytes and content_sha256 fields are always populated so sync clients can diff without fetching content. Memories are addressed by their mem_... ID; the path is the create key and can be changed via update.

Option 1
Option 2

Show child attributes

next_page

string | null

Opaque cursor for the next page (a page_... value), or null if there are no more results. Pass as page on the next request.

List 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"
  }
}

Get started

Core API

Managed Agents

Webhooks

Authorizations

Headers

Path Parameters

Query Parameters

Response