Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.memmachine.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

The HealthStatus interface is returned by the client.health() method, allowing you to monitor the availability of the MemMachine server and its sub-services.

​
Properties

PropertyTypeDescription
statusstringThe overall health indicator (e.g., "healthy").
servicestringThe name of the MemMachine service instance.
versionstringThe current version of the server software.
memory_managersbooleanIndicates if the internal memory subsystems are operational.

​
Usage Example

const health = await client.health();

if (health.status === 'healthy') {
  console.log(`Connected to MemMachine v${health.version}`);
}