API Reference

Health

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Health check

client.health.check(RequestOptionsoptions?): HealthCheckResponse { status }

GET/health

Returns HTTP 200 when the service is running. No authentication required.

ReturnsExpand Collapse

HealthCheckResponse { status }

status: "ok"

Health check

TypeScript

HTTP

TypeScript

Python

Go

import Chamelaion from 'chamelaion';

const client = new Chamelaion();

const response = await client.health.check();

console.log(response.status);

200 example

{
  "status": "ok"
}

Returns Examples

200 example

{
  "status": "ok"
}