{
  "status": "ok",
  "version": "1.0.0",
  "timestamp": "2025-08-01T14:30:45Z",
  "uptime": 1209600
}
Check if the API server is running and get uptime information. This endpoint can be used for monitoring and alerting systems.
GET https://api.worqhat.com/health

Response

status
string
The current health status of the API (e.g., β€œok”, β€œdegraded”, β€œdown”)
version
string
The current version of the API
timestamp
string
The timestamp of when the health check was performed
uptime
integer
The API uptime in seconds

Code Examples

import Worqhat from 'worqhat';

const client = new Worqhat({
  apiKey: process.env.WORQHAT_API_KEY,
});

const response = await client.health.check();
console.log(response.status);
{
  "status": "ok",
  "version": "1.0.0",
  "timestamp": "2025-08-01T14:30:45Z",
  "uptime": 1209600
}