Trustworthy AI service heartbeat API

Use this API to check the running status of the trustworthy AI service.

HTTP method and URI path

GET  /api/heartbeat

Standard headers

Use the following standard HTTP header with this request:

Content-Type: application/json

Expected response

On completion, the service returns an HTTP response, which includes a status code that indicates whether the request is complete. Status code 200 indicates that the trustworthy AI service has started. The successful response body is a JSON object that contains two fields as described in the following table.

Table 1. Response from a successful request
Parameter	Type	Description
version	String	The version string of MLz.
message	String	The value is always “Server has been set up.”

Response example of a successful request:


{
         "version": "3.2.0",    
         "message": "Server has been set up."
}