Reference

Meta

Health checks and service metadata.

get /v1/health

Cheap liveness probe. Returns 200 if the API process is up. Does not check downstream dependencies (database, redis) — that's `/v1/health/ready`.

curl TypeScript

curl -X GET "https://api.clement.so/v1/health" \
  -H "Authorization: Bearer $CLEMENT_API_KEY"

import { Clement } from "@clement/sdk";

const c = new Clement({ apiKey: process.env.CLEMENT_API_KEY! });
const result = await c.health();

Service is alive

Example response

{
  "status": "ok",
  "service": "api",
  "version": "string"
}