API reference
Verify that an API key is valid without side effects.
https://api.betterpost.dev/v1/health/authReturns { "ok": true } when the x-access-key is valid and not revoked. Useful as a first call and in your own
health checks.
| Header | Required | Description |
|---|---|---|
x-access-key | Yes | Your API key (sk_test_...). |
curl -s https://api.betterpost.dev/v1/health/auth \
-H "x-access-key: $BETTERPOST_API_KEY"200 OK
{ "ok": true }| Status | Code | When |
|---|---|---|
200 | The key is valid. | |
401 | unauthorized | The header is missing or the key is unknown. |
403 | key_revoked | The key was revoked. |
429 | rate_limited | More than 120 requests per minute. |