Health

Get API health status

Changed on

Returns the health status of the API and its dependencies

get/health

Request

  • Base URL
    https://api.roark.ai
  • URL
    https://api.roark.ai/health
  • Auth
    HTTP bearer

Response

Health check response

Example response

{
  "data": {
    "status": "healthy",
    "version": "1.0.0",
    "timestamp": "2026-05-18T09:44:40.971Z"
  }
}

Changes

    • warning

      added the new conflict enum value to the response property for the response status

    • warning

      added the new conflict enum value to the response property for the response status

    • warning

      added the new payment_required enum value to the response property for the response status

    • warning

      added the new payment_required enum value to the response property for the response status

    • info

      added the non-success response with the status