Health check endpoint

Returns the health status of the NSR service, including version information, uptime, and knowledge base statistics…

GET /health

cURL

curl --request GET \
  --url 'https://api.nsr.stateset.com/health' \
  --header "X-API-Key: $STATESET_NSR_API_KEY"

200

{
  "checks": null,
  "circuit_breakers": {},
  "knowledge_base": {
    "entity_count": 1,
    "rule_count": 1,
    "triple_count": 1
  },
  "status": "pending",
  "uptime_seconds": 250,
  "version": "2026-08-01",
  "warnings": [
    "string"
  ]
}

Returns the health status of the NSR service, including version information, uptime, and knowledge base statistics. This endpoint does not require authentication. Example

curl -X GET 'https://api.nsr.stateset.com/health'

Health check endpoint.

Response

HealthResponse

checks · object

circuit_breakers · object

knowledge_base · object

Show knowledge_base

entity_count · integer · required

rule_count · integer · required

triple_count · integer · required

status · string · required

uptime_seconds · integer (int64) · required

version · string · required

warnings · string[]

Status codes

Code	Meaning
200	Service is healthy

cURL

curl --request GET \
  --url 'https://api.nsr.stateset.com/health' \
  --header "X-API-Key: $STATESET_NSR_API_KEY"

200

{
  "checks": null,
  "circuit_breakers": {},
  "knowledge_base": {
    "entity_count": 1,
    "rule_count": 1,
    "triple_count": 1
  },
  "status": "pending",
  "uptime_seconds": 250,
  "version": "2026-08-01",
  "warnings": [
    "string"
  ]
}