HEALTH API

Health endpoints are free and do not require payment headers. Use them for liveness checks and rate limit telemetry.

GET /health

Attribute	Value
Method	GET
Description	Returns uptime, memory usage, and version information for the Neura API instance currently serving requests.
Settlements	Free
Price	0 USD

Example request

curl -X GET "$NEURA_BASE_URL/health" -H "Accept: application/json"

Response snapshot

{
  "status": "healthy",
  "timestamp": "2025-01-15T13:10:00.123Z",
  "uptime": 86400.52,
  "memory": {
    "rss": 12345678,
    "heapTotal": 9876543,
    "heapUsed": 7654321,
    "external": 123456
  },
  "version": "1.0.0"
}

GET /health/resilience

Attribute	Value
Method	GET
Description	Provides visibility into current rate limiter consumption across key request buckets.
Settlements	Free
Price	0 USD

Example request

curl -X GET "$NEURA_BASE_URL/health/resilience" -H "Accept: application/json"

Response snapshot

{
  "status": "healthy",
  "timestamp": "2025-01-15T13:10:05.321Z",
  "resilience": {
    "rateLimit_neura:token": {
      "consumedPoints": 42,
      "remainingPoints": 258,
      "msBeforeNext": 1200
    },
    "rateLimit_neura:balances": {
      "consumedPoints": 15,
      "remainingPoints": 285,
      "msBeforeNext": 300
    }
  }
}

Recommended usage

• Monitor /health for general uptime monitoring or load balancer health checks.

• Poll /health/resilience when debugging rate limit issues or to build dashboards showing remaining capacity.

• Combine msBeforeNext values with client side logic to throttle requests proactively.

For field descriptions, see the Data Schemas section.