Settings

Get account summary

One-call account snapshot — quota with projection, request health, per-channel completion rates, HITL counts, and active API keys — for the dashboard home and AI agents. Computed live. The hitl_channels sub-object requires the hitl:read scope (JWT sessions always receive it).

get/api/v1/me/summary

Request

Base URL: https://api.proof.holdings
URL: https://api.proof.holdings/api/v1/me/summary
Auth: one of:
- HTTP bearer
- API key in cookie auth_token

Query parameters

environment'production' | 'test'

Scope request/channel/HITL metrics to test or production data

profile_idstring

Scope request/channel/HITL metrics and key counts to one project (public profile): requests branded with the profile or created by its API keys. Quota stays account-wide (billing is per owner).

Response

Account summary

as_ofstring required

When the snapshot was computed (ISO 8601)

cache_age_secondsnumber required

Always 0 — computed live

channels_with_zero_completionsstring[] required

active_api_keysnumber required

Example response

{
  "as_of": "2026-06-19T12:00:00Z",
  "quota": {
    "plan": "pro",
    "limit": 3000,
    "current_usage": 4213,
    "days_remaining": 11,
    "projected_eom_usage": 6800
  },
  "top_channels": [
    {
      "channel": "whatsapp"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.