Ping

Use ping requests to check if the API is up and running. This serves as a simple health check to confirm that the API is operational.

ENDPOINTS

GET /v1/ping

get

It serves as a simple health check to confirm that the API is operational.

Responses

200

The API is operational.

application/json

codestringOptionalExample: SERVER_PONG

messagestringOptionalExample: pong!

get

/v1/ping

HTTPcURLJavaScriptPython

GET /v1/ping HTTP/1.1
Host: api.voxity.ai
Accept: */*

200

The API is operational.

{
  "code": "SERVER_PONG",
  "message": "pong!"
}