Memories

Memory configuration endpoints

List memories

List memory configurations with cursor pagination.

Query Parameters

project?string

Project override

limit?integer

Page size (max 500)

cursor?string

Opaque pagination cursor

q?string

Filter by memory ID prefix

Response Body

curl -X GET "https://loading/api/v0/memories?project=string&limit=0&cursor=string&q=string"

{
  "data": {
    "memories": [
      {
        "default_key_template": "string",
        "description": "string",
        "etag": "abc123",
        "flushing": {
          "summarize_oldest_percent": 1,
          "summarize_threshold": 1,
          "summary_tokens": 0,
          "type": "hybrid_summary"
        },
        "id": "string",
        "locking": {
          "append_ttl": "string",
          "clear_ttl": "string",
          "flush_ttl": "string"
        },
        "max_context_ratio": 0,
        "max_messages": 0,
        "max_tokens": 0,
        "persistence": {
          "circuit_breaker": {
            "enabled": true,
            "max_failures": 0,
            "reset_timeout": "string",
            "timeout": "string"
          },
          "ttl": "string",
          "type": "redis"
        },
        "privacy_policy": {
          "default_redaction_string": "string",
          "non_persistable_message_types": [
            "string"
          ],
          "redact_patterns": [
            "string"
          ]
        },
        "resource": "string",
        "token_allocation": {
          "long_term": 1,
          "short_term": 1,
          "system": 1,
          "user_defined": {
            "property1": 0,
            "property2": 0
          }
        },
        "token_provider": {
          "api_key": "string",
          "api_key_env": "string",
          "endpoint": "string",
          "fallback": "string",
          "model": "string",
          "provider": "string",
          "settings": {
            "property1": "string",
            "property2": "string"
          }
        },
        "type": "token_based",
        "version": "string"
      }
    ],
    "page": {
      "limit": 50,
      "next_cursor": "v2:after:tool-001",
      "prev_cursor": "v2:before:tool-000",
      "total": 2
    }
  },
  "error": {
    "code": "string",
    "details": "string",
    "message": "string"
  },
  "message": "string",
  "status": 0
}

{
  "code": "invalid_cursor",
  "detail": "Invalid cursor parameter",
  "instance": "/api/v0/workflows",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}

{
  "code": "invalid_cursor",
  "detail": "Invalid cursor parameter",
  "instance": "/api/v0/workflows",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}

Get memory

Retrieve a memory configuration by ID.

Path Parameters

memory_idstring

Memory ID

Query Parameters

project?string

Project override

Response Body

curl -X GET "https://loading/api/v0/memories/string?project=string"

{
  "data": {
    "default_key_template": "string",
    "description": "string",
    "flushing": {
      "summarize_oldest_percent": 1,
      "summarize_threshold": 1,
      "summary_tokens": 0,
      "type": "hybrid_summary"
    },
    "id": "string",
    "locking": {
      "append_ttl": "string",
      "clear_ttl": "string",
      "flush_ttl": "string"
    },
    "max_context_ratio": 0,
    "max_messages": 0,
    "max_tokens": 0,
    "persistence": {
      "circuit_breaker": {
        "enabled": true,
        "max_failures": 0,
        "reset_timeout": "string",
        "timeout": "string"
      },
      "ttl": "string",
      "type": "redis"
    },
    "privacy_policy": {
      "default_redaction_string": "string",
      "non_persistable_message_types": [
        "string"
      ],
      "redact_patterns": [
        "string"
      ]
    },
    "resource": "string",
    "token_allocation": {
      "long_term": 1,
      "short_term": 1,
      "system": 1,
      "user_defined": {
        "property1": 0,
        "property2": 0
      }
    },
    "token_provider": {
      "api_key": "string",
      "api_key_env": "string",
      "endpoint": "string",
      "fallback": "string",
      "model": "string",
      "provider": "string",
      "settings": {
        "property1": "string",
        "property2": "string"
      }
    },
    "type": "token_based",
    "version": "string"
  },
  "error": {
    "code": "string",
    "details": "string",
    "message": "string"
  },
  "message": "string",
  "status": 0
}

{
  "code": "invalid_cursor",
  "detail": "Invalid cursor parameter",
  "instance": "/api/v0/workflows",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}

{
  "code": "invalid_cursor",
  "detail": "Invalid cursor parameter",
  "instance": "/api/v0/workflows",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}

{
  "code": "invalid_cursor",
  "detail": "Invalid cursor parameter",
  "instance": "/api/v0/workflows",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}

Create or update memory

Create a memory configuration when absent or update an existing one using strong ETag concurrency.

Path Parameters

memory_idstring

Memory ID

Query Parameters

project?string

Project override

Header Parameters

If-Match?string

Strong ETag for optimistic concurrency

Request Body

Memory configuration payload

Empty Object

Response Body

curl -X PUT "https://loading/api/v0/memories/string?project=string" \
  -H "If-Match: string" \
  -H "Content-Type: application/json" \
  -d '{}'

{
  "data": {
    "default_key_template": "string",
    "description": "string",
    "flushing": {
      "summarize_oldest_percent": 1,
      "summarize_threshold": 1,
      "summary_tokens": 0,
      "type": "hybrid_summary"
    },
    "id": "string",
    "locking": {
      "append_ttl": "string",
      "clear_ttl": "string",
      "flush_ttl": "string"
    },
    "max_context_ratio": 0,
    "max_messages": 0,
    "max_tokens": 0,
    "persistence": {
      "circuit_breaker": {
        "enabled": true,
        "max_failures": 0,
        "reset_timeout": "string",
        "timeout": "string"
      },
      "ttl": "string",
      "type": "redis"
    },
    "privacy_policy": {
      "default_redaction_string": "string",
      "non_persistable_message_types": [
        "string"
      ],
      "redact_patterns": [
        "string"
      ]
    },
    "resource": "string",
    "token_allocation": {
      "long_term": 1,
      "short_term": 1,
      "system": 1,
      "user_defined": {
        "property1": 0,
        "property2": 0
      }
    },
    "token_provider": {
      "api_key": "string",
      "api_key_env": "string",
      "endpoint": "string",
      "fallback": "string",
      "model": "string",
      "provider": "string",
      "settings": {
        "property1": "string",
        "property2": "string"
      }
    },
    "type": "token_based",
    "version": "string"
  },
  "error": {
    "code": "string",
    "details": "string",
    "message": "string"
  },
  "message": "string",
  "status": 0
}

{
  "data": {
    "default_key_template": "string",
    "description": "string",
    "flushing": {
      "summarize_oldest_percent": 1,
      "summarize_threshold": 1,
      "summary_tokens": 0,
      "type": "hybrid_summary"
    },
    "id": "string",
    "locking": {
      "append_ttl": "string",
      "clear_ttl": "string",
      "flush_ttl": "string"
    },
    "max_context_ratio": 0,
    "max_messages": 0,
    "max_tokens": 0,
    "persistence": {
      "circuit_breaker": {
        "enabled": true,
        "max_failures": 0,
        "reset_timeout": "string",
        "timeout": "string"
      },
      "ttl": "string",
      "type": "redis"
    },
    "privacy_policy": {
      "default_redaction_string": "string",
      "non_persistable_message_types": [
        "string"
      ],
      "redact_patterns": [
        "string"
      ]
    },
    "resource": "string",
    "token_allocation": {
      "long_term": 1,
      "short_term": 1,
      "system": 1,
      "user_defined": {
        "property1": 0,
        "property2": 0
      }
    },
    "token_provider": {
      "api_key": "string",
      "api_key_env": "string",
      "endpoint": "string",
      "fallback": "string",
      "model": "string",
      "provider": "string",
      "settings": {
        "property1": "string",
        "property2": "string"
      }
    },
    "type": "token_based",
    "version": "string"
  },
  "error": {
    "code": "string",
    "details": "string",
    "message": "string"
  },
  "message": "string",
  "status": 0
}

{
  "code": "invalid_cursor",
  "detail": "Invalid cursor parameter",
  "instance": "/api/v0/workflows",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}

{
  "code": "invalid_cursor",
  "detail": "Invalid cursor parameter",
  "instance": "/api/v0/workflows",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}

{
  "code": "invalid_cursor",
  "detail": "Invalid cursor parameter",
  "instance": "/api/v0/workflows",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}

{
  "code": "invalid_cursor",
  "detail": "Invalid cursor parameter",
  "instance": "/api/v0/workflows",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}

Delete memory

Delete a memory configuration. Returns conflict when referenced.

Path Parameters

memory_idstring

Memory ID

Query Parameters

project?string

Project override

Response Body

curl -X DELETE "https://loading/api/v0/memories/string?project=string"

"string"

{
  "code": "invalid_cursor",
  "detail": "Invalid cursor parameter",
  "instance": "/api/v0/workflows",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}

{
  "code": "invalid_cursor",
  "detail": "Invalid cursor parameter",
  "instance": "/api/v0/workflows",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}

{
  "code": "invalid_cursor",
  "detail": "Invalid cursor parameter",
  "instance": "/api/v0/workflows",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}

200

400

500

200

400

404

500

200

201

400

409

412

500

204

404

409

500