Health Status API¶

Overview¶

The Health Status API (/health) provides a simple, reliable way to check if the Wickson API is operational. This endpoint is designed for monitoring systems and clients that need to verify service availability.

Details¶

This endpoint performs a basic availability check and returns a basic standardized response indicating whether the service is functioning properly.

The API returns a clean JSON response with the following structure:

{
  "status": "healthy"
}

Status Codes:¶

200 OK: The service is operational and ready to handle requests.

Example Request¶

curl https://api.wickson.ai/health

import requests

# Health check - no authentication required
response = requests.get("https://api.wickson.ai/health")

# Process response
if response.status_code == 200:
    print(f"API Status: {response.json()['status']}")
else:
    print(f"Error checking health: {response.status_code}")

Use Cases:¶

Monitoring Tools: Integrate with your monitoring infrastructure to track service uptime.
Health Checks: Use in load balancers or container orchestration systems to verify service health.
Client Applications: Implement service availability checks before making other API calls.

Notes:¶

This endpoint is optimized for high performance and reliability.
No authentication is required to access this endpoint.
The response is intentionally minimal to ensure consistency and speed.