Confirms that your API key is valid. It has no side effects, so it’s handy as a health check in
your integration.
Authorization: Bearer hello_live_xxxxxxxxxxxxxxxx
curl $HELLO_API_URL/v1/ping \
-H "Authorization: Bearer $HELLO_API_KEY"
{ "status": "ok", "test_mode": false }
| Field |
Type |
Description |
status |
string |
Always ok |
test_mode |
boolean |
Always false. Kept for compatibility with older clients. |
| Status |
code |
Cause |
401 |
UNAUTHORIZED |
Missing, wrong or disabled API key |
403 |
TEST_MODE_KEY_UNSUPPORTED |
Legacy test-mode key. Create a live key. |
