Praison AI

Health Check API

Check the health status of the async jobs server

Check the health status of the async jobs server.

Response

ResponseField string

Server health status. Returns healthy when the server is operational.

cURL
curl http://127.0.0.1:8005/health
Python
import httpx

response = httpx.get("http://127.0.0.1:8005/health")

if response.status_code == 200:
    health = response.json()
    print(f"Server status: {health['status']}")
else:
    print("Server is not responding")
CLI
curl http://127.0.0.1:8005/health
200 OK
{
  "status": "healthy"
}

Usage

Use this endpoint for:

  • Load balancer health checks
  • Kubernetes liveness/readiness probes
  • Monitoring and alerting systems

Kubernetes Example

yaml
apiVersion: v1
kind: Pod
spec:
  containers:
  - name: async-jobs
    image: praisonai/jobs-server
    livenessProbe:
      httpGet:
        path: /health
        port: 8005
      initialDelaySeconds: 10
      periodSeconds: 30
    readinessProbe:
      httpGet:
        path: /health
        port: 8005
      initialDelaySeconds: 5
      periodSeconds: 10

See Also