Skip to content
English
  • There are no suggestions because the search field is empty.

API Call - Ping

Detailed specification and usage guide for the Ping API call

Description: Use this call to check if the endpoint for the system is running

It can also be used to ensure the validity of the API key and secret.

Parameters:

 
Name Description Usage Type Required
Key API Key Provided In Request Body string True
Secret API Secret provided In Request Body string True

 

API Expected Response 

{
   "key": "<api_key>",

   "secret": "<secret>"
}
{

"msg": "SUCCESS: User authenticated. System up. "

}

 

HTTP Expected Responses

Status

Meaning

Description

200

OK

Ping success

400

Bad Request

Unexpected error

401

Unauthorized

User not authorized

500

Internal Server Error

Internal Server Error

Next: Upload Audio for Job

Link to Postman Collection