Usage

Get API usage

Returns current month's API usage and allowance terms. By default, organization callers see org usage: an API key or JWT owner/admin sees every active org key; a JWT member sees the org total and assigned keys. A JWT caller may use context=personal to see their own retained personal usage even after joining an organization. Personal API keys always see their owner's personal usage; organization API keys cannot request personal context. For orgs, capped plans refuse requests above the included amount and metered plans accrue $0.002 overage per query. overage_reported_to_stripe confirms a meter receipt, not an invoice charge.

get/usage

Request

  • Base URL: https://app.arkova.ai/api/v1
  • URL: https://app.arkova.ai/api/v1/usage
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key
    • HTTP bearer

Query parameters

context'personal'

For Supabase JWT callers, select owner-scoped personal usage instead of default organization usage.

Headers

X-Org-Idstring uuid

Exact selected organization. Requires current membership there; never falls back to the profile organization. Cannot be combined with context=personal.

Response

Usage statistics

usedinteger required
reset_datestring date-time required
monthstring required
viewer'admin' | 'member'

Signed-in callers only.

Example response

{
  "allowance": {
    "included_monthly_queries": 1000,
    "overage_unit_price_usd": 0.002
  }
}

Changes

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