Healthz

Healthz

curl --request GET \
  --url https://api.private-ai.com/community/healthz \
  --header 'x-api-key: <api-key>'

{
  "success": true,
  "gpu_inference_engine_success": true
}

GET

healthz

Healthz

curl --request GET \
  --url https://api.private-ai.com/community/healthz \
  --header 'x-api-key: <api-key>'

{
  "success": true,
  "gpu_inference_engine_success": true
}

x-api-key

string

header

required

200 - application/json

Successful Response

success

boolean

required

Whether the healthz request succeeded.

gpu_inference_engine_success

boolean

Whether the health check on the GPU inference engine succeeded. Returned on GPU container only.