API Reference

API Reference

Health

Lightweight connectivity and token-verification checks.

GETRequires a Bearer token/api/ext/v1/ping

Verify your API token

Responses

200Token is valid; echoes the organization it is pinned to.
FieldTypeDescription
org_idrequiredstringThe organization the token is pinned to.
statusrequiredstringAlways "ok" when the token is valid.
200 example
{
  "org_id": "org_9f3k2p",
  "status": "ok"
}

Errors

401Missing or invalid API token
403Token lacks the required scope or credential class
429Rate limit exceeded

All errors return { "error": string }.

Example request

curl https://api.bankofbots.ai/api/ext/v1/ping \
  -H "Authorization: Bearer $BOB_API_TOKEN"
Was this page helpful?