Guides
Utilities
Verify API health and basic connectivity before deeper integration work
Utilities Guide
Use the utility endpoints for quick service health checks and lightweight connectivity validation.
Primary Workflow
- Call
GET /utils/healthto verify the API is healthy. - Call
GET /utils/pingfor a simple connectivity check. - Run these checks before exercising authenticated or workflow-heavy endpoint families.
Related OpenAPI Operations
Check API health
Use this endpoint to confirm the API is available before running authenticated or workflow-heavy requests.
GET
/utils/healthAuthorizationv
No authorization required.
Pathv
Endpoint
/utils/healthOperation ID
util.healthBodyv
{
"response": {
"ok": true,
"status": "healthy"
}
}Ping the API
Use this endpoint for a lightweight connectivity check from your integration environment.
GET
/utils/pingAuthorizationv
No authorization required.
Pathv
Endpoint
/utils/pingOperation ID
util.pingBodyv
{
"response": {
"ok": true,
"message": "pong"
}
}