UTILITY / STATUS

API Health

Use the public health endpoint to check that the API is available and that the skill catalog is loaded.

Endpoint

1

Auth

Not required

Response

JSON

Reference

Endpoints

1 endpoint
01

Endpoint

Check API health

Check API availability without an API key.

GET/api/v1/health

Request

Content-Typeapplication/json

No body parameters.

Errors

Example request

Request example
curl https://onlineresumeparser.com/api/v1/health

Response

The endpoint is intentionally public so it can be used by uptime monitors and deployment checks. status is healthy or unhealthy, skills_loaded is the number of skills loaded at startup, and timestamp is an ISO 8601 UTC string. The endpoint responds with HTTP 200 and exposes readiness through status; the process exits if startup initialization fails.

{
  "status": "healthy",
  "service": "HireLayer API",
  "skills_loaded": 664,
  "timestamp": "2026-09-07T13:05:47.172Z"
}

Allowed values in response

status
healthyunhealthy

The catalog readiness state reported by the initialized service.