-
Claudio: Getting Started
-
Claudio: Processing Jobs
-
Claudio: Profiles & Workflows
-
Claudio: Mac Users
-
Claudio: Third-Party Integrations
-
Microsoft Word Basics
-
Microsoft Word Templates and Macros
-
Audio Transcription Playback Software
-
Converting Audio to Text
-
Converting Video to Text
-
Computer Configuration
-
Claudio: Reports
-
User Invitations
-
Resource Centre
-
Loom Analytics Academy
-
Claudio Developer Documentation
-
Claudio Product Updates
-
FAQ
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
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
{
"msg": "sys_up..."
}
HTTP Expected Responses
|
Status |
Meaning |
Description |
|
200 |
OK |
Ping success |
|
400 |
Bad Request |
Unexpected error occurred |
|
401 |
Unauthorized |
User not authorized |
|
500 |
Internal Server Error |
Internal Server Error |
Next: Upload Audio for Job