API Reference

Client

View as Markdown

View as Markdown

Copy Markdown

---

Open in Claude

Open in ChatGPT

Check Health

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

get/v1/health/

Async health check endpoint.

ReturnsExpand Collapse

HealthResponse { status, version }

Health check response body

status: string

version: string

Check Health

TypeScript

• HTTP
• TypeScript
• Python

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

const client = new Letta({
  apiKey: 'My API Key',
});

const response = await client.health();

console.log(response.status);

200 example

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

Returns Examples

200 example

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