Documentation

If OpenClaw includes a cost.total field inside usage data, BurnGuard uses that value directly. The value is converted from dollars to cents. This works for any model, even those not in our pricing table.

For models in our pricing table, BurnGuard calculates costs using cache-aware rates when the pre-calculated cost is unavailable.

If neither a pre-calculated cost nor a matching model price is found, tokens and sessions are still tracked but cost shows as $0.00.

Returns Google OAuth consent URL. Pass redirect_uri as query parameter.

Exchange Google authorization code for BurnGuard API key. Creates or links user account.

{
  "code": "google_auth_code",
  "redirect_uri": "https://burnguard.dev/login/callback"
}

Get authenticated user info.

{
  "success": true,
  "data": {
    "id": "usr_abc123",
    "email": "user@example.com",
    "tier": "free",
    "created_at": "2026-01-15T10:30:00Z"
  }
}

Batch ingest an array of metrics. Used by the BurnGuard agent to stream data.

[
  {
    "session_id": "sess_abc123",
    "model": "claude-sonnet-4",
    "input_tokens": 1200,
    "output_tokens": 350,
    "cost_cents": 5,
    "timestamp": 1707840000
  }
]

Query metrics filtered by time range. Returns individual metric entries.

Aggregated daily totals and a by_model breakdown of tokens and cost.

Daily aggregated metrics including day, session count, total tokens, and cost.

List user sessions. Returns the 50 most recent sessions ordered by started_at descending.

Get current budget settings for the authenticated user.

Update budget settings.

{
  "daily_limit_cents": 1000,
  "monthly_limit_cents": 10000
}

WebSocket upgrade endpoint for real-time metric streaming. Authentication is provided via the api_key query parameter instead of the X-API-Key header.

Uses query parameter authentication instead of the header.