Agent.getMemory()

The .getMemory() method retrieves the memory system associated with an agent. This method is used to access the agent's memory capabilities for storing and retrieving information across conversations.

Usage example

await agent.getMemory()

Parameters

<PropertiesTable content={[ { name: 'options', type: '{ requestContext?: RequestContext }', isOptional: true, defaultValue: '{}', description: 'Optional configuration object containing request context.', properties: [ { type: '{ requestContext?: RequestContext }', parameters: [ { name: 'requestContext', type: 'RequestContext', isOptional: true, defaultValue: 'new RequestContext()', description: 'Request Context for dependency injection and contextual information.', }, ], }, ], }, ]} />

Returns

<PropertiesTable content={[ { name: 'memory', type: 'Promise<MastraMemory | undefined>', description: 'A promise that resolves to the memory system configured for the agent, or undefined if no memory system is configured.', }, ]} />

Extended usage example

await agent.getMemory({
  requestContext: new RequestContext(),
})

Related

• Memory
• Request Context