Core Endpoint

GET /api/v1/status

Validate an API key, confirm its scopes, and read the account's current credit balance.

Usage

Use this endpoint for onboarding checks, backend health checks, and deployment smoke tests. It does not create a request, enqueue work, or spend credits.

curl https://www.cannonstudio.app/api/v1/status \
  -H "x-api-key: $CANNON_API_KEY"

Healthy response

{
  "ok": true,
  "status": "ok",
  "message": "Your API key is properly wired.",
  "creditsRemaining": 1250,
  "credits": {
    "remaining": 1250
  },
  "account": {
    "email": "you@example.com",
    "plan": "trial"
  },
  "apiKey": {
    "name": "Production Key",
    "scopes": [
      "requests:write",
      "requests:read"
    ]
  },
  "serverTime": "2026-05-01T00:00:00.000Z"
}

Errors

`401` means the key is missing, invalid, or revoked.
A successful response updates the key's last-used timestamp.