Health Checks

Health check endpoints for monitoring the availability and readiness of the Inherent Public API. These endpoints do not require authentication.

---

Liveness Check

Returns a simple status indicating the service is running.

GET /health

Authentication

None required.

Code Examples

cURL

curl https://api.inherent.systems/health

Python

import requests

response = requests.get("https://api.inherent.systems/health")
print(response.json())

JavaScript

const response = await fetch("https://api.inherent.systems/health");
const data = await response.json();
console.log(data.status); // "healthy"

Response

Status: 200 OK

{
  "status": "healthy",
  "service": "inh-public-api-svc"
}

Response Fields

Field	Type	Description
status	string	Always "healthy" if the service is responding
service	string	Service identifier ("inh-public-api-svc")

---

Readiness Check

Validates that the service and all its dependencies (PostgreSQL, Weaviate) are operational. Use this endpoint for orchestration tools (e.g., Docker health checks, Kubernetes readiness probes) to determine if the service is ready to accept traffic.

GET /health/ready

Authentication

None required.

Code Examples

cURL

curl https://api.inherent.systems/health/ready

Python

import requests

response = requests.get("https://api.inherent.systems/health/ready")
health = response.json()

print(f"Status: {health['status']}")
for name, check in health["checks"].items():
    print(f"  {name}: {check['status']} ({check['latency_ms']}ms)")

JavaScript

const response = await fetch("https://api.inherent.systems/health/ready");
const health = await response.json();

console.log(`Status: ${health.status}`);
Object.entries(health.checks).forEach(([name, check]) => {
  console.log(`  ${name}: ${check.status} (${check.latency_ms}ms)`);
});

Response

Status: 200 OK

{
  "status": "healthy",
  "timestamp": "2026-04-03T12:34:56.789Z",
  "version": "0.1.0",
  "service": "inh-public-api-svc",
  "checks": {
    "database": {
      "status": "healthy",
      "latency_ms": 2.3,
      "message": "PostgreSQL connection OK"
    },
    "weaviate": {
      "status": "healthy",
      "latency_ms": 5.1,
      "message": "Weaviate connection OK"
    }
  }
}

Response Fields

Field	Type	Description
status	string	Overall status: "healthy", "degraded", or "unhealthy"
timestamp	string	ISO 8601 timestamp of the health check
version	string	Service version
service	string	Service identifier ("inh-public-api-svc")
checks	object	Individual dependency check results
checks.database	object	PostgreSQL health check
checks.database.status	string	"healthy", "degraded", or "unhealthy"
checks.database.latency_ms	float	Round-trip latency to the database in milliseconds
checks.database.message	string	Human-readable status message
checks.weaviate	object	Weaviate health check
checks.weaviate.status	string	"healthy", "degraded", or "unhealthy"
checks.weaviate.latency_ms	float	Round-trip latency to Weaviate in milliseconds
checks.weaviate.message	string	Human-readable status message

Status Values

Status	Meaning
healthy	All dependencies are reachable and responding normally
degraded	At least one dependency is slow or intermittently failing, but the service can still handle requests
unhealthy	One or more critical dependencies are unreachable; the service cannot reliably handle requests

Degraded Example

When a dependency is slow or experiencing issues:

{
  "status": "degraded",
  "timestamp": "2026-04-03T12:34:56.789Z",
  "version": "0.1.0",
  "service": "inh-public-api-svc",
  "checks": {
    "database": {
      "status": "healthy",
      "latency_ms": 3.1,
      "message": "PostgreSQL connection OK"
    },
    "weaviate": {
      "status": "degraded",
      "latency_ms": 2150.4,
      "message": "Weaviate response time exceeds threshold"
    }
  }
}

Unhealthy Example

When a dependency is completely unreachable:

{
  "status": "unhealthy",
  "timestamp": "2026-04-03T12:34:56.789Z",
  "version": "0.1.0",
  "service": "inh-public-api-svc",
  "checks": {
    "database": {
      "status": "unhealthy",
      "latency_ms": null,
      "message": "Connection refused: could not connect to PostgreSQL"
    },
    "weaviate": {
      "status": "healthy",
      "latency_ms": 4.8,
      "message": "Weaviate connection OK"
    }
  }
}

---

Liveness Alias

An alias for the liveness check endpoint, provided for convenience with orchestration tools that expect a /health/live path.

GET /health/live

Authentication

None required.

Response

Identical to the liveness check response:

{
  "status": "healthy",
  "service": "inh-public-api-svc"
}