Interfaces

AmsMessage

A single message in the conversation

Properties:

Property	Type	Required	Description
`role`	`AmsRole`	Yes	Role of the message sender
`content`	`string`	Yes	Content of the message
`timestamp`	`string \| undefined`	No	Optional timestamp of when the message was created

AmsMemory

Memory object returned by AMS containing conversation state

Properties:

Property	Type	Required	Description
`messages`	`AmsMessage[]`	Yes	Array of conversation messages
May include summarized messages for context
`token_count`	`number \| undefined`	No	Token count for the current context window
Used to determine when summarization is needed
`summary`	`string \| undefined`	No	Optional summary of older conversation history
Generated when context window exceeds limits
`metadata`	`{ lastUpdated?: string; sessionId?: string; namespace?: string; totalTurns?: number; } \| undefined`	No	Metadata about the memory state

AgentMemoryClientConfig

Configuration for Agent Memory Client

Properties:

Property	Type	Required	Description
`baseUrl`	`string`	Yes	Base URL of the Agent Memory Server
Example: 'http://localhost:8000' or 'http://agent-memory-server:8000'
`timeout`	`number \| undefined`	No	Request timeout in milliseconds
`retries`	`number \| undefined`	No	Number of retries for failed requests
`debug`	`boolean \| undefined`	No	Enable debug logging
`contextWindowMax`	`number \| undefined`	No	Default context window max tokens
`defaultNamespace`	`string \| undefined`	No	Default namespace for memory operations
`authToken`	`string \| undefined`	No	Authorization token for API requests
Will be sent as Bearer token in Authorization header

ReadWorkingMemoryRequest

Request to read working memory from AMS

Properties:

Property	Type	Required	Description
`sessionId`	`string`	Yes	Session ID to retrieve memory for
`namespace`	`string \| undefined`	No	Optional namespace

ReplaceWorkingMemoryRequest

Request to replace working memory in AMS

Properties:

Property	Type	Required	Description
`sessionId`	`string`	Yes	Session ID to update
`namespace`	`string \| undefined`	No	Optional namespace
`contextWindowMax`	`number`	Yes	Maximum context window size in tokens
`memory`	`AmsMemory`	Yes	Memory object to store

AddMessageRequest

Request to add a message to AMS

Properties:

Property	Type	Required	Description
`sessionId`	`string`	Yes	Session ID to add message to
`namespace`	`string \| undefined`	No	Optional namespace
`role`	`AmsRole`	Yes	Role of the message
`content`	`string`	Yes	Content of the message
`contextWindowMax`	`number \| undefined`	No	Optional context window max

RemoveWorkingMemoryRequest

Request to remove working memory from AMS

Properties:

Property	Type	Required	Description
`sessionId`	`string`	Yes	Session ID to remove
`namespace`	`string \| undefined`	No	Optional namespace

AmsErrorResponse

Error response from AMS

Properties:

Property	Type	Required	Description
`error`	`string`	Yes	Error message
`statusCode`	`number \| undefined`	No	HTTP status code
`details`	`any`	No	Additional error details

OperationResult

Result type for operations that may fail

Properties:

Property	Type	Required	Description
`success`	`boolean`	Yes	Whether the operation succeeded
`data`	`T \| undefined`	No	Data returned on success
`error`	`string \| undefined`	No	Error message on failure
`statusCode`	`number \| undefined`	No	HTTP status code

AmsHealthResponse

Health check response from AMS AMS returns { now: <timestamp_ms> } on the /v1/health endpoint

Properties:

Property	Type	Required	Description
`now`	`number \| undefined`	No	Timestamp in milliseconds (actual AMS response)
`status`	`"healthy" \| "unhealthy" \| undefined`	No	Legacy: Service status (not returned by current AMS versions)
`version`	`string \| undefined`	No	Optional version information
`timestamp`	`string \| undefined`	No	Optional timestamp

MemoryPromptRequest

Request parameters for Memory Prompt API

Properties:

Property	Type	Required	Description
`query`	`string`	Yes	The user's query/prompt
`sessionId`	`string`	Yes	Session ID for memory context
`namespace`	`string`	Yes	Namespace for scoping
`modelName`	`string \| undefined`	No	Model name for token counting (e.g., 'claude-3-5-sonnet-latest')
`contextWindowMax`	`number \| undefined`	No	Maximum context window size in tokens

MemoryPromptMessage

A message in the memory prompt response

Properties:

Property	Type	Required	Description
`role`	`"system" \| "user" \| "assistant"`	Yes	Role of the message
`content`	`string`	Yes	Content of the message

MemoryPromptResponse

Response from Memory Prompt API

Properties:

Property	Type	Required	Description
`messages`	`MemoryPromptMessage[]`	Yes	Ready-to-use messages array with memory context
`tokenCount`	`number \| undefined`	No	Token count for the response
`summarized`	`boolean \| undefined`	No	Whether summarization was applied

AmsSession

A session entry in the list response

Properties:

Property	Type	Required	Description
`sessionId`	`string`	Yes	Session ID
`namespace`	`string`	Yes	Namespace this session belongs to
`messageCount`	`number \| undefined`	No	Number of messages in the session
`tokenCount`	`number \| undefined`	No	Token count for the session
`lastUpdated`	`string \| undefined`	No	When the session was last updated
`userId`	`string \| undefined`	No	User ID extracted from session ID (if format is userId_agentId)
`hasSummary`	`boolean \| undefined`	No	Whether this session has a summary (messages were compacted)
`summary`	`string \| null \| undefined`	No	The summary text if summarization occurred
`contextPercentageUsed`	`number \| null \| undefined`	No	Percentage of context window used (0-100)
`contextPercentageUntilSummarization`	`number \| null \| undefined`	No	Percentage until summarization triggers (0-100)

SessionListResponse

Response from session list API

Properties:

Property	Type	Required	Description
`sessions`	`AmsSession[]`	Yes	List of sessions
`total`	`number`	Yes	Total count of sessions from server (before client-side filtering)
`filteredTotal`	`number \| undefined`	No	Count of sessions after client-side userId filtering (only present when userId filter is used)
`offset`	`number \| undefined`	No	Current offset
`limit`	`number \| undefined`	No	Limit used

ListSessionsOptions

Options for listing sessions

Properties:

Property	Type	Required	Description
`userId`	`string \| undefined`	No	Filter by user ID (extracted from session ID)
`limit`	`number \| undefined`	No	Maximum number of sessions to return
`offset`	`number \| undefined`	No	Offset for pagination

LongTermMemory

A long-term memory entry stored in AMS

Properties:

Property	Type	Required	Description
`id`	`string`	Yes	Unique identifier for this memory
`text`	`string`	Yes	Text content of the memory
`memory_type`	`LongTermMemoryType \| undefined`	No	Type of memory
`session_id`	`string \| undefined`	No	Session ID associated with this memory
`namespace`	`string \| undefined`	No	Namespace for scoping
`user_id`	`string \| undefined`	No	User ID associated with this memory
`topics`	`string[] \| undefined`	No	Topics/tags associated with this memory
`entities`	`string[] \| undefined`	No	Entities mentioned in this memory
`created_at`	`number \| undefined`	No	Unix timestamp when memory was created
`last_accessed`	`number \| undefined`	No	Unix timestamp when memory was last accessed
`score`	`number \| undefined`	No	Similarity score from search (only present in search results)

CreateLongTermMemoryParams

Parameters for creating long-term memories

Properties:

Property	Type	Required	Description
`text`	`string`	Yes	Text content of the memory
`memory_type`	`LongTermMemoryType \| undefined`	No	Type of memory (default: 'semantic')
`session_id`	`string \| undefined`	No	Session ID to associate with this memory
`namespace`	`string`	Yes	Namespace for scoping
`user_id`	`string \| undefined`	No	User ID to associate with this memory
`topics`	`string[] \| undefined`	No	Topics/tags to associate with this memory
`id`	`string \| undefined`	No	Custom ID (optional, auto-generated if not provided)

CreateLongTermMemoriesRequest

Request body for creating long-term memories

Properties:

Property	Type	Required	Description
`memories`	`CreateLongTermMemoryParams[]`	Yes	Array of memories to create

TagFilter

Filter operator for tag fields (session_id, namespace, user_id, topics, entities)

Properties:

Property	Type	Required	Description
`eq`	`string \| undefined`	No	Equals
`ne`	`string \| undefined`	No	Not equals
`any`	`string[] \| undefined`	No	Any of the values
`all`	`string[] \| undefined`	No	All of the values

NumericFilter

Filter operator for numeric fields (created_at, last_accessed)

Properties:

Property	Type	Required	Description
`gt`	`number \| undefined`	No	Greater than
`lt`	`number \| undefined`	No	Less than
`gte`	`number \| undefined`	No	Greater than or equal
`lte`	`number \| undefined`	No	Less than or equal
`eq`	`number \| undefined`	No	Equals
`ne`	`number \| undefined`	No	Not equals
`between`	`[number, number] \| undefined`	No	Between two values [min, max]

SearchLongTermMemoryParams

Parameters for searching long-term memories

Properties:

Property	Type	Required	Description
`text`	`string`	Yes	Search query text
`limit`	`number \| undefined`	No	Maximum number of results
`offset`	`number \| undefined`	No	Offset for pagination
`session_id`	`TagFilter \| undefined`	No	Filter by session ID
`namespace`	`TagFilter \| undefined`	No	Filter by namespace
`user_id`	`TagFilter \| undefined`	No	Filter by user ID
`topics`	`TagFilter \| undefined`	No	Filter by topics
`entities`	`TagFilter \| undefined`	No	Filter by entities
`created_at`	`NumericFilter \| undefined`	No	Filter by creation time
`last_accessed`	`NumericFilter \| undefined`	No	Filter by last access time
`recency_boost`	`boolean \| undefined`	No	Enable recency boosting

SearchLongTermMemoryResponse

Response from long-term memory search

Properties:

Property	Type	Required	Description
`memories`	`LongTermMemory[]`	Yes	Array of matching memories with scores
`total`	`number \| undefined`	No	Total count of matches

ForgetMemoryPolicy

Policy for forgetting memories

Properties:

Property	Type	Required	Description
`max_age_days`	`number \| undefined`	No	Delete memories older than this many days
`max_inactive_days`	`number \| undefined`	No	Delete memories not accessed in this many days
`budget`	`number \| null \| undefined`	No	Maximum number of memories to delete
`memory_type_allowlist`	`LongTermMemoryType[] \| null \| undefined`	No	Only delete memories of these types

ForgetMemoriesParams

Parameters for forgetting (bulk deleting) memories

Properties:

Property	Type	Required	Description
`policy`	`ForgetMemoryPolicy \| undefined`	No	Deletion policy
`namespace`	`string \| undefined`	No	Namespace to scope deletion
`user_id`	`string \| undefined`	No	User ID to scope deletion
`session_id`	`string \| null \| undefined`	No	Session ID to scope deletion
`limit`	`number \| undefined`	No	Maximum number of memories to delete
`dry_run`	`boolean \| undefined`	No	If true, only simulate deletion without actually deleting

ForgetMemoriesResponse

Response from forget memories operation

Properties:

Property	Type	Required	Description
`scanned`	`number`	Yes	Number of memories scanned
`deleted`	`number`	Yes	Number of memories deleted
`deleted_ids`	`string[]`	Yes	IDs of deleted memories
`dry_run`	`boolean`	Yes	Whether this was a dry run

UnifiedSearchResult

A unified search result that can be from any memory source

Properties:

Property	Type	Required	Description
`id`	`string`	Yes	Unique identifier for this result
`source`	`MemorySourceType`	Yes	Source type of this result
`text`	`string`	Yes	Text content of the result
`score`	`number`	Yes	Similarity score (0-1)
`sessionId`	`string \| undefined`	No	Session ID (for working memory results)
`userId`	`string \| undefined`	No	User ID associated with this result
`namespace`	`string \| undefined`	No	Namespace
`role`	`AmsRole \| undefined`	No	Message role (for working memory results)
`memoryType`	`LongTermMemoryType \| undefined`	No	Memory type (for long-term memory results)
`topics`	`string[] \| undefined`	No	Topics/tags (for long-term memory results)
`createdAt`	`string \| number \| undefined`	No	Timestamp when this was created
`longTermMemory`	`LongTermMemory \| undefined`	No	Original long-term memory (if source is long_term_memory)
`message`	`AmsMessage \| undefined`	No	Original message (if source is working_memory)

SearchAllMemoryParams

Parameters for searching all memory types

Properties:

Property	Type	Required	Description
`query`	`string`	Yes	Search query text
`namespace`	`string`	Yes	Namespace to search within
`includeWorkingMemory`	`boolean \| undefined`	No	Include working memory sessions in search (default: true)
`includeLongTermMemory`	`boolean \| undefined`	No	Include long-term memory in search (default: true)
`userId`	`string \| undefined`	No	Filter by user ID
`sessionId`	`string \| undefined`	No	Filter by session ID (for working memory)
`limit`	`number \| undefined`	No	Maximum number of results per source

SearchAllMemoryResponse

Response from unified memory search

Properties:

Property	Type	Required	Description
`results`	`UnifiedSearchResult[]`	Yes	Combined search results from all sources
`workingMemoryCount`	`number`	Yes	Total results from working memory
`longTermMemoryCount`	`number`	Yes	Total results from long-term memory
`totalCount`	`number`	Yes	Total combined results