Reference

Health check

A public endpoint for uptime monitors and deployment checks. No API key and no credit needed.

Check API health

GET/api/v1/health

Check that the Job Extract, Match, Skills and Rank service is up. No API key needed.

Authentication: No API key
Billing: Free
Client timeout: Client timeout ≥ 10 s

Response

200The service is up.

statusstring
healthy whenever the service answers.
"healthy""unhealthy"
servicestring
"HireLayer API"
skills_loadedinteger
Number of skills in the loaded catalog.
timestampstring (date-time)
Server time, ISO 8601 UTC.

Errors

502
Upstream API unavailable
The service is down or did not answer within 60 seconds.
Retry with backoff

Behavior

Scope: Covers the service behind /api/v1. It does not check HireLayer CV Extract (/api/v3/parser), and it does not validate API keys.

Request

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

import requests

response = requests.get(
    "https://onlineresumeparser.com/api/v1/health",
    timeout=10,
)
response.raise_for_status()

data = response.json()
print(data["status"])

const response = await fetch('https://onlineresumeparser.com/api/v1/health', {
  signal: AbortSignal.timeout(10_000),
})

if (!response.ok) {
  throw new Error(`HireLayer ${response.status}: ${await response.text()}`)
}

const data = await response.json()
console.log(data.status)

Response

{
  "status": "healthy",
  "service": "HireLayer API",
  "skills_loaded": 664,
  "timestamp": "2026-10-01T09:30:12.417Z"
}

{
  "error": "Upstream API unavailable"
}