Health Check

Verify that the Clipzy ML Engine service is running and ready to accept requests.

GET /api/v1/health

Returns the current health status of the service. Use this endpoint for uptime monitoring, load balancer health probes, and readiness checks.

No authentication or request parameters are required.

Configure your load balancer or orchestration platform (e.g., Kubernetes) to poll this endpoint periodically to detect service outages automatically.

Example request

curl --request GET \
  --url http://{host}/api/v1/health

Response fields

success · boolean · required

true when the service is healthy.

message · string · required

A human-readable status message (e.g., "Service is healthy").

data · object · required

Show properties

status · string · required

Service status string. "healthy" indicates the service is ready to process requests.

Example response

{
  "success": true,
  "message": "Service is healthy",
  "data": {
    "status": "healthy"
  }
}