> ## 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.
# Aggregate vault-wide health stats
> Returns per-category counts across the entire vault (Personal / Instance / Account) — not scoped to the current collection or page. Used by the Files panel's Vault Health header to compute the A-F grade and the attention dot. Computed via parallel `$match + $count` pipelines (DocumentDB-safe; no `$facet`).
## OpenAPI
````yaml /mdx/api-reference/runtime/runtime-api.json post /api/user/uploads/vault-health-summary
openapi: 3.0.0
info:
title: Pria Runtime 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: Audio Notes
description: Capture and ingest spoken notes into the personal vault
- name: Memory
description: User-facing memory parameters (personal + shared instance memory).
- name: My Data
description: >-
GDPR controls — personal-scope counts, async ZIP-by-email export, and
scoped soft-delete. Every endpoint pins `user = req.user._id` AND
`institution: null`; institution-scoped data is governed by the
institution's own retention policy and never reached from here.
- name: Questions
description: >-
User-facing read of the onboarding question bank used by the "create a
digital twin" wizard.
- name: Transcription
description: >-
One-shot speech-to-text for in-place dictation. Audio blob in, transcript
out — no Upload / History / RAG embeddings are persisted. Use
`/audio-notes` for anything durable.
paths:
/api/user/uploads/vault-health-summary:
post:
tags:
- IP Vault
summary: Aggregate vault-wide health stats
description: >-
Returns per-category counts across the entire vault (Personal / Instance
/ Account) — not scoped to the current collection or page. Used by the
Files panel's Vault Health header to compute the A-F grade and the
attention dot. Computed via parallel `$match + $count` pipelines
(DocumentDB-safe; no `$facet`).
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- vault
properties:
vault:
type: string
enum:
- personal
- instance
- account
description: Vault scope to summarise
institution:
type: string
description: >-
Optional institution _id, only honored on the `instance`
vault for cross-instance admin views.
responses:
'200':
description: Summary returned
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
summary:
type: object
properties:
totalCount:
type: integer
description: Non-deleted uploads in scope
activeCount:
type: integer
description: status === 'selected' (Included in RAG)
errorCount:
type: integer
description: status === 'error'
neverUsedCount:
type: integer
description: ragHitCount === 0 AND created > 7d ago
staleCount:
type: integer
description: lastRagHitAt older than 90 days
unscannedCount:
type: integer
description: vaultHealthScore not yet computed
unoptimizedCount:
type: integer
description: vaultHealthScore >= 60 (noisy content / code-heavy)
unindexedCount:
type: integer
description: >-
Included but ingestion.counts.total === 0 (needs
reprocess)
missingTerminalCount:
type: integer
description: >-
Source file missing on last access AND no chunks —
unrecoverable, only valid action is Delete
staleBaseUrlCount:
type: integer
description: >-
Absolute file_url whose host doesn't match the current
request origin (env switch)
grade:
type: object
description: >
Composite vault-health grade derived from the summary
counts. Lets API
consumers (UI, dashboards) display a single A–F letter +
0–100 score
without re-implementing the rules client-side.
Severity weights per category (penalty per 100% of total):
- Critical (50pts): errorCount, unindexedCount, missingTerminalCount
- Degraded (25pts): unoptimizedCount, staleBaseUrlCount
- Stale (10pts): neverUsedCount, staleCount
- Unknown (5pts): unscannedCount
`score = 100 − Σ (weight × count / totalCount)`, clamped
to ≥0.
Letter: 90+ A, 80+ B, 70+ C, 60+ D, else F. Empty vault
returns
`{ letter: 'N/A', score: null, factors: [] }`.
properties:
letter:
type: string
enum:
- A
- B
- C
- D
- F
- N/A
example: B
score:
type: number
nullable: true
description: 0–100 (1-decimal), or null for empty vault
example: 84.6
factors:
type: array
description: >-
Non-zero contributors, sorted by impact desc. UI can
render 'Why B+: ...' breakdown.
items:
type: object
properties:
key:
type: string
example: unindexedCount
count:
type: integer
example: 12
impact:
type: number
description: Points deducted from 100 (1-decimal)
example: 5.4
label:
type: string
example: Included but no segments indexed
'400':
description: Bad request — missing or invalid vault parameter
'401':
description: Unauthorized
security:
- apiKeyAuth: []
components:
securitySchemes:
apiKeyAuth:
type: apiKey
in: header
name: x-access-token
description: JWT token passed in x-access-token header
````