Check Health

client.health(?): HealthResponse { status, version }

GET/v1/health/

Liveness endpoint; returns 200 when process is responsive.

ReturnsExpand Collapse

HealthResponse { status, version }

Health check response body

status: string

version: string

Check Health

import Letta from '@letta-ai/letta-client';

const client = new Letta({
  apiKey: process.env['LETTA_API_KEY'], // This is the default and can be omitted
});

const response = await client.health();

console.log(response.status);

{
  "status": "status",
  "version": "version"
}

Returns Examples

{
  "status": "status",
  "version": "version"
}