– Get status

The GET /_status endpoint returns information about the status of the API.

Parameters

Path parameters

(none)

Query string parameter

(none)

Responses

A response to a valid GET /_status request contains information about the state of the system

Successful responses

Successful requests return a 200 Success code.

Example v1 response

{
"serviceName": "Transcription Service",
"healthy": true
}

A status response contains the following parameters:

  • serviceName. The name of the service. serviceName will always be Transcription Service.
  • healthy. The status of the service. healthy can be true or false, where true indicates that the API is available.