Skip to main content
Health endpoints let container orchestrators, load balancers, and client applications verify that the SoftArchitect AI backend is running and responsive.

​
GET /

API root endpoint. Returns general information about the running service.

​
Response

{
  "name": "SoftArchitect AI",
  "version": "0.1.0",
  "status": "running",
  "docs": "/docs",
  "api_v1": "/api/v1"
}
​
name
string
Application name. Configurable via the APP_NAME environment variable.
​
version
string
Semantic version string. Configurable via APP_VERSION.
​
status
string
Always "running" when the server is up and accepting requests.
​
docs
string
Path to the interactive Swagger UI documentation.
​
api_v1
string
URL prefix for all v1 API endpoints.

​
Example

curl http://localhost:8000/

{
  "name": "SoftArchitect AI",
  "version": "0.1.0",
  "status": "running",
  "docs": "/docs",
  "api_v1": "/api/v1"
}

​
GET /api/v1/system/health

Lightweight liveness probe. Suitable for frequent polling by Docker HEALTHCHECK, Kubernetes liveness probes, and load balancers.

​
Response

Returns 200 OK on success. 
{
  "status": "OK",
  "message": "SoftArchitect AI backend is running",
  "version": "0.1.0"
}
​
status
string
Health status indicator. Values: "OK", "DEGRADED", "ERROR".
​
message
string
Human-readable health status message.
​
version
string
Application version string.

​
HTTP status codes

CodeMeaning
200 OKService is healthy and running

​
Example

curl http://localhost:8000/api/v1/system/health

{
  "status": "OK",
  "message": "SoftArchitect AI backend is running",
  "version": "0.1.0"
}

​
Docker HEALTHCHECK

HEALTHCHECK --interval=30s --timeout=5s --start-period=10s --retries=3 \
  CMD curl -f http://localhost:8000/api/v1/system/health || exit 1

​
Kubernetes liveness probe

livenessProbe:
  httpGet:
    path: /api/v1/system/health
    port: 8000
  initialDelaySeconds: 10
  periodSeconds: 30
  timeoutSeconds: 5
  failureThreshold: 3

Build docs developers (and LLMs) love

Get started for freeTalk to us