System
Health Check
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
statusstringrequired
The current health status of the API (e.g., "ok", "degraded", "down")
versionstringrequired
The current version of the API
timestampstringrequired
The timestamp of when the health check was performed
uptimeintegerrequired
The API uptime in seconds
Code Examples
health-check.js
import Worqhat from 'worqhat';const client = new Worqhat({apiKey: process.env.WORQHAT_API_KEY,});const response = await client.health.check();console.log(response.status);response.json
{"status": "ok","version": "1.0.0","timestamp": "2025-08-01T14:30:45Z","uptime": 1209600}