Organization-level knowledge usage, free trial, retention state and the period's money summary
GET/v1/knowledge_usage
Knowledge-base counts, storage, queries, processing tokens, free trial and retention state for your organization, plus money — the current billing period's knowledge-base amounts as decimal strings — when billing can answer and the caller is a portal admin or owner. Invoices and payment history are on the billing endpoints. This is organization-wide data: an API key limited to a list of knowledge bases (or to none) gets 403 kb_not_in_allowlist.
Access: API key scope knowledge:read or knowledge:write; portal users: any member of the organization; a key limited to a list of knowledge bases (or to none) is refused with 403 kb_not_in_allowlist.
Responses
- 200
- 403
- 503
OK
scope_missing, kb_not_in_allowlist, role_insufficient, actor_not_permitted, tenant_suspended, module_disabled (knowledge bases switched off on the platform: an operation that creates data or starts processing, for an organization that still has knowledge bases), web_sources_disabled, domain_blocked, domain_not_verified (website sources)
maintenance_mode, knowledge_unavailable, retrieval_unavailable, billing_unavailable — Retry-After header set