> ## Documentation Index
> Fetch the complete documentation index at: https://docs.praxis-ai.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Usage-vs-cap reporting (per-user) or account-wide at-limit counts.
> Two modes selected by query parameters:
- `userId` + `institutionId` (or `instanceId` alias): one user's
usage-vs-cap gauges plus over-time `{buckets, totals}` (same shape as
the user usage chart).
- `accountId`: account-wide counts of users/memberships at or over a cap.
## OpenAPI
````yaml /mdx/api-reference/admin/admin-api.json get /api/admin/usage-limits
openapi: 3.0.0
info:
title: Pria Admin API
version: 2.0.1
description: >-
Pria API Documentation Praxis's developer platform is a core part of our
mission to empower organizations to grow better. Our APIs are designed to
enable teams of any shape or size to build robust integrations that help
them customize and get the most value out of Pria. All Pria APIs are built
using REST conventions and designed to have a predictable URL structure.
They use many standard HTTP features, including methods (POST,
GET, PUT, DELETE) and error response codes.
All API calls are
made under https://hiimpria.ai/api and all responses return standard JSON.
In these docs, you'll find lists of all available endpoints for a given API,
along with interactive code blocks for building requests. For walkthroughs
of basic usage for these APIs, check out the API guides.
servers:
- url: https://pria.praxislxp.com
description: Pria API Server
security: []
tags:
- name: Authentication
description: User authentication, registration, and password management (/api/auth)
- name: OAuth
description: OAuth authentication providers - Google, GitHub, SSO (/api/auth/oauth)
- name: User
description: User profile management and account operations (/api/user)
- name: User Institutions
description: User institution memberships and switching (/api/user/institution)
- name: User Tools
description: Available tools for authenticated users (/api/user/tools)
- name: Institutions
description: Institution settings and configuration (/api/user/institution)
- name: Conversation
description: AI conversation and Q&A endpoints (/api/ai)
- name: Realtime
description: Real-time voice AI and WebRTC sessions (/api/ai/rt)
- name: Assistant
description: AI assistant configuration and management (/api/user/assistant)
- name: History
description: Conversation history and favorites (/api/user/history)
- name: RAG
description: >-
Document upload, embedding, and retrieval-augmented generation
(/api/user/files, /api/user/rag)
- name: Setting
description: Instance variables and settings management (/api/user/setting)
- name: Branding
description: Digital twin branding and customization (/api/agent/branding)
- name: Agent
description: Agent engagement and session management (/api/agent)
- name: SDK Launch
description: >-
SDK launch token signing and verification for secure iframe embedding
(/api/auth/sdk-sign, /api/auth/sdk-verify)
- name: Testing
description: Health checks, diagnostics, and test endpoints (/api/test)
- name: Admin Accounts
description: Account management for super admins (/api/admin/account)
- name: Admin Institutions
description: Institution management for admins (/api/admin/institution)
- name: Admin Users
description: User management for admins (/api/admin/user)
- name: Admin Entitlements
description: >-
User-institution relationships and permissions
(/api/admin/userInstitution)
- name: Admin Sessions
description: Session management for admins (/api/admin/session)
- name: Admin Histories
description: Conversation history management and analytics (/api/admin/history)
- name: Admin Assistants
description: AI assistant management for admins (/api/admin/assistant)
- name: Admin Questions
description: Institution question and prompt management (/api/admin/question)
- name: Admin Tools
description: Tool configuration management (/api/admin/tool)
- name: Admin AI Models
description: AI model configuration (/api/admin/aimodel)
- name: Admin MCP Servers
description: Model Context Protocol server management (/api/admin/mcpserver)
- name: Admin Feedbacks
description: User feedback management (/api/admin/feedback)
- name: Admin Uploads
description: Upload management (/api/admin/upload)
- name: Admin Charts
description: Analytics and visualization chart management (/api/admin/chart)
- name: Admin Memory
description: Admin inspection and editing of user/instance memory parameters.
- name: Admin Usage Limits
description: Per-user usage-vs-cap reporting and account-wide at-limit counts.
paths:
/api/admin/usage-limits:
get:
tags:
- Admin Usage Limits
summary: Usage-vs-cap reporting (per-user) or account-wide at-limit counts.
description: >
Two modes selected by query parameters:
- `userId` + `institutionId` (or `instanceId` alias): one user's
usage-vs-cap gauges plus over-time `{buckets, totals}` (same shape as
the user usage chart).
- `accountId`: account-wide counts of users/memberships at or over a
cap.
parameters:
- in: query
name: userId
schema:
type: string
description: Target user id (per-user mode; requires institutionId/instanceId).
- in: query
name: institutionId
schema:
type: string
description: Institution id for the per-user mode.
- in: query
name: instanceId
schema:
type: string
description: Alias for institutionId (forwarded by the usage chart).
- in: query
name: window
schema:
type: integer
default: 30
description: Over-time window in days (per-user mode).
- in: query
name: accountId
schema:
type: string
description: Account id (account-wide at-limit mode).
responses:
'200':
description: Usage-vs-cap or at-limit summary.
content:
application/json:
schema:
oneOf:
- type: object
description: Per-user mode response.
properties:
success:
type: boolean
capsEnabled:
type: boolean
accountWide:
type: object
properties:
used:
type: number
cap:
type: number
nullable: true
over:
type: boolean
perInstitution:
type: object
properties:
used:
type: number
cap:
type: number
nullable: true
over:
type: boolean
h24:
type: object
properties:
used:
type: number
cap:
type: number
nullable: true
over:
type: boolean
buckets:
type: array
items:
type: object
properties:
start:
type: string
credits:
type: number
messages:
type: number
totals:
type: object
properties:
credits:
type: number
messages:
type: number
- type: object
description: Account-wide at-limit mode response.
properties:
success:
type: boolean
capsEnabled:
type: boolean
atLimit:
type: object
properties:
accountWide:
type: integer
perInstitution:
type: integer
userCount:
type: integer
'400':
description: Missing required query parameters.
'500':
description: Server error.
security:
- bearerAuth: []
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: JWT token passed in authorization header
````