Health Checks

Current health checks at a glance

Two services currently expose health endpoints: the NestJS API and the FastAPI AI service. Both implement GET /health, return small JSON payloads, and support direct local verification with curl.

Current endpoints

Use these paths when you verify the services based on the current code and documented local ports:

• NestJS API — GET http://localhost:3001/health
• FastAPI AI service — GET http://localhost:8001/health

Implemented routes in code

@Controller("health")
export class HealthController {
  @Get()
  getHealth() {
    return { status: "ok", service: "api" };
  }
}

@app.get("/health")
def health():
    return {"status": "ok"}

Exact response payloads

These are the current response bodies implemented by code.

NestJS API response

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

FastAPI AI service response

{"status":"ok"}

Verify each endpoint locally

Run each request directly against the local service port. A successful check returns the exact JSON shown in the previous section.

curl http://localhost:3001/health

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

curl http://localhost:8001/health

{"status":"ok"}

README and code currently disagree

The repository README references a different NestJS API path than the one implemented in code.

Current discrepancy

• README documented endpoint — /api/health
• Implemented Nest endpoint — /health

Grounding for the mismatch

| NestJS API      | [http://localhost:3001/api/health](http://localhost:3001/api/health) |

### NestJS

GET /api/health

@Controller("health")
export class HealthController {
  @Get()
  getHealth() {
    return { status: "ok", service: "api" };
  }
}

// main.ts
await app.listen(3001);

What these checks validate

These endpoints currently validate one narrow thing: each service exposes a reachable HTTP route that returns a static success payload.

Service-readiness notes

• NestJS API — confirms that the API process is serving GET /health and returns {"status":"ok","service":"api"}.
• FastAPI AI service — confirms that the AI service process is serving GET /health and returns {"status":"ok"}.
• Neither endpoint currently exposes deeper health semantics beyond that response.

Related foundation pages