Skip to main content

Health SDK

System health — liveness, readiness, and per-dependency status checks

Operations

Generated Reference

Overview

System health — liveness, readiness, and per-dependency status checks

Available Operations

lucidCheckSystemHealth

Check overall system health including all dependencies (database, Redis, Solana, Nango). Returns healthy, degraded, or down status with a 200 when healthy or 503 when degraded/down. Use /health/detailed for resource metrics.

Example Usage

Standalone function

The standalone function version of this method:

Parameters

Response

Promise<models.SystemHealth>

Errors

lucidCheckLiveness

Kubernetes-compatible liveness probe. Returns 200 if the application process is alive. Does not check dependencies. Use /health/ready for full readiness.

Example Usage

Standalone function

The standalone function version of this method:

Parameters

Response

Promise<operations.LucidCheckLivenessResponse>

Errors

lucidCheckReadiness

Kubernetes-compatible readiness probe. Checks all dependencies (database, Redis, etc.) and returns 200 only when the service is ready to accept traffic. Returns 503 with dependency status details when not ready.

Example Usage

Standalone function

The standalone function version of this method:

Parameters

Response

Promise<operations.LucidCheckReadinessResponse>

Errors

lucidCheckDatabaseHealth

Check database (PostgreSQL/Supabase) connectivity and query latency. Returns 503 when the database is unreachable.

Example Usage

Standalone function

The standalone function version of this method:

Parameters

Response

Promise<models.HealthCheckResult>

Errors

lucidCheckRedisHealth

Check Redis connectivity and latency. Redis is used for spent proof deduplication and caching. Returns 503 when Redis is unreachable.

Example Usage

Standalone function

The standalone function version of this method:

Parameters

Response

Promise<models.HealthCheckResult>

Errors

lucidCheckNangoHealth

Check Nango OAuth service connectivity. Nango manages third-party OAuth connections for agent integrations. Returns 503 when Nango is unreachable.

Example Usage

Standalone function

The standalone function version of this method:

Parameters

Response

Promise<models.HealthCheckResult>

Errors

lucidGetDetailedHealth

Detailed health check including system resources (memory, CPU), per-dependency status, version info, environment, and aggregate statistics. Use this for operational dashboards and monitoring.

Example Usage

Standalone function

The standalone function version of this method:

Parameters

Response

Promise<operations.LucidGetDetailedHealthResponse>

Errors